1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/* $Id: QIManagerDialog.h $ */
/** @file
* VBox Qt GUI - Qt extensions: QIManagerDialog class declaration.
*/
/*
* Copyright (C) 2009-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef FEQT_INCLUDED_SRC_extensions_QIManagerDialog_h
#define FEQT_INCLUDED_SRC_extensions_QIManagerDialog_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* Qt includes: */
#include <QMainWindow>
#include <QMap>
/* GUI includes: */
#include "QIWithRestorableGeometry.h"
#include "UILibraryDefs.h"
/* Other VBox includes: */
#include <iprt/cdefs.h>
/* Forward declarations: */
class QPushButton;
class QIDialogButtonBox;
class QIManagerDialog;
#ifdef VBOX_WS_MAC
class QIToolBar;
#endif
/** Widget embedding type. */
enum EmbedTo
{
EmbedTo_Dialog,
EmbedTo_Stack
};
/** Dialog button types. */
enum ButtonType
{
ButtonType_Invalid = 0,
ButtonType_Reset = RT_BIT(0),
ButtonType_Apply = RT_BIT(1),
ButtonType_Close = RT_BIT(2),
ButtonType_Help = RT_BIT(3)
};
/** Manager dialog factory insterface. */
class SHARED_LIBRARY_STUFF QIManagerDialogFactory
{
public:
/** Constructs Manager dialog factory. */
QIManagerDialogFactory() {}
/** Destructs Manager dialog factory. */
virtual ~QIManagerDialogFactory() {}
/** Prepares Manager dialog @a pDialog instance.
* @param pCenterWidget Brings the widget reference to center according to. */
virtual void prepare(QIManagerDialog *&pDialog, QWidget *pCenterWidget = 0);
/** Cleanups Manager dialog @a pDialog instance. */
virtual void cleanup(QIManagerDialog *&pDialog);
protected:
/** Creates derived @a pDialog instance.
* @param pCenterWidget Brings the widget reference to center according to. */
virtual void create(QIManagerDialog *&pDialog, QWidget *pCenterWidget) = 0;
};
/** QMainWindow sub-class used as various manager dialogs. */
class SHARED_LIBRARY_STUFF QIManagerDialog : public QIWithRestorableGeometry<QMainWindow>
{
Q_OBJECT;
signals:
/** Notifies listeners about dialog should be closed. */
void sigClose();
/** Notifies listeners about help requested.
* @param strHelpKeyword Brings the tag to find related section in the manual. */
void sigHelpRequested(const QString &strHelpKeyword);
protected:
/** Constructs Manager dialog.
* @param pCenterWidget Brings the widget reference to center according to. */
QIManagerDialog(QWidget *pCenterWidget);
/** @name Virtual prepare/cleanup cascade.
* @{ */
/** Configures all.
* @note Injected into prepare(), reimplement to configure all there. */
virtual void configure() {}
/** Configures central-widget.
* @note Injected into prepareCentralWidget(), reimplement to configure central-widget there. */
virtual void configureCentralWidget() {}
/** Configures button-box.
* @note Injected into prepareButtonBox(), reimplement to configure button-box there. */
virtual void configureButtonBox() {}
/** Performs final preparations.
* @note Injected into prepare(), reimplement to postprocess all there. */
virtual void finalize() {}
/** Loads dialog setting from extradata. */
virtual void loadSettings() {}
/** Saves dialog setting into extradata. */
virtual void saveSettings() {}
/** @} */
/** @name Widget stuff.
* @{ */
/** Defines the @a pWidget instance. */
void setWidget(QWidget *pWidget) { m_pWidget = pWidget; }
/** Defines the reference to widget menu, replacing current one. */
void setWidgetMenu(QMenu *pWidgetMenu) { m_widgetMenus = QList<QMenu*>() << pWidgetMenu; }
/** Defines the list of references to widget menus, replacing current one. */
void setWidgetMenus(QList<QMenu*> widgetMenus) { m_widgetMenus = widgetMenus; }
#ifdef VBOX_WS_MAC
/** Defines the @a pWidgetToolbar instance. */
void setWidgetToolbar(QIToolBar *pWidgetToolbar) { m_pWidgetToolbar = pWidgetToolbar; }
#endif
/** Returns the widget. */
virtual QWidget *widget() { return m_pWidget; }
/** Returns the button-box instance. */
QIDialogButtonBox *buttonBox() { return m_pButtonBox; }
/** Returns button of passed @a enmType. */
QPushButton *button(ButtonType enmType) { return m_buttons.value(enmType); }
/** Returns the widget reference to center manager dialog according. */
QWidget *centerWidget() const { return m_pCenterWidget; }
/** @} */
/** @name Event-handling stuff.
* @{ */
/** Handles close @a pEvent. */
virtual void closeEvent(QCloseEvent *pEvent) RT_OVERRIDE;
/** Returns whether the manager had emitted command to be closed. */
bool closeEmitted() const { return m_fCloseEmitted; }
/** @} */
private slots:
/** Handles help request. */
void sltHandleHelpRequested();
private:
/** @name Private prepare/cleanup cascade.
* @{ */
/** Prepares all. */
void prepare();
/** Prepares central-widget. */
void prepareCentralWidget();
/** Prepares button-box. */
void prepareButtonBox();
/** Prepares menu-bar. */
void prepareMenuBar();
#ifdef VBOX_WS_MAC
/** Prepares toolbar. */
void prepareToolBar();
#endif
/** Cleanup menu-bar. */
void cleanupMenuBar();
/** Cleanups all. */
void cleanup();
/** @} */
/** @name General stuff.
* @{ */
/** Holds the widget reference to center manager dialog according. */
QWidget *m_pCenterWidget;
/** Holds whether the manager had emitted command to be closed. */
bool m_fCloseEmitted;
/** @} */
/** @name Widget stuff.
* @{ */
/** Holds the widget instance. */
QWidget *m_pWidget;
/** Holds a list of widget menu references. */
QList<QMenu*> m_widgetMenus;
#ifdef VBOX_WS_MAC
/** Holds the widget toolbar instance. */
QIToolBar *m_pWidgetToolbar;
#endif
/** @} */
/** @name Button-box stuff.
* @{ */
/** Holds the dialog button-box instance. */
QIDialogButtonBox *m_pButtonBox;
/** Holds the button-box button references. */
QMap<ButtonType, QPushButton*> m_buttons;
/** @} */
/** Allow factory access to private/protected members: */
friend class QIManagerDialogFactory;
};
#endif /* !FEQT_INCLUDED_SRC_extensions_QIManagerDialog_h */
|
