VirtualBox

source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataManager.h@ 51549

Last change on this file since 51549 was 51549, checked in by vboxsync, 11 years ago

FE/Qt: 6660: Advanced extra-data management framework: Integrate GUI_LastNormalWindowPosition, GUI_LastScaleWindowPosition, GUI_LastWindowState_Max.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.9 KB
Line 
1/** @file
2 * VBox Qt GUI - UIExtraDataManager class declaration.
3 */
4
5/*
6 * Copyright (C) 2010-2014 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___UIExtraDataManager_h___
18#define ___UIExtraDataManager_h___
19
20/* Qt includes: */
21#include <QObject>
22#include <QMap>
23
24/* GUI includes: */
25#include "UIExtraDataDefs.h"
26
27/* COM includes: */
28#include "CEventListener.h"
29
30/* Forward declarations: */
31class UIExtraDataEventHandler;
32
33/* Type definitions: */
34typedef QMap<QString, QString> ExtraDataMap;
35
36/** Singleton QObject extension
37 * providing GUI with corresponding extra-data values,
38 * and notifying it whenever any of those values changed. */
39class UIExtraDataManager : public QObject
40{
41 Q_OBJECT;
42
43 /** Extra-data Manager constructor. */
44 UIExtraDataManager();
45 /** Extra-data Manager destructor. */
46 ~UIExtraDataManager();
47
48signals:
49
50 /** Notifies about GUI language change. */
51 void sigLanguageChange(QString strLanguage);
52
53 /** Notifies about Selector UI keyboard shortcut change. */
54 void sigSelectorUIShortcutChange();
55 /** Notifies about Runtime UI keyboard shortcut change. */
56 void sigRuntimeUIShortcutChange();
57
58 /** Notifies about HID LED sync state change. */
59 void sigHIDLedsSyncStateChange(bool fEnabled);
60
61#ifdef RT_OS_DARWIN
62 /** Mac OS X: Notifies about 'presentation mode' status change. */
63 void sigPresentationModeChange(bool fEnabled);
64 /** Mac OS X: Notifies about 'dock icon' appearance change. */
65 void sigDockIconAppearanceChange(bool fEnabled);
66#endif /* RT_OS_DARWIN */
67
68public:
69
70 /** Static Extra-data Manager instance/constructor. */
71 static UIExtraDataManager* instance();
72 /** Static Extra-data Manager destructor. */
73 static void destroy();
74
75 /** Returns version for which user wants to prevent BETA warning. */
76 QString preventBETAwarningForVersion() const;
77
78#ifdef VBOX_GUI_WITH_NETWORK_MANAGER
79 /** Returns whether we should allow Application Update. */
80 bool shouldWeAllowApplicationUpdate() const;
81 /** Returns last Application Update date. */
82 QString applicationUpdateData() const;
83 /** Defines last Application Update date as @a strValue. */
84 void setApplicationUpdateData(const QString &strValue);
85 /** Returns Application Update check counter. */
86 qulonglong applicationUpdateCheckCounter() const;
87 /** Increments Application Update check counter. */
88 void incrementApplicationUpdateCheckCounter();
89#endif /* VBOX_GUI_WITH_NETWORK_MANAGER */
90
91 /** Returns shortcut overrides for shortcut-pool with @a strPoolExtraDataID. */
92 QStringList shortcutOverrides(const QString &strPoolExtraDataID) const;
93
94 /** Returns recent hard-drive folder. */
95 QString recentFolderForHardDrives() const;
96 /** Returns recent optical-disk folder. */
97 QString recentFolderForOpticalDisks() const;
98 /** Returns recent floppy-disk folder. */
99 QString recentFolderForFloppyDisks() const;
100 /** Defines recent hard-drive folder as @a strValue. */
101 void setRecentFolderForHardDrives(const QString &strValue);
102 /** Defines recent optical-disk folder as @a strValue. */
103 void setRecentFolderForOpticalDisks(const QString &strValue);
104 /** Defines recent floppy-disk folder as @a strValue. */
105 void setRecentFolderForFloppyDisks(const QString &strValue);
106
107 /** Returns recent hard-drive list. */
108 QStringList recentListOfHardDrives() const;
109 /** Returns recent optical-disk list. */
110 QStringList recentListOfOpticalDisks() const;
111 /** Returns recent floppy-disk list. */
112 QStringList recentListOfFloppyDisks() const;
113 /** Defines recent hard-drive list as @a value. */
114 void setRecentListOfHardDrives(const QStringList &value);
115 /** Defines recent optical-disk list as @a value. */
116 void setRecentListOfOpticalDisks(const QStringList &value);
117 /** Defines recent floppy-disk list as @a value. */
118 void setRecentListOfFloppyDisks(const QStringList &value);
119
120 /** Returns list of the supressed messages for the Message/Popup center frameworks. */
121 QStringList suppressedMessages() const;
122 /** Defines list of the supressed messages for the Message/Popup center frameworks as @a value. */
123 void setSuppressedMessages(const QStringList &value);
124
125 /** Returns list of the messages for the Message/Popup center frameworks with inverted check-box state. */
126 QStringList messagesWithInvertedOption() const;
127
128 /** Returns mode (basic/expert) for wizard of @a type. */
129 WizardMode modeForWizard(WizardType type);
130 /** Defines @a mode (basic/expert) for wizard of @a type. */
131 void setModeForWizard(WizardType type, WizardMode mode);
132
133 /** Returns selector-window geometry using @a pHintWidget as the hint. */
134 QRect selectorWindowGeometry(QWidget *pHintWidget = 0) const;
135 /** Returns whether selector-window should be maximized or not. */
136 bool isSelectorWindowShouldBeMaximized() const;
137 /** Defines selector-window geometry to passed @a geometry which is @a fMaximized. */
138 void setSelectorWindowGeometry(const QRect &geometry, bool fMaximized);
139
140 /** Returns selector-window splitter hints. */
141 QList<int> selectorWindowSplitterHints() const;
142 /** Defines selector-window splitter @a hints. */
143 void setSelectorWindowSplitterHints(const QList<int> &hints);
144
145 /** Returns whether selector-window tool-bar visible. */
146 bool selectorWindowToolBarVisible() const;
147 /** Defines whether selector-window tool-bar @a fVisible. */
148 void setSelectorWindowToolBarVisible(bool fVisible);
149 /** Returns whether selector-window status-bar visible. */
150 bool selectorWindowStatusBarVisible() const;
151 /** Defines whether selector-window status-bar @a fVisible. */
152 void setSelectorWindowStatusBarVisible(bool fVisible);
153
154 /** Clears all the existing selector-window chooser-pane' group definitions. */
155 void clearSelectorWindowGroupsDefinitions();
156 /** Returns selector-window chooser-pane' groups definitions for passed @a strGroupID. */
157 QStringList selectorWindowGroupsDefinitions(const QString &strGroupID) const;
158 /** Defines selector-window chooser-pane' groups definitions for passed @a strGroupID as @a definitions. */
159 void setSelectorWindowGroupsDefinitions(const QString &strGroupID, const QStringList &definitions);
160
161 /** Returns last item chosen in selector-window chooser-pane. */
162 QString selectorWindowLastItemChosen() const;
163 /** Defines last item chosen in selector-window chooser-pane as @a strItemID. */
164 void setSelectorWindowLastItemChosen(const QString &strItemID);
165
166 /** Returns selector-window details-pane elements. */
167 QMap<DetailsElementType, bool> selectorWindowDetailsElements();
168 /** Defines selector-window details-pane @a elements. */
169 void setSelectorWindowDetailsElements(const QMap<DetailsElementType, bool> &elements);
170
171 /** Returns selector-window preview update interval. */
172 PreviewUpdateIntervalType selectorWindowPreviewUpdateInterval() const;
173 /** Defines selector-window preview update @a interval. */
174 void setSelectorWindowPreviewUpdateInterval(PreviewUpdateIntervalType interval);
175
176 /** Returns geometry for machine-window with @a uScreenIndex in @a visualStateType. */
177 QRect machineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QString &strId) const;
178 /** Returns whether machine-window with @a uScreenIndex in @a visualStateType should be maximized or not. */
179 bool isMachineWindowShouldBeMaximized(UIVisualStateType visualStateType, ulong uScreenIndex, const QString &strId) const;
180 /** Defines geometry for machine-window with @a uScreenIndex in @a visualStateType as @a geometry and @a fMaximized. */
181 void setMachineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QRect &geometry, bool fMaximized, const QString &strId);
182
183 /** Returns whether this machine started for the first time. */
184 bool isFirstRun(const QString &strId) const;
185 /** Defines whether this machine started for the first time. */
186 void setFirstRun(bool fIsFirstRun, const QString &strId);
187
188 /** Returns whether we should show machine. */
189 bool shouldWeShowMachine(const QString &strID) const;
190 /** Returns whether we should show machine details. */
191 bool shouldWeShowMachineDetails(const QString &strID) const;
192
193 /** Returns whether we should allow machine reconfiguration. */
194 bool shouldWeAllowMachineReconfiguration(const QString &strID) const;
195 /** Returns whether we should allow machine snapshot operations. */
196 bool shouldWeAllowMachineSnapshotOperations(const QString &strID) const;
197
198 /** Returns whether we should automatically mount/unmount guest-screens. */
199 bool shouldWeAutoMountGuestScreens(const QString &strID) const;
200
201 /** Returns restricted Runtime UI menu types. */
202 RuntimeMenuType restrictedRuntimeMenuTypes(const QString &strID) const;
203#ifdef Q_WS_MAC
204 /** Mac OS X: Returns restricted Runtime UI action types for Application menu. */
205 RuntimeMenuApplicationActionType restrictedRuntimeMenuApplicationActionTypes(const QString &strID) const;
206#endif /* Q_WS_MAC */
207 /** Returns restricted Runtime UI action types for Machine menu. */
208 RuntimeMenuMachineActionType restrictedRuntimeMenuMachineActionTypes(const QString &strID) const;
209 /** Returns restricted Runtime UI action types for View menu. */
210 RuntimeMenuViewActionType restrictedRuntimeMenuViewActionTypes(const QString &strID) const;
211 /** Returns restricted Runtime UI action types for Devices menu. */
212 RuntimeMenuDevicesActionType restrictedRuntimeMenuDevicesActionTypes(const QString &strID) const;
213#ifdef VBOX_WITH_DEBUGGER_GUI
214 /** Returns restricted Runtime UI action types for Debugger menu. */
215 RuntimeMenuDebuggerActionType restrictedRuntimeMenuDebuggerActionTypes(const QString &strID) const;
216#endif /* VBOX_WITH_DEBUGGER_GUI */
217 /** Returns restricted Runtime UI action types for Help menu. */
218 RuntimeMenuHelpActionType restrictedRuntimeMenuHelpActionTypes(const QString &strID) const;
219
220 /** Returns restricted Runtime UI visual-state types. */
221 UIVisualStateType restrictedVisualStateTypes(const QString &strID) const;
222
223 /** Returns default machine close action. */
224 MachineCloseAction defaultMachineCloseAction(const QString &strID) const;
225 /** Returns restricted machine close actions. */
226 MachineCloseAction restrictedMachineCloseActions(const QString &strID) const;
227
228 /** Returns restricted Runtime UI status-bar indicators. */
229 QList<IndicatorType> restrictedStatusBarIndicators(const QString &strID) const;
230
231 /** Returns global settings pages. */
232 QList<GlobalSettingsPageType> restrictedGlobalSettingsPages() const;
233 /** Returns machine settings pages. */
234 QList<MachineSettingsPageType> restrictedMachineSettingsPages(const QString &strID) const;
235
236#ifndef Q_WS_MAC
237 /** Except Mac OS X: Returns redefined machine-window icon names. */
238 QStringList machineWindowIconNames(const QString &strID) const;
239 /** Except Mac OS X: Returns redefined machine-window name postfix. */
240 QString machineWindowNamePostfix(const QString &strID) const;
241#endif /* !Q_WS_MAC */
242
243 /** Returns redefined guru-meditation handler type. */
244 GuruMeditationHandlerType guruMeditationHandlerType(const QString &strID) const;
245
246 /** Returns Runtime UI HiDPI optimization type. */
247 HiDPIOptimizationType hiDPIOptimizationType(const QString &strID) const;
248
249private slots:
250
251 /** Handles 'extra-data change' event: */
252 void sltExtraDataChange(QString strMachineID, QString strKey, QString strValue);
253
254private:
255
256 /** Prepare Extra-data Manager. */
257 void prepare();
258 /** Prepare global extra-data map. */
259 void prepareGlobalExtraDataMap();
260 /** Prepare extra-data event-handler. */
261 void prepareExtraDataEventHandler();
262 /** Prepare Main event-listener. */
263 void prepareMainEventListener();
264
265 /** Cleanup Extra-data Manager. */
266 void cleanup();
267 /** Cleanup Main event-listener. */
268 void cleanupMainEventListener();
269 // /** Cleanup extra-data event-handler. */
270 // void cleanupExtraDataEventHandler();
271 // /** Cleanup extra-data map. */
272 // void cleanupExtraDataMap();
273
274 /** Hot-load machine extra-data map. */
275 void hotloadMachineExtraDataMap(const QString &strID) const;
276
277 /** Determines whether feature corresponding to passed @a strKey is allowed.
278 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
279 bool isFeatureAllowed(const QString &strKey, const QString &strID = m_sstrGlobalID) const;
280 /** Determines whether feature corresponding to passed @a strKey is restricted.
281 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
282 bool isFeatureRestricted(const QString &strKey, const QString &strID = m_sstrGlobalID) const;
283
284 /** Translates bool flag into 'allowed' value. */
285 QString toFeatureAllowed(bool fAllowed);
286 /** Translates bool flag into 'restricted' value. */
287 QString toFeatureRestricted(bool fRestricted);
288
289 /** Returns extra-data value corresponding to passed @a strKey as QString.
290 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
291 QString extraDataString(const QString &strKey, const QString &strID = m_sstrGlobalID) const;
292 /** Defines extra-data value corresponding to passed @a strKey as strValue.
293 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
294 void setExtraDataString(const QString &strKey, const QString &strValue, const QString &strID = m_sstrGlobalID);
295
296 /** Returns extra-data value corresponding to passed @a strKey as QStringList.
297 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
298 QStringList extraDataStringList(const QString &strKey, const QString &strID = m_sstrGlobalID) const;
299 /** Defines extra-data value corresponding to passed @a strKey as strValue.
300 * If valid @a strID is set => applies to machine extra-data, otherwise => to global one. */
301 void setExtraDataStringList(const QString &strKey, const QStringList &strValue, const QString &strID = m_sstrGlobalID);
302
303 /** Singleton Extra-data Manager instance. */
304 static UIExtraDataManager *m_pInstance;
305
306 /** Global extra-data ID. */
307 static QString m_sstrGlobalID;
308
309 /** Main event-listener instance. */
310 CEventListener m_listener;
311 /** Extra-data event-handler instance. */
312 UIExtraDataEventHandler *m_pHandler;
313
314 /** Extra-data map. */
315 mutable QMap<QString, ExtraDataMap> m_data;
316};
317
318/** Singleton Extra-data Manager 'official' name. */
319#define gEDataManager UIExtraDataManager::instance()
320
321#endif /* !___UIExtraDataManager_h___ */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette