UIExtraDataManager.h@ 84990

Last change on this file since 84990 was 84990, checked in by vboxsync, 5 years ago
FE/Qt: bugref:9774: Runtime UI: Handling for Visual State change coming from extra-data.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 40.9 KB

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: