| 1 | /* $Id: UICloudNetworkingStuff.h 86695 2020-10-23 17:28:55Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VBox Qt GUI - UICloudNetworkingStuff namespace declaration.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2020 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | #ifndef FEQT_INCLUDED_SRC_globals_UICloudNetworkingStuff_h
|
|---|
| 19 | #define FEQT_INCLUDED_SRC_globals_UICloudNetworkingStuff_h
|
|---|
| 20 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 21 | # pragma once
|
|---|
| 22 | #endif
|
|---|
| 23 |
|
|---|
| 24 | /* GUI includes: */
|
|---|
| 25 | #include "UILibraryDefs.h"
|
|---|
| 26 |
|
|---|
| 27 | /* COM includes: */
|
|---|
| 28 | #include "COMEnums.h"
|
|---|
| 29 | #include "CCloudClient.h"
|
|---|
| 30 | #include "CCloudMachine.h"
|
|---|
| 31 | #include "CCloudProfile.h"
|
|---|
| 32 | #include "CCloudProvider.h"
|
|---|
| 33 | #include "CCloudProviderManager.h"
|
|---|
| 34 | #include "CForm.h"
|
|---|
| 35 |
|
|---|
| 36 | /** Cloud networking stuff namespace. */
|
|---|
| 37 | namespace UICloudNetworkingStuff
|
|---|
| 38 | {
|
|---|
| 39 | /** Acquires cloud provider manager,
|
|---|
| 40 | * using @a pParent to show messages according to. */
|
|---|
| 41 | SHARED_LIBRARY_STUFF CCloudProviderManager cloudProviderManager(QWidget *pParent = 0);
|
|---|
| 42 | /** Acquires cloud provider manager,
|
|---|
| 43 | * using @a strErrorMessage to store messages to. */
|
|---|
| 44 | SHARED_LIBRARY_STUFF CCloudProviderManager cloudProviderManager(QString &strErrorMessage);
|
|---|
| 45 | /** Acquires cloud provider specified by @a strProviderShortName,
|
|---|
| 46 | * using @a pParent to show messages according to. */
|
|---|
| 47 | SHARED_LIBRARY_STUFF CCloudProvider cloudProviderByShortName(const QString &strProviderShortName,
|
|---|
| 48 | QWidget *pParent = 0);
|
|---|
| 49 | /** Acquires cloud provider specified by @a strProviderShortName,
|
|---|
| 50 | * using @a strErrorMessage to store messages to. */
|
|---|
| 51 | SHARED_LIBRARY_STUFF CCloudProvider cloudProviderByShortName(const QString &strProviderShortName,
|
|---|
| 52 | QString &strErrorMessage);
|
|---|
| 53 | /** Acquires cloud profile specified by @a strProviderShortName and @a strProfileName,
|
|---|
| 54 | * using @a pParent to show messages according to. */
|
|---|
| 55 | SHARED_LIBRARY_STUFF CCloudProfile cloudProfileByName(const QString &strProviderShortName,
|
|---|
| 56 | const QString &strProfileName,
|
|---|
| 57 | QWidget *pParent = 0);
|
|---|
| 58 | /** Acquires cloud profile specified by @a strProviderShortName and @a strProfileName,
|
|---|
| 59 | * using @a strErrorMessage to store messages to. */
|
|---|
| 60 | SHARED_LIBRARY_STUFF CCloudProfile cloudProfileByName(const QString &strProviderShortName,
|
|---|
| 61 | const QString &strProfileName,
|
|---|
| 62 | QString &strErrorMessage);
|
|---|
| 63 | /** Acquires cloud client specified by @a strProviderShortName and @a strProfileName,
|
|---|
| 64 | * using @a pParent to show messages according to. */
|
|---|
| 65 | SHARED_LIBRARY_STUFF CCloudClient cloudClientByName(const QString &strProviderShortName,
|
|---|
| 66 | const QString &strProfileName,
|
|---|
| 67 | QWidget *pParent = 0);
|
|---|
| 68 | /** Acquires cloud client specified by @a strProviderShortName and @a strProfileName,
|
|---|
| 69 | * using @a strErrorMessage to store messages to. */
|
|---|
| 70 | SHARED_LIBRARY_STUFF CCloudClient cloudClientByName(const QString &strProviderShortName,
|
|---|
| 71 | const QString &strProfileName,
|
|---|
| 72 | QString &strErrorMessage);
|
|---|
| 73 | /** Acquires cloud machine specified by @a strProviderShortName, @a strProfileName and @a uMachineId,
|
|---|
| 74 | * using @a pParent to show messages according to. */
|
|---|
| 75 | SHARED_LIBRARY_STUFF CCloudMachine cloudMachineById(const QString &strProviderShortName,
|
|---|
| 76 | const QString &strProfileName,
|
|---|
| 77 | const QUuid &uMachineId,
|
|---|
| 78 | QWidget *pParent = 0);
|
|---|
| 79 | /** Acquires cloud machine specified by @a strProviderShortName, @a strProfileName and @a uMachineId,
|
|---|
| 80 | * using @a strErrorMessage to store messages to. */
|
|---|
| 81 | SHARED_LIBRARY_STUFF CCloudMachine cloudMachineById(const QString &strProviderShortName,
|
|---|
| 82 | const QString &strProfileName,
|
|---|
| 83 | const QUuid &uMachineId,
|
|---|
| 84 | QString &strErrorMessage);
|
|---|
| 85 |
|
|---|
| 86 | /** Acquires cloud providers, using @a pParent to show messages according to. */
|
|---|
| 87 | SHARED_LIBRARY_STUFF QVector<CCloudProvider> listCloudProviders(QWidget *pParent = 0);
|
|---|
| 88 | /** Acquires cloud providers, using @a strErrorMessage to store messages to. */
|
|---|
| 89 | SHARED_LIBRARY_STUFF QVector<CCloudProvider> listCloudProviders(QString &strErrorMessage);
|
|---|
| 90 |
|
|---|
| 91 | /** Acquires @a comCloudProvider ID as a @a uResult, using @a pParent to show messages according to. */
|
|---|
| 92 | SHARED_LIBRARY_STUFF bool cloudProviderId(const CCloudProvider &comCloudProvider,
|
|---|
| 93 | QUuid &uResult,
|
|---|
| 94 | QWidget *pParent = 0);
|
|---|
| 95 | /** Acquires @a comCloudProvider short name as a @a strResult, using @a pParent to show messages according to. */
|
|---|
| 96 | SHARED_LIBRARY_STUFF bool cloudProviderShortName(const CCloudProvider &comCloudProvider,
|
|---|
| 97 | QString &strResult,
|
|---|
| 98 | QWidget *pParent = 0);
|
|---|
| 99 | /** Acquires @a comCloudProvider name as a @a strResult, using @a pParent to show messages according to. */
|
|---|
| 100 | SHARED_LIBRARY_STUFF bool cloudProviderName(const CCloudProvider &comCloudProvider,
|
|---|
| 101 | QString &strResult,
|
|---|
| 102 | QWidget *pParent = 0);
|
|---|
| 103 |
|
|---|
| 104 | /** Acquires cloud profiles of certain @a comCloudProvider, using @a pParent to show messages according to. */
|
|---|
| 105 | SHARED_LIBRARY_STUFF QVector<CCloudProfile> listCloudProfiles(CCloudProvider comCloudProvider,
|
|---|
| 106 | QWidget *pParent = 0);
|
|---|
| 107 | /** Acquires cloud profiles of certain @a comCloudProvider, using @a strErrorMessage to store messages to. */
|
|---|
| 108 | SHARED_LIBRARY_STUFF QVector<CCloudProfile> listCloudProfiles(CCloudProvider comCloudProvider,
|
|---|
| 109 | QString &strErrorMessage);
|
|---|
| 110 |
|
|---|
| 111 | /** Acquires @a comCloudProfile name as a @a strResult, using @a pParent to show messages according to. */
|
|---|
| 112 | SHARED_LIBRARY_STUFF bool cloudProfileName(const CCloudProfile &comCloudProfile,
|
|---|
| 113 | QString &strResult,
|
|---|
| 114 | QWidget *pParent = 0);
|
|---|
| 115 | /** Acquires @a comCloudProfile properties as a @a keys/values using @a pParent to show messages according to. */
|
|---|
| 116 | SHARED_LIBRARY_STUFF bool cloudProfileProperties(const CCloudProfile &comCloudProfile,
|
|---|
| 117 | QVector<QString> &keys,
|
|---|
| 118 | QVector<QString> &values,
|
|---|
| 119 | QWidget *pParent = 0);
|
|---|
| 120 |
|
|---|
| 121 | /** Acquires cloud machines of certain @a comCloudClient, using @a pParent to show messages according to. */
|
|---|
| 122 | SHARED_LIBRARY_STUFF QVector<CCloudMachine> listCloudMachines(CCloudClient comCloudClient,
|
|---|
| 123 | QWidget *pParent = 0);
|
|---|
| 124 | /** Acquires cloud machines of certain @a comCloudClient, using @a strErrorMessage to store messages to. */
|
|---|
| 125 | SHARED_LIBRARY_STUFF QVector<CCloudMachine> listCloudMachines(CCloudClient comCloudClient,
|
|---|
| 126 | QString &strErrorMessage);
|
|---|
| 127 | /** Acquires cloud machine stubs of certain @a comCloudClient, using @a pParent to show messages according to. */
|
|---|
| 128 | SHARED_LIBRARY_STUFF QVector<CCloudMachine> listCloudMachineStubs(CCloudClient comCloudClient,
|
|---|
| 129 | QWidget *pParent = 0);
|
|---|
| 130 | /** Acquires cloud machine stubs of certain @a comCloudClient, using @a strErrorMessage to store messages to. */
|
|---|
| 131 | SHARED_LIBRARY_STUFF QVector<CCloudMachine> listCloudMachineStubs(CCloudClient comCloudClient,
|
|---|
| 132 | QString &strErrorMessage);
|
|---|
| 133 |
|
|---|
| 134 | /** Acquires @a comCloudMachine ID as a @a uResult, using @a pParent to show messages according to. */
|
|---|
| 135 | SHARED_LIBRARY_STUFF bool cloudMachineId(const CCloudMachine &comCloudMachine,
|
|---|
| 136 | QUuid &uResult,
|
|---|
| 137 | QWidget *pParent = 0);
|
|---|
| 138 | /** Acquires @a comCloudMachine accessible state as a @a fResult, using @a pParent to show messages according to. */
|
|---|
| 139 | SHARED_LIBRARY_STUFF bool cloudMachineAccessible(const CCloudMachine &comCloudMachine,
|
|---|
| 140 | bool &fResult,
|
|---|
| 141 | QWidget *pParent = 0);
|
|---|
| 142 | /** Acquires @a comCloudMachine accessible error as a @a comResult, using @a pParent to show messages according to. */
|
|---|
| 143 | SHARED_LIBRARY_STUFF bool cloudMachineAccessError(const CCloudMachine &comCloudMachine,
|
|---|
| 144 | CVirtualBoxErrorInfo &comResult,
|
|---|
| 145 | QWidget *pParent = 0);
|
|---|
| 146 | /** Acquires @a comCloudMachine name as a @a strResult, using @a pParent to show messages according to. */
|
|---|
| 147 | SHARED_LIBRARY_STUFF bool cloudMachineName(const CCloudMachine &comCloudMachine,
|
|---|
| 148 | QString &strResult,
|
|---|
| 149 | QWidget *pParent = 0);
|
|---|
| 150 | /** Acquires @a comCloudMachine OS type ID as a @a strResult, using @a pParent to show messages according to. */
|
|---|
| 151 | SHARED_LIBRARY_STUFF bool cloudMachineOSTypeId(const CCloudMachine &comCloudMachine,
|
|---|
| 152 | QString &strResult,
|
|---|
| 153 | QWidget *pParent = 0);
|
|---|
| 154 | /** Acquires @a comCloudMachine state as a @a enmResult, using @a pParent to show messages according to. */
|
|---|
| 155 | SHARED_LIBRARY_STUFF bool cloudMachineState(const CCloudMachine &comCloudMachine,
|
|---|
| 156 | KCloudMachineState &enmResult,
|
|---|
| 157 | QWidget *pParent = 0);
|
|---|
| 158 | /** Acquires @a comCloudMachine console connection fingerprint as a @a strResult,
|
|---|
| 159 | * using @a pParent to show messages according to. */
|
|---|
| 160 | SHARED_LIBRARY_STUFF bool cloudMachineConsoleConnectionFingerprint(const CCloudMachine &comCloudMachine,
|
|---|
| 161 | QString &strResult,
|
|---|
| 162 | QWidget *pParent = 0);
|
|---|
| 163 |
|
|---|
| 164 | /** Acquires @a comCloudMachine settings form as a @a comResult, using @a pParent to show messages according to.
|
|---|
| 165 | * @note Be aware, this is a blocking function, corresponding progress dialog will be executed. */
|
|---|
| 166 | SHARED_LIBRARY_STUFF bool cloudMachineSettingsForm(CCloudMachine comCloudMachine,
|
|---|
| 167 | CForm &comResult,
|
|---|
| 168 | QWidget *pParent = 0);
|
|---|
| 169 | /** Acquires @a comCloudMachine settings form as a @a comResult, using @a strErrorMessage to store messages to.
|
|---|
| 170 | * @note Be aware, this is a blocking function, it will hang for a time of progress being executed. */
|
|---|
| 171 | SHARED_LIBRARY_STUFF bool cloudMachineSettingsForm(CCloudMachine comCloudMachine,
|
|---|
| 172 | CForm &comResult,
|
|---|
| 173 | QString &strErrorMessage);
|
|---|
| 174 |
|
|---|
| 175 | /** Applies @a comCloudMachine @a comForm settings, using @a pParent to show messages according to.
|
|---|
| 176 | * @note Be aware, this is a blocking function, corresponding progress dialog will be executed. */
|
|---|
| 177 | SHARED_LIBRARY_STUFF bool applyCloudMachineSettingsForm(CCloudMachine comCloudMachine,
|
|---|
| 178 | CForm comForm,
|
|---|
| 179 | QWidget *pParent = 0);
|
|---|
| 180 |
|
|---|
| 181 | /** Acquires instance map.
|
|---|
| 182 | * @param comCloudClient Brings cloud client object.
|
|---|
| 183 | * @param strErrorMessage Brings error message container.
|
|---|
| 184 | * @param pWidget Brings parent widget to show messages according to,
|
|---|
| 185 | * if no parent set, progress will be executed in blocking way. */
|
|---|
| 186 | SHARED_LIBRARY_STUFF QMap<QString, QString> listInstances(const CCloudClient &comCloudClient,
|
|---|
| 187 | QString &strErrorMessage,
|
|---|
| 188 | QWidget *pParent = 0);
|
|---|
| 189 | /** Acquires instance info as a map.
|
|---|
| 190 | * @param comCloudClient Brings cloud client object.
|
|---|
| 191 | * @param strId Brings cloud instance id.
|
|---|
| 192 | * @param strErrorMessage Brings error message container.
|
|---|
| 193 | * @param pWidget Brings parent widget to show messages according to,
|
|---|
| 194 | * if no parent set, progress will be executed in blocking way. */
|
|---|
| 195 | SHARED_LIBRARY_STUFF QMap<KVirtualSystemDescriptionType, QString> getInstanceInfo(const CCloudClient &comCloudClient,
|
|---|
| 196 | const QString &strId,
|
|---|
| 197 | QString &strErrorMessage,
|
|---|
| 198 | QWidget *pParent = 0);
|
|---|
| 199 | /** Acquires instance info of certain @a enmType as a string.
|
|---|
| 200 | * @param comCloudClient Brings cloud client object.
|
|---|
| 201 | * @param strId Brings cloud instance id.
|
|---|
| 202 | * @param strErrorMessage Brings error message container.
|
|---|
| 203 | * @param pWidget Brings parent widget to show messages according to,
|
|---|
| 204 | * if no parent set, progress will be executed in blocking way. */
|
|---|
| 205 | SHARED_LIBRARY_STUFF QString getInstanceInfo(KVirtualSystemDescriptionType enmType,
|
|---|
| 206 | const CCloudClient &comCloudClient,
|
|---|
| 207 | const QString &strId,
|
|---|
| 208 | QString &strErrorMessage,
|
|---|
| 209 | QWidget *pParent = 0);
|
|---|
| 210 | /** Acquires image info as a map.
|
|---|
| 211 | * @param comCloudClient Brings cloud client object.
|
|---|
| 212 | * @param strId Brings cloud image id.
|
|---|
| 213 | * @param strErrorMessage Brings error message container.
|
|---|
| 214 | * @param pWidget Brings parent widget to show messages according to,
|
|---|
| 215 | * if no parent set, progress will be executed in blocking way. */
|
|---|
| 216 | SHARED_LIBRARY_STUFF QMap<QString, QString> getImageInfo(const CCloudClient &comCloudClient,
|
|---|
| 217 | const QString &strId,
|
|---|
| 218 | QString &strErrorMessage,
|
|---|
| 219 | QWidget *pParent = 0);
|
|---|
| 220 | }
|
|---|
| 221 |
|
|---|
| 222 | /* Using across any module who included us: */
|
|---|
| 223 | using namespace UICloudNetworkingStuff;
|
|---|
| 224 |
|
|---|
| 225 | #endif /* !FEQT_INCLUDED_SRC_globals_UICloudNetworkingStuff_h */
|
|---|
