VirtualBox

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

Last change on this file since 76581 was 76581, checked in by vboxsync, 6 years ago

Fe/QT: scm header guard alignment.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 38.6 KB
Line 
1/* $Id: UIExtraDataManager.h 76581 2019-01-01 06:24:57Z vboxsync $ */
2/** @file
3 * VBox Qt GUI - UIExtraDataManager class declaration.
4 */
5
6/*
7 * Copyright (C) 2010-2019 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_extradata_UIExtraDataManager_h
19#define FEQT_INCLUDED_SRC_extradata_UIExtraDataManager_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24/* Qt includes: */
25#include <QMap>
26#include <QObject>
27#include <QSize>
28#include <QUuid>
29#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
30# include <QPointer>
31#endif
32
33/* GUI includes: */
34#include "UIExtraDataDefs.h"
35
36/* Forward declarations: */
37class UIExtraDataEventHandler;
38#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
39class UIExtraDataManagerWindow;
40#endif
41
42/** Defines the map of extra data values. The index is an extra-data key. */
43typedef QMap<QString, QString> ExtraDataMap;
44/** Defines the map of extra data maps. */
45typedef QMap<QUuid, ExtraDataMap> MapOfExtraDataMaps;
46
47/** Singleton QObject extension
48 * providing GUI with corresponding extra-data values,
49 * and notifying it whenever any of those values changed. */
50class SHARED_LIBRARY_STUFF UIExtraDataManager : public QObject
51{
52 Q_OBJECT;
53
54 /** Extra-data Manager constructor. */
55 UIExtraDataManager();
56 /** Extra-data Manager destructor. */
57 ~UIExtraDataManager();
58
59signals:
60
61 /** Notifies about extra-data map acknowledging. */
62 void sigExtraDataMapAcknowledging(const QUuid &uID);
63
64 /** Notifies about extra-data change. */
65 void sigExtraDataChange(const QUuid &uID, const QString &strKey, const QString &strValue);
66
67 /** Notifies about GUI language change. */
68 void sigLanguageChange(QString strLanguage);
69
70 /** Notifies about Selector UI keyboard shortcut change. */
71 void sigSelectorUIShortcutChange();
72 /** Notifies about Runtime UI keyboard shortcut change. */
73 void sigRuntimeUIShortcutChange();
74 /** Notifies about Runtime UI host-key combination change. */
75 void sigRuntimeUIHostKeyCombinationChange();
76
77 /** Notifies about VirtualBox Manager / Details pane categories change. */
78 void sigDetailsCategoriesChange();
79 /** Notifies about VirtualBox Manager / Details pane options change. */
80 void sigDetailsOptionsChange(DetailsElementType enmType);
81
82 /** Notifies about menu-bar configuration change. */
83 void sigMenuBarConfigurationChange(const QUuid &uMachineID);
84 /** Notifies about status-bar configuration change. */
85 void sigStatusBarConfigurationChange(const QUuid &uMachineID);
86
87 /** Notifies about HID LEDs synchronization state change. */
88 void sigHidLedsSyncStateChange(bool fEnabled);
89
90 /** Notifies about the scale-factor change. */
91 void sigScaleFactorChange(const QUuid &uMachineID);
92
93 /** Notifies about the scaling optimization type change. */
94 void sigScalingOptimizationTypeChange(const QUuid &uMachineID);
95
96#ifdef VBOX_WS_MAC
97 /** Notifies about the HiDPI optimization type change. */
98 void sigHiDPIOptimizationTypeChange(const QUuid &uMachineID);
99
100 /** Mac OS X: Notifies about 'dock icon' appearance change. */
101 void sigDockIconAppearanceChange(bool fEnabled);
102 /** Mac OS X: Notifies about 'dock icon overlay' appearance change. */
103 void sigDockIconOverlayAppearanceChange(bool fEnabled);
104#endif /* VBOX_WS_MAC */
105
106public:
107
108 /** Global extra-data ID. */
109 static const QUuid GlobalID;
110
111 /** Static Extra-data Manager instance/constructor. */
112 static UIExtraDataManager* instance();
113 /** Static Extra-data Manager destructor. */
114 static void destroy();
115
116#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
117 /** Static show and raise API. */
118 static void openWindow(QWidget *pCenterWidget);
119#endif
120
121 /** @name Base
122 * @{ */
123 /** Returns whether Extra-data Manager cached the map with passed @a uID. */
124 bool contains(const QUuid &uID) const { return m_data.contains(uID); }
125 /** Returns read-only extra-data map for passed @a uID. */
126 const ExtraDataMap map(const QUuid &uID) const { return m_data.value(uID); }
127
128 /** Hot-load machine extra-data map. */
129 void hotloadMachineExtraDataMap(const QUuid &uID);
130
131 /** Returns extra-data value corresponding to passed @a strKey as QString.
132 * If valid @a uID is set => applies to machine extra-data, otherwise => to global one. */
133 QString extraDataString(const QString &strKey, const QUuid &uID = GlobalID);
134 /** Defines extra-data value corresponding to passed @a strKey as strValue.
135 * If valid @a uID is set => applies to machine extra-data, otherwise => to global one. */
136 void setExtraDataString(const QString &strKey, const QString &strValue, const QUuid &uID = GlobalID);
137
138 /** Returns extra-data value corresponding to passed @a strKey as QStringList.
139 * If valid @a uID is set => applies to machine extra-data, otherwise => to global one. */
140 QStringList extraDataStringList(const QString &strKey, const QUuid &uID = GlobalID);
141 /** Defines extra-data value corresponding to passed @a strKey as value.
142 * If valid @a uID is set => applies to machine extra-data, otherwise => to global one. */
143 void setExtraDataStringList(const QString &strKey, const QStringList &value, const QUuid &uID = GlobalID);
144 /** @} */
145
146 /** @name General
147 * @{ */
148 /** Returns event handling type. */
149 EventHandlingType eventHandlingType();
150 /** @} */
151
152 /** @name Messaging
153 * @{ */
154 /** Returns the list of supressed messages for the Message/Popup center frameworks. */
155 QStringList suppressedMessages(const QUuid &uID = GlobalID);
156 /** Defines the @a list of supressed messages for the Message/Popup center frameworks. */
157 void setSuppressedMessages(const QStringList &list);
158
159 /** Returns the list of messages for the Message/Popup center frameworks with inverted check-box state. */
160 QStringList messagesWithInvertedOption();
161
162#if !defined(VBOX_BLEEDING_EDGE) && !defined(DEBUG)
163 /** Returns version for which user wants to prevent BETA build warning. */
164 QString preventBetaBuildWarningForVersion();
165#endif
166 /** @} */
167
168#ifdef VBOX_GUI_WITH_NETWORK_MANAGER
169 /** @name Application Update
170 * @{ */
171 /** Returns whether Application Update functionality enabled. */
172 bool applicationUpdateEnabled();
173
174 /** Returns Application Update data. */
175 QString applicationUpdateData();
176 /** Defines Application Update data as @a strValue. */
177 void setApplicationUpdateData(const QString &strValue);
178
179 /** Returns Application Update check counter. */
180 qulonglong applicationUpdateCheckCounter();
181 /** Increments Application Update check counter. */
182 void incrementApplicationUpdateCheckCounter();
183 /** @} */
184#endif /* VBOX_GUI_WITH_NETWORK_MANAGER */
185
186 /** @name Progress
187 * @{ */
188 /** Returns whether legacy progress handling method is requested. */
189 bool legacyProgressHandlingRequested();
190 /** @} */
191
192 /** @name Settings
193 * @{ */
194 /** Returns whether GUI @a enmFeature is enabled. */
195 bool guiFeatureEnabled(GUIFeatureType enmFeature);
196
197 /** Returns restricted global settings pages. */
198 QList<GlobalSettingsPageType> restrictedGlobalSettingsPages();
199 /** Returns restricted machine settings pages. */
200 QList<MachineSettingsPageType> restrictedMachineSettingsPages(const QUuid &uID);
201 /** @} */
202
203 /** @name Settings: General
204 * @{ */
205 /** Returns whether the host screen-saver should be disabled. */
206 bool hostScreenSaverDisabled();
207 /** Defines whether the host screen-saver should be @a fDisabled. */
208 void setHostScreenSaverDisabled(bool fDisabled);
209 /** @} */
210
211 /** @name Settings: Language
212 * @{ */
213 /** Returns the GUI language ID. */
214 QString languageId();
215 /** Defines the GUI @a strLanguageId. */
216 void setLanguageId(const QString &strLanguageId);
217 /** @} */
218
219 /** @name Settings: Display
220 * @{ */
221 /** Returns maximum guest-screen resolution policy. */
222 MaxGuestResolutionPolicy maxGuestResolutionPolicy();
223 /** Defines maximum guest-screen resolution @a enmPolicy or @a resolution itself for Fixed policy. */
224 void setMaxGuestScreenResolution(MaxGuestResolutionPolicy enmPolicy, const QSize resolution = QSize());
225 /** Returns maximum guest-screen resolution for fixed policy. */
226 QSize maxGuestResolutionForPolicyFixed();
227 /** Defines maximum guest-screen @a resolution for fixed policy. */
228 void setMaxGuestResolutionForPolicyFixed(const QSize &resolution);
229
230 /** Returns whether hovered machine-window should be activated. */
231 bool activateHoveredMachineWindow();
232 /** Defines whether hovered machine-window should be @a fActivated. */
233 void setActivateHoveredMachineWindow(bool fActivate);
234 /** @} */
235
236 /** @name Settings: Keyboard
237 * @{ */
238 /** Returns the Runtime UI host-key combination. */
239 QString hostKeyCombination();
240 /** Defines the Runtime UI host-key combination. */
241 void setHostKeyCombination(const QString &strHostCombo);
242
243 /** Returns shortcut overrides for shortcut-pool with @a strPoolExtraDataID. */
244 QStringList shortcutOverrides(const QString &strPoolExtraDataID);
245
246 /** Returns whether the Runtime UI auto-capture is enabled. */
247 bool autoCaptureEnabled();
248 /** Defines whether the Runtime UI auto-capture is @a fEnabled. */
249 void setAutoCaptureEnabled(bool fEnabled);
250
251 /** Returns the Runtime UI remapped scan codes. */
252 QString remappedScanCodes();
253 /** @} */
254
255 /** @name Settings: Proxy
256 * @{ */
257 /** Returns VBox proxy settings. */
258 QString proxySettings();
259 /** Defines VBox proxy @a strSettings. */
260 void setProxySettings(const QString &strSettings);
261 /** @} */
262
263 /** @name Settings: Storage
264 * @{ */
265 /** Returns recent folder for hard-drives. */
266 QString recentFolderForHardDrives();
267 /** Returns recent folder for optical-disks. */
268 QString recentFolderForOpticalDisks();
269 /** Returns recent folder for floppy-disks. */
270 QString recentFolderForFloppyDisks();
271 /** Returns recent folder for VISO creation content. */
272 QString recentFolderForVISOContent();
273 /** Defines recent folder for hard-drives as @a strValue. */
274 void setRecentFolderForHardDrives(const QString &strValue);
275 /** Defines recent folder for optical-disk as @a strValue. */
276 void setRecentFolderForOpticalDisks(const QString &strValue);
277 /** Defines recent folder for floppy-disk as @a strValue. */
278 void setRecentFolderForFloppyDisks(const QString &strValue);
279 /** Defines recent folder for VISO creation content as @a strValue. */
280 void setRecentFolderForVISOContent(const QString &strValue);
281
282 /** Returns the list of recently used hard-drives. */
283 QStringList recentListOfHardDrives();
284 /** Returns the list of recently used optical-disk. */
285 QStringList recentListOfOpticalDisks();
286 /** Returns the list of recently used floppy-disk. */
287 QStringList recentListOfFloppyDisks();
288 /** Defines the list of recently used hard-drives as @a value. */
289 void setRecentListOfHardDrives(const QStringList &value);
290 /** Defines the list of recently used optical-disks as @a value. */
291 void setRecentListOfOpticalDisks(const QStringList &value);
292 /** Defines the list of recently used floppy-disks as @a value. */
293 void setRecentListOfFloppyDisks(const QStringList &value);
294 /** @} */
295
296 /** @name VirtualBox Manager
297 * @{ */
298 /** Returns selector-window geometry using @a pWidget as the hint. */
299 QRect selectorWindowGeometry(QWidget *pWidget);
300 /** Returns whether selector-window should be maximized. */
301 bool selectorWindowShouldBeMaximized();
302 /** Defines selector-window @a geometry and @a fMaximized state. */
303 void setSelectorWindowGeometry(const QRect &geometry, bool fMaximized);
304
305 /** Returns selector-window splitter hints. */
306 QList<int> selectorWindowSplitterHints();
307 /** Defines selector-window splitter @a hints. */
308 void setSelectorWindowSplitterHints(const QList<int> &hints);
309
310 /** Returns whether selector-window tool-bar visible. */
311 bool selectorWindowToolBarVisible();
312 /** Defines whether selector-window tool-bar @a fVisible. */
313 void setSelectorWindowToolBarVisible(bool fVisible);
314
315 /** Returns whether selector-window tool-bar text visible. */
316 bool selectorWindowToolBarTextVisible();
317 /** Defines whether selector-window tool-bar text @a fVisible. */
318 void setSelectorWindowToolBarTextVisible(bool fVisible);
319
320 /** Returns last selected tool set of VirtualBox Manager. */
321 QList<UIToolType> toolsPaneLastItemsChosen();
322 /** Defines last selected tool @a set of VirtualBox Manager. */
323 void setToolsPaneLastItemsChosen(const QList<UIToolType> &set);
324
325 /** Returns whether selector-window status-bar visible. */
326 bool selectorWindowStatusBarVisible();
327 /** Defines whether selector-window status-bar @a fVisible. */
328 void setSelectorWindowStatusBarVisible(bool fVisible);
329
330 /** Clears all the existing selector-window chooser-pane' group definitions. */
331 void clearSelectorWindowGroupsDefinitions();
332 /** Returns selector-window chooser-pane' groups definitions for passed @a strGroupID. */
333 QStringList selectorWindowGroupsDefinitions(const QString &strGroupID);
334 /** Defines selector-window chooser-pane' groups @a definitions for passed @a strGroupID. */
335 void setSelectorWindowGroupsDefinitions(const QString &strGroupID, const QStringList &definitions);
336
337 /** Returns last-item ID of the item chosen in selector-window chooser-pane. */
338 QString selectorWindowLastItemChosen();
339 /** Defines @a lastItemID of the item chosen in selector-window chooser-pane. */
340 void setSelectorWindowLastItemChosen(const QString &strItemID);
341
342 /** Returns selector-window details-pane' elements. */
343 QMap<DetailsElementType, bool> selectorWindowDetailsElements();
344 /** Defines selector-window details-pane' @a elements. */
345 void setSelectorWindowDetailsElements(const QMap<DetailsElementType, bool> &elements);
346
347 /** Returns selector-window details-pane' preview update interval. */
348 PreviewUpdateIntervalType selectorWindowPreviewUpdateInterval();
349 /** Defines selector-window details-pane' preview update @a interval. */
350 void setSelectorWindowPreviewUpdateInterval(PreviewUpdateIntervalType interval);
351
352 /** Returns VirtualBox Manager / Details pane options for certain @a enmElementType. */
353 QStringList vboxManagerDetailsPaneElementOptions(DetailsElementType enmElementType);
354 /** Defines VirtualBox Manager / Details pane @a options for certain @a enmElementType. */
355 void setVBoxManagerDetailsPaneElementOptions(DetailsElementType enmElementType, const QStringList &options);
356 /** @} */
357
358 /** @name Snapshot Manager
359 * @{ */
360 /** Returns whether Snapshot Manager details expanded. */
361 bool snapshotManagerDetailsExpanded();
362 /** Defines whether Snapshot Manager details @a fExpanded. */
363 void setSnapshotManagerDetailsExpanded(bool fExpanded);
364 /** @} */
365
366 /** @name Virtual Media Manager
367 * @{ */
368 /** Returns whether Virtual Media Manager details expanded. */
369 bool virtualMediaManagerDetailsExpanded();
370 /** Defines whether Virtual Media Manager details @a fExpanded. */
371 void setVirtualMediaManagerDetailsExpanded(bool fExpanded);
372 /** @} */
373
374 /** @name Host Network Manager
375 * @{ */
376 /** Returns whether Host Network Manager details expanded. */
377 bool hostNetworkManagerDetailsExpanded();
378 /** Defines whether Host Network Manager details @a fExpanded. */
379 void setHostNetworkManagerDetailsExpanded(bool fExpanded);
380 /** @} */
381
382 /** @name Cloud Profile Manager
383 * @{ */
384 /** Returns whether Cloud Profile Manager details expanded. */
385 bool cloudProfileManagerDetailsExpanded();
386 /** Defines whether Cloud Profile Manager details @a fExpanded. */
387 void setCloudProfileManagerDetailsExpanded(bool fExpanded);
388 /** @} */
389
390 /** @name Wizards
391 * @{ */
392 /** Returns mode for wizard of passed @a type. */
393 WizardMode modeForWizardType(WizardType type);
394 /** Defines @a mode for wizard of passed @a type. */
395 void setModeForWizardType(WizardType type, WizardMode mode);
396 /** @} */
397
398 /** @name Virtual Machine
399 * @{ */
400 /** Returns whether machine should be shown in selector-window chooser-pane. */
401 bool showMachineInSelectorChooser(const QUuid &uID);
402 /** Returns whether machine should be shown in selector-window details-pane. */
403 bool showMachineInSelectorDetails(const QUuid &uID);
404
405 /** Returns whether machine reconfiguration enabled. */
406 bool machineReconfigurationEnabled(const QUuid &uID);
407 /** Returns whether machine snapshot operations enabled. */
408 bool machineSnapshotOperationsEnabled(const QUuid &uID);
409
410 /** Returns whether this machine is first time started. */
411 bool machineFirstTimeStarted(const QUuid &uID);
412 /** Returns whether this machine is fFirstTimeStarted. */
413 void setMachineFirstTimeStarted(bool fFirstTimeStarted, const QUuid &uID);
414
415 /** Except Mac OS X: Returns redefined machine-window icon names. */
416 QStringList machineWindowIconNames(const QUuid &uID);
417#ifndef VBOX_WS_MAC
418 /** Except Mac OS X: Returns redefined machine-window name postfix. */
419 QString machineWindowNamePostfix(const QUuid &uID);
420#endif
421
422 /** Returns geometry for machine-window with @a uScreenIndex in @a visualStateType. */
423 QRect machineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QUuid &uID);
424 /** Returns whether machine-window with @a uScreenIndex in @a visualStateType should be maximized. */
425 bool machineWindowShouldBeMaximized(UIVisualStateType visualStateType, ulong uScreenIndex, const QUuid &uID);
426 /** Defines @a geometry and @a fMaximized state for machine-window with @a uScreenIndex in @a visualStateType. */
427 void setMachineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QRect &geometry, bool fMaximized, const QUuid &uID);
428
429#ifndef VBOX_WS_MAC
430 /** Returns whether Runtime UI menu-bar is enabled. */
431 bool menuBarEnabled(const QUuid &uID);
432 /** Defines whether Runtime UI menu-bar is @a fEnabled. */
433 void setMenuBarEnabled(bool fEnabled, const QUuid &uID);
434#endif /* !VBOX_WS_MAC */
435
436 /** Returns whether Runtime UI menu-bar context-menu is enabled. */
437 bool menuBarContextMenuEnabled(const QUuid &uID);
438 /** Defines whether Runtime UI menu-bar context-menu is @a fEnabled. */
439 void setMenuBarContextMenuEnabled(bool fEnabled, const QUuid &uID);
440
441 /** Returns restricted Runtime UI menu types. */
442 UIExtraDataMetaDefs::MenuType restrictedRuntimeMenuTypes(const QUuid &uID);
443 /** Defines restricted Runtime UI menu types. */
444 void setRestrictedRuntimeMenuTypes(UIExtraDataMetaDefs::MenuType types, const QUuid &uID);
445
446 /** Returns restricted Runtime UI action types for Application menu. */
447 UIExtraDataMetaDefs::MenuApplicationActionType restrictedRuntimeMenuApplicationActionTypes(const QUuid &uID);
448 /** Defines restricted Runtime UI action types for Application menu. */
449 void setRestrictedRuntimeMenuApplicationActionTypes(UIExtraDataMetaDefs::MenuApplicationActionType types, const QUuid &uID);
450
451 /** Returns restricted Runtime UI action types for Machine menu. */
452 UIExtraDataMetaDefs::RuntimeMenuMachineActionType restrictedRuntimeMenuMachineActionTypes(const QUuid &uID);
453 /** Defines restricted Runtime UI action types for Machine menu. */
454 void setRestrictedRuntimeMenuMachineActionTypes(UIExtraDataMetaDefs::RuntimeMenuMachineActionType types, const QUuid &uID);
455
456 /** Returns restricted Runtime UI action types for View menu. */
457 UIExtraDataMetaDefs::RuntimeMenuViewActionType restrictedRuntimeMenuViewActionTypes(const QUuid &uID);
458 /** Defines restricted Runtime UI action types for View menu. */
459 void setRestrictedRuntimeMenuViewActionTypes(UIExtraDataMetaDefs::RuntimeMenuViewActionType types, const QUuid &uID);
460
461 /** Returns restricted Runtime UI action types for Input menu. */
462 UIExtraDataMetaDefs::RuntimeMenuInputActionType restrictedRuntimeMenuInputActionTypes(const QUuid &uID);
463 /** Defines restricted Runtime UI action types for Input menu. */
464 void setRestrictedRuntimeMenuInputActionTypes(UIExtraDataMetaDefs::RuntimeMenuInputActionType types, const QUuid &uID);
465
466 /** Returns restricted Runtime UI action types for Devices menu. */
467 UIExtraDataMetaDefs::RuntimeMenuDevicesActionType restrictedRuntimeMenuDevicesActionTypes(const QUuid &uID);
468 /** Defines restricted Runtime UI action types for Devices menu. */
469 void setRestrictedRuntimeMenuDevicesActionTypes(UIExtraDataMetaDefs::RuntimeMenuDevicesActionType types, const QUuid &uID);
470
471#ifdef VBOX_WITH_DEBUGGER_GUI
472 /** Returns restricted Runtime UI action types for Debugger menu. */
473 UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType restrictedRuntimeMenuDebuggerActionTypes(const QUuid &uID);
474 /** Defines restricted Runtime UI action types for Debugger menu. */
475 void setRestrictedRuntimeMenuDebuggerActionTypes(UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType types, const QUuid &uID);
476#endif /* VBOX_WITH_DEBUGGER_GUI */
477
478#ifdef VBOX_WS_MAC
479 /** Mac OS X: Returns restricted Runtime UI action types for Window menu. */
480 UIExtraDataMetaDefs::MenuWindowActionType restrictedRuntimeMenuWindowActionTypes(const QUuid &uID);
481 /** Mac OS X: Defines restricted Runtime UI action types for Window menu. */
482 void setRestrictedRuntimeMenuWindowActionTypes(UIExtraDataMetaDefs::MenuWindowActionType types, const QUuid &uID);
483#endif /* VBOX_WS_MAC */
484
485 /** Returns restricted Runtime UI action types for Help menu. */
486 UIExtraDataMetaDefs::MenuHelpActionType restrictedRuntimeMenuHelpActionTypes(const QUuid &uID);
487 /** Defines restricted Runtime UI action types for Help menu. */
488 void setRestrictedRuntimeMenuHelpActionTypes(UIExtraDataMetaDefs::MenuHelpActionType types, const QUuid &uID);
489
490 /** Returns restricted Runtime UI visual-states. */
491 UIVisualStateType restrictedVisualStates(const QUuid &uID);
492
493 /** Returns requested Runtime UI visual-state. */
494 UIVisualStateType requestedVisualState(const QUuid &uID);
495 /** Defines requested Runtime UI visual-state as @a visualState. */
496 void setRequestedVisualState(UIVisualStateType visualState, const QUuid &uID);
497
498#ifdef VBOX_WS_X11
499 /** Returns whether legacy full-screen mode is requested. */
500 bool legacyFullscreenModeRequested();
501
502 /** Returns whether internal machine-window name should be unique. */
503 bool distinguishMachineWindowGroups(const QUuid &uID);
504 /** Defines whether internal machine-window name should be unique. */
505 void setDistinguishMachineWindowGroups(const QUuid &uID, bool fEnabled);
506#endif /* VBOX_WS_X11 */
507
508 /** Returns whether guest-screen auto-resize according machine-window size is enabled. */
509 bool guestScreenAutoResizeEnabled(const QUuid &uID);
510 /** Defines whether guest-screen auto-resize according machine-window size is @a fEnabled. */
511 void setGuestScreenAutoResizeEnabled(bool fEnabled, const QUuid &uID);
512
513 /** Returns last guest-screen visibility status for screen with @a uScreenIndex. */
514 bool lastGuestScreenVisibilityStatus(ulong uScreenIndex, const QUuid &uID);
515 /** Defines whether last guest-screen visibility status was @a fEnabled for screen with @a uScreenIndex. */
516 void setLastGuestScreenVisibilityStatus(ulong uScreenIndex, bool fEnabled, const QUuid &uID);
517
518 /** Returns last guest-screen size-hint for screen with @a uScreenIndex. */
519 QSize lastGuestScreenSizeHint(ulong uScreenIndex, const QUuid &uID);
520 /** Defines last guest-screen @a sizeHint for screen with @a uScreenIndex. */
521 void setLastGuestScreenSizeHint(ulong uScreenIndex, const QSize &sizeHint, const QUuid &uID);
522
523 /** Returns host-screen index corresponding to passed guest-screen @a iGuestScreenIndex. */
524 int hostScreenForPassedGuestScreen(int iGuestScreenIndex, const QUuid &uID);
525 /** Defines @a iHostScreenIndex corresponding to passed guest-screen @a iGuestScreenIndex. */
526 void setHostScreenForPassedGuestScreen(int iGuestScreenIndex, int iHostScreenIndex, const QUuid &uID);
527
528 /** Returns whether automatic mounting/unmounting of guest-screens enabled. */
529 bool autoMountGuestScreensEnabled(const QUuid &uID);
530
531#ifdef VBOX_WITH_VIDEOHWACCEL
532 /** Returns whether 2D acceleration should use linear sretch. */
533 bool useLinearStretch(const QUuid &uID);
534 /** Returns whether 2D acceleration should use YV12 pixel format. */
535 bool usePixelFormatYV12(const QUuid &uID);
536 /** Returns whether 2D acceleration should use UYVY pixel format. */
537 bool usePixelFormatUYVY(const QUuid &uID);
538 /** Returns whether 2D acceleration should use YUY2 pixel format. */
539 bool usePixelFormatYUY2(const QUuid &uID);
540 /** Returns whether 2D acceleration should use AYUV pixel format. */
541 bool usePixelFormatAYUV(const QUuid &uID);
542#endif /* VBOX_WITH_VIDEOHWACCEL */
543
544#ifndef VBOX_WS_MAC
545 /** Returns whether mini-toolbar is enabled for full and seamless screens. */
546 bool miniToolbarEnabled(const QUuid &uID);
547 /** Defines whether mini-toolbar is @a fEnabled for full and seamless screens. */
548 void setMiniToolbarEnabled(bool fEnabled, const QUuid &uID);
549
550 /** Returns whether mini-toolbar should auto-hide itself. */
551 bool autoHideMiniToolbar(const QUuid &uID);
552 /** Defines whether mini-toolbar should @a fAutoHide itself. */
553 void setAutoHideMiniToolbar(bool fAutoHide, const QUuid &uID);
554
555 /** Returns mini-toolbar alignment. */
556 Qt::AlignmentFlag miniToolbarAlignment(const QUuid &uID);
557 /** Returns mini-toolbar @a alignment. */
558 void setMiniToolbarAlignment(Qt::AlignmentFlag alignment, const QUuid &uID);
559#endif /* VBOX_WS_MAC */
560
561 /** Returns whether Runtime UI status-bar is enabled. */
562 bool statusBarEnabled(const QUuid &uID);
563 /** Defines whether Runtime UI status-bar is @a fEnabled. */
564 void setStatusBarEnabled(bool fEnabled, const QUuid &uID);
565
566 /** Returns whether Runtime UI status-bar context-menu is enabled. */
567 bool statusBarContextMenuEnabled(const QUuid &uID);
568 /** Defines whether Runtime UI status-bar context-menu is @a fEnabled. */
569 void setStatusBarContextMenuEnabled(bool fEnabled, const QUuid &uID);
570
571 /** Returns restricted Runtime UI status-bar indicator list. */
572 QList<IndicatorType> restrictedStatusBarIndicators(const QUuid &uID);
573 /** Defines restricted Runtime UI status-bar indicator @a list. */
574 void setRestrictedStatusBarIndicators(const QList<IndicatorType> &list, const QUuid &uID);
575
576 /** Returns Runtime UI status-bar indicator order list. */
577 QList<IndicatorType> statusBarIndicatorOrder(const QUuid &uID);
578 /** Defines Runtime UI status-bar indicator order @a list. */
579 void setStatusBarIndicatorOrder(const QList<IndicatorType> &list, const QUuid &uID);
580
581#ifdef VBOX_WS_MAC
582 /** Mac OS X: Returns whether Dock icon should be updated at runtime. */
583 bool realtimeDockIconUpdateEnabled(const QUuid &uID);
584 /** Mac OS X: Defines whether Dock icon update should be fEnabled at runtime. */
585 void setRealtimeDockIconUpdateEnabled(bool fEnabled, const QUuid &uID);
586
587 /** Mac OS X: Returns guest-screen which Dock icon should reflect at runtime. */
588 int realtimeDockIconUpdateMonitor(const QUuid &uID);
589 /** Mac OS X: Defines guest-screen @a iIndex which Dock icon should reflect at runtime. */
590 void setRealtimeDockIconUpdateMonitor(int iIndex, const QUuid &uID);
591
592 /** Mac OS X: Returns whether Dock icon overlay is disabled. */
593 bool dockIconDisableOverlay(const QUuid &uID);
594 /** Mac OS X: Defines whether Dock icon overlay is @a fDisabled. */
595 void setDockIconDisableOverlay(bool fDisabled, const QUuid &uID);
596#endif /* VBOX_WS_MAC */
597
598 /** Returns whether machine should pass CAD to guest. */
599 bool passCADtoGuest(const QUuid &uID);
600
601 /** Returns the mouse-capture policy. */
602 MouseCapturePolicy mouseCapturePolicy(const QUuid &uID);
603
604 /** Returns redefined guru-meditation handler type. */
605 GuruMeditationHandlerType guruMeditationHandlerType(const QUuid &uID);
606
607 /** Returns whether machine should perform HID LEDs synchronization. */
608 bool hidLedsSyncState(const QUuid &uID);
609
610 /** Returns the scale-factor. */
611 double scaleFactor(const QUuid &uID, const int uScreenIndex);
612 QList<double> scaleFactors(const QUuid &uID);
613 /** Saves the @a dScaleFactor for the monitor with @a uScreenIndex. If the existing scale factor
614 * list (from extra data) does not have scale factors for the screens with ids in [0, uScreenIndex)
615 * the this function appends a default scale factor for said screens.*/
616 void setScaleFactor(double dScaleFactor, const QUuid &uID, const int uScreenIndex);
617 /** Replaces the scale factor list of the machine with @a uID with @a scaleFactors. */
618 void setScaleFactors(const QList<double> &scaleFactors, const QUuid &uID);
619
620 /** Returns the scaling optimization type. */
621 ScalingOptimizationType scalingOptimizationType(const QUuid &uID);
622 /** @} */
623
624 /** @name Virtual Machine: Information dialog
625 * @{ */
626 /** Returns information-window geometry using @a pWidget and @a pParentWidget as hints. */
627 QRect informationWindowGeometry(QWidget *pWidget, QWidget *pParentWidget, const QUuid &uID);
628 /** Returns whether information-window should be maximized or not. */
629 bool informationWindowShouldBeMaximized(const QUuid &uID);
630 /** Defines information-window @a geometry and @a fMaximized state. */
631 void setInformationWindowGeometry(const QRect &geometry, bool fMaximized, const QUuid &uID);
632
633 /** Returns information-window elements. */
634 QMap<InformationElementType, bool> informationWindowElements();
635 /** Defines information-window @a elements. */
636 void setInformationWindowElements(const QMap<InformationElementType, bool> &elements);
637 /** @} */
638
639 /** @name Guest Control related dialogs
640 * @{ */
641 void setGuestControlProcessControlSplitterHints(const QList<int> &hints);
642 QList<int> guestControlProcessControlSplitterHints();
643 QRect fileManagerDialogGeometry(QWidget *pWidget, const QRect &defaultGeometry);
644 bool fileManagerDialogShouldBeMaximized();
645 void setFileManagerDialogGeometry(const QRect &geometry, bool fMaximized);
646 QRect guestProcessControlDialogGeometry(QWidget *pWidget, const QRect &defaultGeometry);
647 bool guestProcessControlDialogShouldBeMaximized();
648 void setGuestProcessControlDialogGeometry(const QRect &geometry, bool fMaximized);
649 void setFileManagerVisiblePanels(const QStringList &panelNameList);
650 QStringList fileManagerVisiblePanels();
651 /** @} */
652
653 /** @name File Manager options
654 * @{ */
655 void setFileManagerOptions(bool fListDirectoriesFirst,
656 bool fShowDeleteConfirmation, bool fshowHumanReadableSizes);
657 bool fileManagerListDirectoriesFirst();
658 bool fileManagerShowDeleteConfirmation();
659 bool fileManagerShowHumanReadableSizes();
660 /** @} */
661
662 /** @name Virtual Machine: Close dialog
663 * @{ */
664 /** Returns default machine close action. */
665 MachineCloseAction defaultMachineCloseAction(const QUuid &uID);
666 /** Returns restricted machine close actions. */
667 MachineCloseAction restrictedMachineCloseActions(const QUuid &uID);
668
669 /** Returns last machine close action. */
670 MachineCloseAction lastMachineCloseAction(const QUuid &uID);
671 /** Defines last @a machineCloseAction. */
672 void setLastMachineCloseAction(MachineCloseAction machineCloseAction, const QUuid &uID);
673
674 /** Returns machine close hook script name as simple string. */
675 QString machineCloseHookScript(const QUuid &uID);
676 /** @} */
677
678#ifdef VBOX_WITH_DEBUGGER_GUI
679 /** @name Virtual Machine: Debug UI
680 * @{ */
681 /** Returns debug flag value for passed @a strDebugFlagKey. */
682 QString debugFlagValue(const QString &strDebugFlagKey);
683 /** @} */
684#endif /* VBOX_WITH_DEBUGGER_GUI */
685
686#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
687 /** @name VirtualBox: Extra-data Manager window
688 * @{ */
689 /** Returns Extra-data Manager geometry using @a pWidget as hint. */
690 QRect extraDataManagerGeometry(QWidget *pWidget);
691 /** Returns whether Extra-data Manager should be maximized or not. */
692 bool extraDataManagerShouldBeMaximized();
693 /** Defines Extra-data Manager @a geometry and @a fMaximized state. */
694 void setExtraDataManagerGeometry(const QRect &geometry, bool fMaximized);
695
696 /** Returns Extra-data Manager splitter hints using @a pWidget as hint. */
697 QList<int> extraDataManagerSplitterHints(QWidget *pWidget);
698 /** Defines Extra-data Manager splitter @a hints. */
699 void setExtraDataManagerSplitterHints(const QList<int> &hints);
700 /** @} */
701#endif /* VBOX_GUI_WITH_EXTRADATA_MANAGER_UI */
702
703 /** @name Virtual Machine: Log Viewer dialog
704 * @{ */
705 /** Returns log-window geometry using @a pWidget and @a defaultGeometry as hints. */
706 QRect logWindowGeometry(QWidget *pWidget, const QRect &defaultGeometry);
707 /** Returns whether log-window should be maximized or not. */
708 bool logWindowShouldBeMaximized();
709 /** Defines log-window @a geometry and @a fMaximized state. */
710 void setLogWindowGeometry(const QRect &geometry, bool fMaximized);
711 /** @} */
712
713 /** @name Virtual Machine: Log Viewer widget options
714 * @{ */
715 void setLogViweverOptions(const QFont &font, bool wrapLines, bool showLineNumbers);
716 /** Returns log-viewer line wrapping flag. */
717 bool logViewerWrapLines();
718 /** Returns log-viewer show line numbers flag. */
719 bool logViewerShowLineNumbers();
720 /** Tries to find system font by searching by family and style strings within the font database. */
721 QFont logViewerFont();
722 /** @} */
723
724private slots:
725
726 /** Handles 'extra-data change' event: */
727 void sltExtraDataChange(const QUuid &uMachineID, const QString &strKey, const QString &strValue);
728
729private:
730
731 /** Prepare Extra-data Manager. */
732 void prepare();
733 /** Prepare global extra-data map. */
734 void prepareGlobalExtraDataMap();
735 /** Prepare extra-data event-handler. */
736 void prepareExtraDataEventHandler();
737#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
738 // /** Prepare window. */
739 // void prepareWindow();
740
741 /** Cleanup window. */
742 void cleanupWindow();
743#endif /* VBOX_GUI_WITH_EXTRADATA_MANAGER_UI */
744 /** Cleanup extra-data event-handler. */
745 void cleanupExtraDataEventHandler();
746 // /** Cleanup extra-data map. */
747 // void cleanupExtraDataMap();
748 /** Cleanup Extra-data Manager. */
749 void cleanup();
750
751#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
752 /** Open window. */
753 void open(QWidget *pCenterWidget);
754#endif
755
756 /** Retrieves an extra-data key from both machine and global sources.
757 *
758 * If @a uID isn't #GlobalID, this will first check the extra-data associated
759 * with the machine given by @a uID then fallback on the global extra-data.
760 *
761 * @returns String value if found, null string if not.
762 * @param strKey The extra-data key to get.
763 * @param uID Machine UUID or #GlobalID.
764 * @param strValue Where to return the value when found. */
765 QString extraDataStringUnion(const QString &strKey, const QUuid &uID);
766 /** Determines whether feature corresponding to passed @a strKey is allowed.
767 * If valid @a uID is set => applies to machine and global extra-data,
768 * otherwise => only to global one. */
769 bool isFeatureAllowed(const QString &strKey, const QUuid &uID = GlobalID);
770 /** Determines whether feature corresponding to passed @a strKey is restricted.
771 * If valid @a uID is set => applies to machine and global extra-data,
772 * otherwise => only to global one. */
773 bool isFeatureRestricted(const QString &strKey, const QUuid &uID = GlobalID);
774
775 /** Translates bool flag into QString value. */
776 QString toFeatureState(bool fState);
777 /** Translates bool flag into 'allowed' value. */
778 QString toFeatureAllowed(bool fAllowed);
779 /** Translates bool flag into 'restricted' value. */
780 QString toFeatureRestricted(bool fRestricted);
781
782 QRect dialogGeometry(const QString &strKey, QWidget *pWidget, const QRect &defaultGeometry);
783 void setDialogGeometry(const QString &strKey, const QRect &geometry, bool fMaximized);
784
785 /** Returns string consisting of @a strBase appended with @a uScreenIndex for the *non-primary* screen-index.
786 * If @a fSameRuleForPrimary is 'true' same rule will be used for *primary* screen-index. Used for storing per-screen extra-data. */
787 static QString extraDataKeyPerScreen(const QString &strBase, ulong uScreenIndex, bool fSameRuleForPrimary = false);
788
789 /** Holds the singleton instance. */
790 static UIExtraDataManager *s_pInstance;
791
792 /** Holds extra-data event-handler instance. */
793 UIExtraDataEventHandler *m_pHandler;
794
795 /** Holds extra-data map instance. */
796 MapOfExtraDataMaps m_data;
797
798#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
799 /** Holds Extra-data Manager window instance. */
800 QPointer<UIExtraDataManagerWindow> m_pWindow;
801#endif
802};
803
804/** Singleton Extra-data Manager 'official' name. */
805#define gEDataManager UIExtraDataManager::instance()
806
807#endif /* !FEQT_INCLUDED_SRC_extradata_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