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
|
/* $Id: UINativeWizard.h $ */
/** @file
* VBox Qt GUI - UINativeWizard 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_wizards_UINativeWizard_h
#define FEQT_INCLUDED_SRC_wizards_UINativeWizard_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* Qt includes: */
#include <QMap>
#include <QPointer>
/* GUI includes: */
#include "QIWithRetranslateUI.h"
#include "UIExtraDataDefs.h"
#include "UILibraryDefs.h"
/* Forward declarations: */
class QLabel;
class QPushButton;
class QStackedWidget;
class QVBoxLayout;
class UINativeWizardPage;
class UINotificationCenter;
class UINotificationProgress;
/** Native wizard buttons. */
enum WizardButtonType
{
WizardButtonType_Invalid,
WizardButtonType_Help,
WizardButtonType_Expert,
WizardButtonType_Back,
WizardButtonType_Next,
WizardButtonType_Cancel,
WizardButtonType_Max,
};
Q_DECLARE_METATYPE(WizardButtonType);
#ifdef VBOX_WS_MAC
/** QWidget-based QFrame analog with one particular purpose to
* simulate macOS wizard frame without influencing palette hierarchy. */
class SHARED_LIBRARY_STUFF UIFrame : public QWidget
{
Q_OBJECT;
public:
/** Constructs UIFrame passing @a pParent to the base-class. */
UIFrame(QWidget *pParent);
protected:
/** Handles paint @a pEvent. */
virtual void paintEvent(QPaintEvent *pEvent) /* final */;
};
#endif /* VBOX_WS_MAC */
/** QDialog extension with advanced functionality emulating QWizard behavior. */
class SHARED_LIBRARY_STUFF UINativeWizard : public QIWithRetranslateUI<QDialog>
{
Q_OBJECT;
public:
/** Constructs wizard passing @a pParent to the base-class.
* @param enmType Brings the wizard type.
* @param enmMode Brings the wizard mode.
* @param strHelpHashtag Brings the wizard help hashtag. */
UINativeWizard(QWidget *pParent,
WizardType enmType,
WizardMode enmMode = WizardMode_Auto,
const QString &strHelpHashtag = QString());
/** Destructs wizard. */
virtual ~UINativeWizard() RT_OVERRIDE;
/** Returns local notification-center reference. */
UINotificationCenter *notificationCenter() const;
/** Immediately handles notification @a pProgress object. */
bool handleNotificationProgressNow(UINotificationProgress *pProgress);
/** Returns wizard button of specified @a enmType. */
QPushButton *wizardButton(const WizardButtonType &enmType) const;
public slots:
/** Executes wizard in window modal mode.
* @note You shouldn't have to override it! */
virtual int exec() /* final */;
protected:
/** Returns wizard type. */
WizardType type() const { return m_enmType; }
/** Returns wizard mode. */
WizardMode mode() const { return m_enmMode; }
/** Defines @a strName for wizard button of specified @a enmType. */
void setWizardButtonName(const WizardButtonType &enmType, const QString &strName);
/** Defines pixmap @a strName. */
void setPixmapName(const QString &strName);
/** Returns whether the page with certain @a iIndex is visible. */
bool isPageVisible(int iIndex) const;
/** Defines whether the page with certain @a iIndex is @a fVisible. */
void setPageVisible(int iIndex, bool fVisible);
/** Appends wizard @a pPage.
* @returns assigned page index. */
int addPage(UINativeWizardPage *pPage);
/** Populates pages.
* @note In your subclasses you should add
* pages via addPage declared above. */
virtual void populatePages() = 0;
/** Handles translation event. */
virtual void retranslateUi() RT_OVERRIDE;
/** Performs wizard-specific cleanup in case of wizard-mode change
* such as folder deletion in New VM wizard etc. */
virtual void cleanWizard() {}
private slots:
/** Handles current-page change to page with @a iIndex. */
void sltCurrentIndexChanged(int iIndex = -1);
/** Handles page validity changes. */
void sltCompleteChanged();
/** Toggles between basic and expert modes. */
void sltExpert();
/** Switches to previous page. */
void sltPrevious();
/** Switches to next page. */
void sltNext();
private:
/** Prepares all. */
void prepare();
/** Cleanups all. */
void cleanup();
/** Inits all. */
void init();
/** Deinits all. */
void deinit();
/** Performs pages translation. */
void retranslatePages();
/** Resizes wizard to golden ratio. */
void resizeToGoldenRatio();
#ifdef VBOX_WS_MAC
/** Assigns wizard background. */
void assignBackground();
#else
/** Assigns wizard watermark. */
void assignWatermark();
#endif
/** Checks if the pages coming after the page with iPageIndex is visible or not. Returns true if
* page with iPageIndex is the last visible page of the wizard. Returns false otherwise. */
bool isLastVisiblePage(int iPageIndex) const;
/** Holds the wizard type. */
WizardType m_enmType;
/** Holds the wizard mode. */
WizardMode m_enmMode;
/** Holds the wizard help hashtag. */
QString m_strHelpHashtag;
/** Holds the pixmap name. */
QString m_strPixmapName;
/** Holds the last entered page index. */
int m_iLastIndex;
/** Holds the set of invisible pages. */
QSet<int> m_invisiblePages;
/** Holds the pixmap label instance. */
QLabel *m_pLabelPixmap;
/** Holds the right layout instance. */
QVBoxLayout *m_pLayoutRight;
/** Holds the title label instance. */
QLabel *m_pLabelPageTitle;
/** Holds the widget-stack instance. */
QStackedWidget *m_pWidgetStack;
/** Holds button instance map. */
QMap<WizardButtonType, QPushButton*> m_buttons;
/** Holds the local notification-center instance. */
UINotificationCenter *m_pNotificationCenter;
};
/** Native wizard interface pointer. */
typedef QPointer<UINativeWizard> UINativeWizardPointer;
#endif /* !FEQT_INCLUDED_SRC_wizards_UINativeWizard_h */
|
