UIExtraDataManager.h@ 84790

Last change on this file since 84790 was 84790, checked in by vboxsync, 5 years ago
FE/Qt, Main/Helpers: Get rid of 2D Video Acceleration code.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 40.8 KB

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

Download in other formats: