UIExtraDataManager.h@ 81357

Last change on this file since 81357 was 81357, checked in by vboxsync, 5 years ago
FE/Qt: UIExtraDataManager: Syncing geometry restore logic between VirtualBox Manager, Extra-data Manager, Session Information dialog and Log Viewer.
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 81357 2019-10-18 14:13:59Z 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: */
37	class UIExtraDataEventHandler;
38	#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
39	class UIExtraDataManagerWindow;
40	#endif
41
42	/** Defines the map of extra data values. The index is an extra-data key. */
43	typedef QMap<QString, QString> ExtraDataMap;
44	/** Defines the map of extra data maps. */
45	typedef 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. */
50	class 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
59	signals:
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
106	public:
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	/** Defines recent folder for hard-drives as @a strValue. */
272	void setRecentFolderForHardDrives(const QString &strValue);
273	/** Defines recent folder for optical-disk as @a strValue. */
274	void setRecentFolderForOpticalDisks(const QString &strValue);
275	/** Defines recent folder for floppy-disk as @a strValue. */
276	void setRecentFolderForFloppyDisks(const QString &strValue);
277
278	/** Returns the list of recently used hard-drives. */
279	QStringList recentListOfHardDrives();
280	/** Returns the list of recently used optical-disk. */
281	QStringList recentListOfOpticalDisks();
282	/** Returns the list of recently used floppy-disk. */
283	QStringList recentListOfFloppyDisks();
284	/** Defines the list of recently used hard-drives as @a value. */
285	void setRecentListOfHardDrives(const QStringList &value);
286	/** Defines the list of recently used optical-disks as @a value. */
287	void setRecentListOfOpticalDisks(const QStringList &value);
288	/** Defines the list of recently used floppy-disks as @a value. */
289	void setRecentListOfFloppyDisks(const QStringList &value);
290	/** @} */
291
292	/** @name Settings: Network
293	* @{ */
294	/** Returns the list of restricted network attachment types. */
295	UIExtraDataMetaDefs::DetailsElementOptionTypeNetwork restrictedNetworkAttachmentTypes();
296	/** @} */
297
298	/** @name VISO Creator
299	* @{ */
300	/** Returns recent folder for VISO creation content. */
301	QString visoCreatorRecentFolder();
302	/** Defines recent folder for VISO creation content as @a strValue. */
303	void setVISOCreatorRecentFolder(const QString &strValue);
304	/** @} */
305
306	/** @name VirtualBox Manager
307	* @{ */
308	/** Returns selector-window geometry using @a pWidget as the hint. */
309	QRect selectorWindowGeometry(QWidget *pWidget);
310	/** Returns whether selector-window should be maximized. */
311	bool selectorWindowShouldBeMaximized();
312	/** Defines selector-window @a geometry and @a fMaximized state. */
313	void setSelectorWindowGeometry(const QRect &geometry, bool fMaximized);
314
315	/** Returns selector-window splitter hints. */
316	QList<int> selectorWindowSplitterHints();
317	/** Defines selector-window splitter @a hints. */
318	void setSelectorWindowSplitterHints(const QList<int> &hints);
319
320	/** Returns whether selector-window tool-bar visible. */
321	bool selectorWindowToolBarVisible();
322	/** Defines whether selector-window tool-bar @a fVisible. */
323	void setSelectorWindowToolBarVisible(bool fVisible);
324
325	/** Returns whether selector-window tool-bar text visible. */
326	bool selectorWindowToolBarTextVisible();
327	/** Defines whether selector-window tool-bar text @a fVisible. */
328	void setSelectorWindowToolBarTextVisible(bool fVisible);
329
330	/** Returns last selected tool set of VirtualBox Manager. */
331	QList<UIToolType> toolsPaneLastItemsChosen();
332	/** Defines last selected tool @a set of VirtualBox Manager. */
333	void setToolsPaneLastItemsChosen(const QList<UIToolType> &set);
334
335	/** Returns whether selector-window status-bar visible. */
336	bool selectorWindowStatusBarVisible();
337	/** Defines whether selector-window status-bar @a fVisible. */
338	void setSelectorWindowStatusBarVisible(bool fVisible);
339
340	/** Clears all the existing selector-window chooser-pane' group definitions. */
341	void clearSelectorWindowGroupsDefinitions();
342	/** Returns selector-window chooser-pane' groups definitions for passed @a strGroupID. */
343	QStringList selectorWindowGroupsDefinitions(const QString &strGroupID);
344	/** Defines selector-window chooser-pane' groups @a definitions for passed @a strGroupID. */
345	void setSelectorWindowGroupsDefinitions(const QString &strGroupID, const QStringList &definitions);
346
347	/** Returns last-item ID of the item chosen in selector-window chooser-pane. */
348	QString selectorWindowLastItemChosen();
349	/** Defines @a lastItemID of the item chosen in selector-window chooser-pane. */
350	void setSelectorWindowLastItemChosen(const QString &strItemID);
351
352	/** Returns selector-window details-pane' elements. */
353	QMap<DetailsElementType, bool> selectorWindowDetailsElements();
354	/** Defines selector-window details-pane' @a elements. */
355	void setSelectorWindowDetailsElements(const QMap<DetailsElementType, bool> &elements);
356
357	/** Returns selector-window details-pane' preview update interval. */
358	PreviewUpdateIntervalType selectorWindowPreviewUpdateInterval();
359	/** Defines selector-window details-pane' preview update @a interval. */
360	void setSelectorWindowPreviewUpdateInterval(PreviewUpdateIntervalType interval);
361
362	/** Returns VirtualBox Manager / Details pane options for certain @a enmElementType. */
363	QStringList vboxManagerDetailsPaneElementOptions(DetailsElementType enmElementType);
364	/** Defines VirtualBox Manager / Details pane @a options for certain @a enmElementType. */
365	void setVBoxManagerDetailsPaneElementOptions(DetailsElementType enmElementType, const QStringList &options);
366	/** @} */
367
368	/** @name Snapshot Manager
369	* @{ */
370	/** Returns whether Snapshot Manager details expanded. */
371	bool snapshotManagerDetailsExpanded();
372	/** Defines whether Snapshot Manager details @a fExpanded. */
373	void setSnapshotManagerDetailsExpanded(bool fExpanded);
374	/** @} */
375
376	/** @name Virtual Media Manager
377	* @{ */
378	/** Returns whether Virtual Media Manager details expanded. */
379	bool virtualMediaManagerDetailsExpanded();
380	/** Defines whether Virtual Media Manager details @a fExpanded. */
381	void setVirtualMediaManagerDetailsExpanded(bool fExpanded);
382	/** Returns whether Virtual Media Manager search widget expanded. */
383	bool virtualMediaManagerSearchWidgetExpanded();
384	/** Defines whether Virtual Media Manager search widget @a fExpanded. */
385	void setVirtualMediaManagerSearchWidgetExpanded(bool fExpanded);
386	/** @} */
387
388	/** @name Host Network Manager
389	* @{ */
390	/** Returns whether Host Network Manager details expanded. */
391	bool hostNetworkManagerDetailsExpanded();
392	/** Defines whether Host Network Manager details @a fExpanded. */
393	void setHostNetworkManagerDetailsExpanded(bool fExpanded);
394	/** @} */
395
396	/** @name Cloud Profile Manager
397	* @{ */
398	/** Returns whether Cloud Profile Manager details expanded. */
399	bool cloudProfileManagerDetailsExpanded();
400	/** Defines whether Cloud Profile Manager details @a fExpanded. */
401	void setCloudProfileManagerDetailsExpanded(bool fExpanded);
402	/** @} */
403
404	/** @name Wizards
405	* @{ */
406	/** Returns mode for wizard of passed @a type. */
407	WizardMode modeForWizardType(WizardType type);
408	/** Defines @a mode for wizard of passed @a type. */
409	void setModeForWizardType(WizardType type, WizardMode mode);
410	/** @} */
411
412	/** @name Virtual Machine
413	* @{ */
414	/** Returns whether machine should be shown in VirtualBox Manager Chooser-pane. */
415	bool showMachineInVirtualBoxManagerChooser(const QUuid &uID);
416	/** Returns whether machine should be shown in VirtualBox Manager Details-pane. */
417	bool showMachineInVirtualBoxManagerDetails(const QUuid &uID);
418
419	/** Returns whether machine reconfiguration enabled. */
420	bool machineReconfigurationEnabled(const QUuid &uID);
421	/** Returns whether machine snapshot operations enabled. */
422	bool machineSnapshotOperationsEnabled(const QUuid &uID);
423
424	/** Returns whether this machine is first time started. */
425	bool machineFirstTimeStarted(const QUuid &uID);
426	/** Returns whether this machine is fFirstTimeStarted. */
427	void setMachineFirstTimeStarted(bool fFirstTimeStarted, const QUuid &uID);
428
429	/** Except Mac OS X: Returns redefined machine-window icon names. */
430	QStringList machineWindowIconNames(const QUuid &uID);
431	#ifndef VBOX_WS_MAC
432	/** Except Mac OS X: Returns redefined machine-window name postfix. */
433	QString machineWindowNamePostfix(const QUuid &uID);
434	#endif
435
436	/** Returns geometry for machine-window with @a uScreenIndex in @a visualStateType. */
437	QRect machineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QUuid &uID);
438	/** Returns whether machine-window with @a uScreenIndex in @a visualStateType should be maximized. */
439	bool machineWindowShouldBeMaximized(UIVisualStateType visualStateType, ulong uScreenIndex, const QUuid &uID);
440	/** Defines @a geometry and @a fMaximized state for machine-window with @a uScreenIndex in @a visualStateType. */
441	void setMachineWindowGeometry(UIVisualStateType visualStateType, ulong uScreenIndex, const QRect &geometry, bool fMaximized, const QUuid &uID);
442
443	#ifndef VBOX_WS_MAC
444	/** Returns whether Runtime UI menu-bar is enabled. */
445	bool menuBarEnabled(const QUuid &uID);
446	/** Defines whether Runtime UI menu-bar is @a fEnabled. */
447	void setMenuBarEnabled(bool fEnabled, const QUuid &uID);
448	#endif /* !VBOX_WS_MAC */
449
450	/** Returns whether Runtime UI menu-bar context-menu is enabled. */
451	bool menuBarContextMenuEnabled(const QUuid &uID);
452	/** Defines whether Runtime UI menu-bar context-menu is @a fEnabled. */
453	void setMenuBarContextMenuEnabled(bool fEnabled, const QUuid &uID);
454
455	/** Returns restricted Runtime UI menu types. */
456	UIExtraDataMetaDefs::MenuType restrictedRuntimeMenuTypes(const QUuid &uID);
457	/** Defines restricted Runtime UI menu types. */
458	void setRestrictedRuntimeMenuTypes(UIExtraDataMetaDefs::MenuType types, const QUuid &uID);
459
460	/** Returns restricted Runtime UI action types for Application menu. */
461	UIExtraDataMetaDefs::MenuApplicationActionType restrictedRuntimeMenuApplicationActionTypes(const QUuid &uID);
462	/** Defines restricted Runtime UI action types for Application menu. */
463	void setRestrictedRuntimeMenuApplicationActionTypes(UIExtraDataMetaDefs::MenuApplicationActionType types, const QUuid &uID);
464
465	/** Returns restricted Runtime UI action types for Machine menu. */
466	UIExtraDataMetaDefs::RuntimeMenuMachineActionType restrictedRuntimeMenuMachineActionTypes(const QUuid &uID);
467	/** Defines restricted Runtime UI action types for Machine menu. */
468	void setRestrictedRuntimeMenuMachineActionTypes(UIExtraDataMetaDefs::RuntimeMenuMachineActionType types, const QUuid &uID);
469
470	/** Returns restricted Runtime UI action types for View menu. */
471	UIExtraDataMetaDefs::RuntimeMenuViewActionType restrictedRuntimeMenuViewActionTypes(const QUuid &uID);
472	/** Defines restricted Runtime UI action types for View menu. */
473	void setRestrictedRuntimeMenuViewActionTypes(UIExtraDataMetaDefs::RuntimeMenuViewActionType types, const QUuid &uID);
474
475	/** Returns restricted Runtime UI action types for Input menu. */
476	UIExtraDataMetaDefs::RuntimeMenuInputActionType restrictedRuntimeMenuInputActionTypes(const QUuid &uID);
477	/** Defines restricted Runtime UI action types for Input menu. */
478	void setRestrictedRuntimeMenuInputActionTypes(UIExtraDataMetaDefs::RuntimeMenuInputActionType types, const QUuid &uID);
479
480	/** Returns restricted Runtime UI action types for Devices menu. */
481	UIExtraDataMetaDefs::RuntimeMenuDevicesActionType restrictedRuntimeMenuDevicesActionTypes(const QUuid &uID);
482	/** Defines restricted Runtime UI action types for Devices menu. */
483	void setRestrictedRuntimeMenuDevicesActionTypes(UIExtraDataMetaDefs::RuntimeMenuDevicesActionType types, const QUuid &uID);
484
485	#ifdef VBOX_WITH_DEBUGGER_GUI
486	/** Returns restricted Runtime UI action types for Debugger menu. */
487	UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType restrictedRuntimeMenuDebuggerActionTypes(const QUuid &uID);
488	/** Defines restricted Runtime UI action types for Debugger menu. */
489	void setRestrictedRuntimeMenuDebuggerActionTypes(UIExtraDataMetaDefs::RuntimeMenuDebuggerActionType types, const QUuid &uID);
490	#endif /* VBOX_WITH_DEBUGGER_GUI */
491
492	#ifdef VBOX_WS_MAC
493	/** Mac OS X: Returns restricted Runtime UI action types for Window menu. */
494	UIExtraDataMetaDefs::MenuWindowActionType restrictedRuntimeMenuWindowActionTypes(const QUuid &uID);
495	/** Mac OS X: Defines restricted Runtime UI action types for Window menu. */
496	void setRestrictedRuntimeMenuWindowActionTypes(UIExtraDataMetaDefs::MenuWindowActionType types, const QUuid &uID);
497	#endif /* VBOX_WS_MAC */
498
499	/** Returns restricted Runtime UI action types for Help menu. */
500	UIExtraDataMetaDefs::MenuHelpActionType restrictedRuntimeMenuHelpActionTypes(const QUuid &uID);
501	/** Defines restricted Runtime UI action types for Help menu. */
502	void setRestrictedRuntimeMenuHelpActionTypes(UIExtraDataMetaDefs::MenuHelpActionType types, const QUuid &uID);
503
504	/** Returns restricted Runtime UI visual-states. */
505	UIVisualStateType restrictedVisualStates(const QUuid &uID);
506
507	/** Returns requested Runtime UI visual-state. */
508	UIVisualStateType requestedVisualState(const QUuid &uID);
509	/** Defines requested Runtime UI visual-state as @a visualState. */
510	void setRequestedVisualState(UIVisualStateType visualState, const QUuid &uID);
511
512	#ifdef VBOX_WS_X11
513	/** Returns whether legacy full-screen mode is requested. */
514	bool legacyFullscreenModeRequested();
515
516	/** Returns whether internal machine-window name should be unique. */
517	bool distinguishMachineWindowGroups(const QUuid &uID);
518	/** Defines whether internal machine-window name should be unique. */
519	void setDistinguishMachineWindowGroups(const QUuid &uID, bool fEnabled);
520	#endif /* VBOX_WS_X11 */
521
522	/** Returns whether guest-screen auto-resize according machine-window size is enabled. */
523	bool guestScreenAutoResizeEnabled(const QUuid &uID);
524	/** Defines whether guest-screen auto-resize according machine-window size is @a fEnabled. */
525	void setGuestScreenAutoResizeEnabled(bool fEnabled, const QUuid &uID);
526
527	/** Returns last guest-screen visibility status for screen with @a uScreenIndex. */
528	bool lastGuestScreenVisibilityStatus(ulong uScreenIndex, const QUuid &uID);
529	/** Defines whether last guest-screen visibility status was @a fEnabled for screen with @a uScreenIndex. */
530	void setLastGuestScreenVisibilityStatus(ulong uScreenIndex, bool fEnabled, const QUuid &uID);
531
532	/** Returns last guest-screen size-hint for screen with @a uScreenIndex. */
533	QSize lastGuestScreenSizeHint(ulong uScreenIndex, const QUuid &uID);
534	/** Defines last guest-screen @a sizeHint for screen with @a uScreenIndex. */
535	void setLastGuestScreenSizeHint(ulong uScreenIndex, const QSize &sizeHint, const QUuid &uID);
536
537	/** Returns host-screen index corresponding to passed guest-screen @a iGuestScreenIndex. */
538	int hostScreenForPassedGuestScreen(int iGuestScreenIndex, const QUuid &uID);
539	/** Defines @a iHostScreenIndex corresponding to passed guest-screen @a iGuestScreenIndex. */
540	void setHostScreenForPassedGuestScreen(int iGuestScreenIndex, int iHostScreenIndex, const QUuid &uID);
541
542	/** Returns whether automatic mounting/unmounting of guest-screens enabled. */
543	bool autoMountGuestScreensEnabled(const QUuid &uID);
544
545	#ifdef VBOX_WITH_VIDEOHWACCEL
546	/** Returns whether 2D acceleration should use linear sretch. */
547	bool useLinearStretch(const QUuid &uID);
548	/** Returns whether 2D acceleration should use YV12 pixel format. */
549	bool usePixelFormatYV12(const QUuid &uID);
550	/** Returns whether 2D acceleration should use UYVY pixel format. */
551	bool usePixelFormatUYVY(const QUuid &uID);
552	/** Returns whether 2D acceleration should use YUY2 pixel format. */
553	bool usePixelFormatYUY2(const QUuid &uID);
554	/** Returns whether 2D acceleration should use AYUV pixel format. */
555	bool usePixelFormatAYUV(const QUuid &uID);
556	#endif /* VBOX_WITH_VIDEOHWACCEL */
557
558	#ifndef VBOX_WS_MAC
559	/** Returns whether mini-toolbar is enabled for full and seamless screens. */
560	bool miniToolbarEnabled(const QUuid &uID);
561	/** Defines whether mini-toolbar is @a fEnabled for full and seamless screens. */
562	void setMiniToolbarEnabled(bool fEnabled, const QUuid &uID);
563
564	/** Returns whether mini-toolbar should auto-hide itself. */
565	bool autoHideMiniToolbar(const QUuid &uID);
566	/** Defines whether mini-toolbar should @a fAutoHide itself. */
567	void setAutoHideMiniToolbar(bool fAutoHide, const QUuid &uID);
568
569	/** Returns mini-toolbar alignment. */
570	Qt::AlignmentFlag miniToolbarAlignment(const QUuid &uID);
571	/** Returns mini-toolbar @a alignment. */
572	void setMiniToolbarAlignment(Qt::AlignmentFlag alignment, const QUuid &uID);
573	#endif /* VBOX_WS_MAC */
574
575	/** Returns whether Runtime UI status-bar is enabled. */
576	bool statusBarEnabled(const QUuid &uID);
577	/** Defines whether Runtime UI status-bar is @a fEnabled. */
578	void setStatusBarEnabled(bool fEnabled, const QUuid &uID);
579
580	/** Returns whether Runtime UI status-bar context-menu is enabled. */
581	bool statusBarContextMenuEnabled(const QUuid &uID);
582	/** Defines whether Runtime UI status-bar context-menu is @a fEnabled. */
583	void setStatusBarContextMenuEnabled(bool fEnabled, const QUuid &uID);
584
585	/** Returns restricted Runtime UI status-bar indicator list. */
586	QList<IndicatorType> restrictedStatusBarIndicators(const QUuid &uID);
587	/** Defines restricted Runtime UI status-bar indicator @a list. */
588	void setRestrictedStatusBarIndicators(const QList<IndicatorType> &list, const QUuid &uID);
589
590	/** Returns Runtime UI status-bar indicator order list. */
591	QList<IndicatorType> statusBarIndicatorOrder(const QUuid &uID);
592	/** Defines Runtime UI status-bar indicator order @a list. */
593	void setStatusBarIndicatorOrder(const QList<IndicatorType> &list, const QUuid &uID);
594
595	#ifdef VBOX_WS_MAC
596	/** Mac OS X: Returns whether Dock icon should be updated at runtime. */
597	bool realtimeDockIconUpdateEnabled(const QUuid &uID);
598	/** Mac OS X: Defines whether Dock icon update should be fEnabled at runtime. */
599	void setRealtimeDockIconUpdateEnabled(bool fEnabled, const QUuid &uID);
600
601	/** Mac OS X: Returns guest-screen which Dock icon should reflect at runtime. */
602	int realtimeDockIconUpdateMonitor(const QUuid &uID);
603	/** Mac OS X: Defines guest-screen @a iIndex which Dock icon should reflect at runtime. */
604	void setRealtimeDockIconUpdateMonitor(int iIndex, const QUuid &uID);
605
606	/** Mac OS X: Returns whether Dock icon overlay is disabled. */
607	bool dockIconDisableOverlay(const QUuid &uID);
608	/** Mac OS X: Defines whether Dock icon overlay is @a fDisabled. */
609	void setDockIconDisableOverlay(bool fDisabled, const QUuid &uID);
610	#endif /* VBOX_WS_MAC */
611
612	/** Returns whether machine should pass CAD to guest. */
613	bool passCADtoGuest(const QUuid &uID);
614
615	/** Returns the mouse-capture policy. */
616	MouseCapturePolicy mouseCapturePolicy(const QUuid &uID);
617
618	/** Returns redefined guru-meditation handler type. */
619	GuruMeditationHandlerType guruMeditationHandlerType(const QUuid &uID);
620
621	/** Returns whether machine should perform HID LEDs synchronization. */
622	bool hidLedsSyncState(const QUuid &uID);
623
624	/** Returns the scale-factor. */
625	double scaleFactor(const QUuid &uID, const int uScreenIndex);
626	QList<double> scaleFactors(const QUuid &uID);
627	/** Saves the @a dScaleFactor for the monitor with @a uScreenIndex. If the existing scale factor
628	* list (from extra data) does not have scale factors for the screens with ids in [0, uScreenIndex)
629	* the this function appends a default scale factor for said screens.*/
630	void setScaleFactor(double dScaleFactor, const QUuid &uID, const int uScreenIndex);
631	/** Replaces the scale factor list of the machine with @a uID with @a scaleFactors. */
632	void setScaleFactors(const QList<double> &scaleFactors, const QUuid &uID);
633
634	/** Returns the scaling optimization type. */
635	ScalingOptimizationType scalingOptimizationType(const QUuid &uID);
636	/** @} */
637
638	/** @name Virtual Machine: Session Information dialog
639	* @{ */
640	/** Returns session information dialog geometry using @a pWidget and @a pParentWidget as hints. */
641	QRect sessionInformationDialogGeometry(QWidget pWidget, QWidget pParentWidget);
642	/** Returns whether information-window should be maximized or not. */
643	bool sessionInformationDialogShouldBeMaximized();
644	/** Defines information-window @a geometry and @a fMaximized state. */
645	void setSessionInformationDialogGeometry(const QRect &geometry, bool fMaximized);
646	/** @} */
647
648	/** @name Guest Control related dialogs
649	* @{ */
650	void setGuestControlProcessControlSplitterHints(const QList<int> &hints);
651	QList<int> guestControlProcessControlSplitterHints();
652	QRect fileManagerDialogGeometry(QWidget *pWidget, const QRect &defaultGeometry);
653	bool fileManagerDialogShouldBeMaximized();
654	void setFileManagerDialogGeometry(const QRect &geometry, bool fMaximized);
655	QRect guestProcessControlDialogGeometry(QWidget *pWidget, const QRect &defaultGeometry);
656	bool guestProcessControlDialogShouldBeMaximized();
657	void setGuestProcessControlDialogGeometry(const QRect &geometry, bool fMaximized);
658	void setFileManagerVisiblePanels(const QStringList &panelNameList);
659	QStringList fileManagerVisiblePanels();
660	/** @} */
661
662	/** @name Soft Keyboard
663	* @{ */
664	QRect softKeyboardDialogGeometry(QWidget *pWidget, const QRect &defaultGeometry);
665	void setSoftKeyboardDialogGeometry(const QRect &geometry, bool fMaximized);
666	bool softKeyboardDialogShouldBeMaximized();
667	void setSoftKeyboardOptions(bool fShowNumPad, bool fHideOSMenuKeys, bool fMultimediaKeys);
668	void softKeyboardOptions(bool &fOutShowNumPad, bool &fOutHideOSMenuKeys, bool &fOutHideMultimediaKeys);
669	void setSoftKeyboardColorTheme(const QStringList &colorStringList);
670	QStringList softKeyboardColorTheme();
671	void setSoftKeyboardSelectedColorTheme(const QString &strColorThemeName);
672	QString softKeyboardSelectedColorTheme();
673	void setSoftKeyboardSelectedLayout(const QUuid &uLayoutUid);
674	QUuid softKeyboardSelectedLayout();
675	/** @} */
676
677	/** @name File Manager options
678	* @{ */
679	void setFileManagerOptions(bool fListDirectoriesFirst,
680	bool fShowDeleteConfirmation,
681	bool fshowHumanReadableSizes,
682	bool fShowHiddenObjects);
683	bool fileManagerListDirectoriesFirst();
684	bool fileManagerShowDeleteConfirmation();
685	bool fileManagerShowHumanReadableSizes();
686	bool fileManagerShowHiddenObjects();
687	/** @} */
688
689	/** @name Virtual Machine: Close dialog
690	* @{ */
691	/** Returns default machine close action. */
692	MachineCloseAction defaultMachineCloseAction(const QUuid &uID);
693	/** Returns restricted machine close actions. */
694	MachineCloseAction restrictedMachineCloseActions(const QUuid &uID);
695
696	/** Returns last machine close action. */
697	MachineCloseAction lastMachineCloseAction(const QUuid &uID);
698	/** Defines last @a machineCloseAction. */
699	void setLastMachineCloseAction(MachineCloseAction machineCloseAction, const QUuid &uID);
700
701	/** Returns machine close hook script name as simple string. */
702	QString machineCloseHookScript(const QUuid &uID);
703	/** @} */
704
705	#ifdef VBOX_WITH_DEBUGGER_GUI
706	/** @name Virtual Machine: Debug UI
707	* @{ */
708	/** Returns debug flag value for passed @a strDebugFlagKey. */
709	QString debugFlagValue(const QString &strDebugFlagKey);
710	/** @} */
711	#endif /* VBOX_WITH_DEBUGGER_GUI */
712
713	#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
714	/** @name VirtualBox: Extra-data Manager window
715	* @{ */
716	/** Returns Extra-data Manager geometry using @a pWidget and @a pParentWidget as hint. */
717	QRect extraDataManagerGeometry(QWidget pWidget, QWidget pParentWidget);
718	/** Returns whether Extra-data Manager should be maximized or not. */
719	bool extraDataManagerShouldBeMaximized();
720	/** Defines Extra-data Manager @a geometry and @a fMaximized state. */
721	void setExtraDataManagerGeometry(const QRect &geometry, bool fMaximized);
722
723	/** Returns Extra-data Manager splitter hints using @a pWidget as hint. */
724	QList<int> extraDataManagerSplitterHints(QWidget *pWidget);
725	/** Defines Extra-data Manager splitter @a hints. */
726	void setExtraDataManagerSplitterHints(const QList<int> &hints);
727	/** @} */
728	#endif /* VBOX_GUI_WITH_EXTRADATA_MANAGER_UI */
729
730	/** @name Virtual Machine: Log Viewer dialog
731	* @{ */
732	/** Returns log-window geometry using @a pWidget, @a pParentWidget and @a defaultGeometry as hints. */
733	QRect logWindowGeometry(QWidget pWidget, QWidget pParentWidget, const QRect &defaultGeometry);
734	/** Returns whether log-window should be maximized or not. */
735	bool logWindowShouldBeMaximized();
736	/** Defines log-window @a geometry and @a fMaximized state. */
737	void setLogWindowGeometry(const QRect &geometry, bool fMaximized);
738	/** @} */
739
740	/** @name Virtual Machine: Log Viewer widget options
741	* @{ */
742	void setLogViweverOptions(const QFont &font, bool wrapLines, bool showLineNumbers);
743	/** Returns log-viewer line wrapping flag. */
744	bool logViewerWrapLines();
745	/** Returns log-viewer show line numbers flag. */
746	bool logViewerShowLineNumbers();
747	/** Tries to find system font by searching by family and style strings within the font database. */
748	QFont logViewerFont();
749	void setLogViewerVisiblePanels(const QStringList &panelNameList);
750	QStringList logViewerVisiblePanels();
751	/** @} */
752
753	private slots:
754
755	/** Handles 'extra-data change' event: */
756	void sltExtraDataChange(const QUuid &uMachineID, const QString &strKey, const QString &strValue);
757
758	private:
759
760	/** Prepare Extra-data Manager. */
761	void prepare();
762	/** Prepare global extra-data map. */
763	void prepareGlobalExtraDataMap();
764	/** Prepare extra-data event-handler. */
765	void prepareExtraDataEventHandler();
766	#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
767	// /** Prepare window. */
768	// void prepareWindow();
769
770	/** Cleanup window. */
771	void cleanupWindow();
772	#endif /* VBOX_GUI_WITH_EXTRADATA_MANAGER_UI */
773	/** Cleanup extra-data event-handler. */
774	void cleanupExtraDataEventHandler();
775	// /** Cleanup extra-data map. */
776	// void cleanupExtraDataMap();
777	/** Cleanup Extra-data Manager. */
778	void cleanup();
779
780	#ifdef VBOX_GUI_WITH_EXTRADATA_MANAGER_UI
781	/** Open window. */
782	void open(QWidget *pCenterWidget);
783	#endif
784
785	/** Retrieves an extra-data key from both machine and global sources.
786	*
787	* If @a uID isn't #GlobalID, this will first check the extra-data associated
788	* with the machine given by @a uID then fallback on the global extra-data.
789	*
790	* @returns String value if found, null string if not.
791	* @param strKey The extra-data key to get.
792	* @param uID Machine UUID or #GlobalID.
793	* @param strValue Where to return the value when found. */
794	QString extraDataStringUnion(const QString &strKey, const QUuid &uID);
795	/** Determines whether feature corresponding to passed @a strKey is allowed.
796	* If valid @a uID is set => applies to machine and global extra-data,
797	* otherwise => only to global one. */
798	bool isFeatureAllowed(const QString &strKey, const QUuid &uID = GlobalID);
799	/** Determines whether feature corresponding to passed @a strKey is restricted.
800	* If valid @a uID is set => applies to machine and global extra-data,
801	* otherwise => only to global one. */
802	bool isFeatureRestricted(const QString &strKey, const QUuid &uID = GlobalID);
803
804	/** Translates bool flag into QString value. */
805	QString toFeatureState(bool fState);
806	/** Translates bool flag into 'allowed' value. */
807	QString toFeatureAllowed(bool fAllowed);
808	/** Translates bool flag into 'restricted' value. */
809	QString toFeatureRestricted(bool fRestricted);
810
811	/** Defines saved dialog geometry according to specified attributes.
812	* @param strKey Brings geometry extra-data key of particular dialog.
813	* @param geometry Brings the dialog geometry to save.
814	* @param fMaximized Brings whether saved dialog geometry should be marked as maximized. */
815	void setDialogGeometry(const QString &strKey, const QRect &geometry, bool fMaximized);
816	/** Returns saved dialog geometry according to specified attributes.
817	* @param strKey Brings geometry extra-data key of particular dialog.
818	* @param pWidget Brings the widget to limit geometry bounds 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, const QRect &defaultGeometry);
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@ 81357

Download in other formats: