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
236
237
238
239
240
241
242
243
244
245
246
|
/* $Id$ */
/** @file
* VBox Qt GUI - UIPopupPane class declaration.
*/
/*
* Copyright (C) 2013-2022 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef FEQT_INCLUDED_SRC_widgets_UIPopupPane_h
#define FEQT_INCLUDED_SRC_widgets_UIPopupPane_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* Qt includes: */
#include <QMap>
#include <QWidget>
/* GUI includes: */
#include "QIWithRetranslateUI.h"
#include "UILibraryDefs.h"
/* Forward declaration: */
class QEvent;
class QObject;
class QPainter;
class QPaintEvent;
class QRect;
class QShowEvent;
class QSize;
class QString;
class QWidget;
class UIAnimation;
class UIPopupPaneDetails;
class UIPopupPaneMessage;
class UIPopupPaneButtonPane;
/** QWidget extension used as popup-center pane prototype. */
class SHARED_LIBRARY_STUFF UIPopupPane : public QIWithRetranslateUI<QWidget>
{
Q_OBJECT;
Q_PROPERTY(QSize hiddenSizeHint READ hiddenSizeHint);
Q_PROPERTY(QSize shownSizeHint READ shownSizeHint);
Q_PROPERTY(QSize minimumSizeHint READ minimumSizeHint WRITE setMinimumSizeHint);
Q_PROPERTY(int defaultOpacity READ defaultOpacity);
Q_PROPERTY(int hoveredOpacity READ hoveredOpacity);
Q_PROPERTY(int opacity READ opacity WRITE setOpacity);
signals:
/** Asks to show itself asynchronously. */
void sigToShow();
/** Asks to hide itself asynchronously. */
void sigToHide();
/** Asks to show itself instantly. */
void sigShow();
/** Asks to hide itself instantly. */
void sigHide();
/** Notifies about hover enter. */
void sigHoverEnter();
/** Notifies about hover leave. */
void sigHoverLeave();
/** Notifies about focus enter. */
void sigFocusEnter();
/** Notifies about focus leave. */
void sigFocusLeave();
/** Proposes pane @a iWidth. */
void sigProposePaneWidth(int iWidth);
/** Proposes details pane @a iHeight. */
void sigProposeDetailsPaneHeight(int iHeight);
/** Notifies about size-hint changed. */
void sigSizeHintChanged();
/** Asks to close with @a iResultCode. */
void sigDone(int iResultCode) const;
public:
/** Constructs popup-pane.
* @param pParent Brings the parent.
* @param strMessage Brings the pane message.
* @param strDetails Brings the pane details.
* @param buttonDescriptions Brings the button descriptions. */
UIPopupPane(QWidget *pParent,
const QString &strMessage, const QString &strDetails,
const QMap<int, QString> &buttonDescriptions);
/** Recalls itself. */
void recall();
/** Defines the @a strMessage. */
void setMessage(const QString &strMessage);
/** Defines the @a strDetails. */
void setDetails(const QString &strDetails);
/** Returns minimum size-hint. */
QSize minimumSizeHint() const { return m_minimumSizeHint; }
/** Defines @a minimumSizeHint. */
void setMinimumSizeHint(const QSize &minimumSizeHint);
/** Lays the content out. */
void layoutContent();
public slots:
/** Handles proposal for a @a newSize. */
void sltHandleProposalForSize(QSize newSize);
private slots:
/** Marks pane as fully shown. */
void sltMarkAsShown();
/** Updates size-hint. */
void sltUpdateSizeHint();
/** Handles a click of button with @a iButtonID. */
void sltButtonClicked(int iButtonID);
private:
/** A pair of strings. */
typedef QPair<QString, QString> QStringPair;
/** A list of string pairs. */
typedef QList<QStringPair> QStringPairList;
/** Prepares all. */
void prepare();
/** Prepares background. */
void prepareBackground();
/** Prepares content. */
void prepareContent();
/** Prepares animation. */
void prepareAnimation();
/** Handles translation event. */
virtual void retranslateUi() RT_OVERRIDE;
/** Translats tool-tips. */
void retranslateToolTips();
/** Pre-handles standard Qt @a pEvent for passed @a pObject. */
virtual bool eventFilter(QObject *pObject, QEvent *pEvent) RT_OVERRIDE;
/** Handles show @a pEvent. */
virtual void showEvent(QShowEvent *pEvent) RT_OVERRIDE;
/** Handles first show @a pEvent. */
void polishEvent(QShowEvent *pEvent);
/** Handles paint @a pEvent. */
virtual void paintEvent(QPaintEvent *pEvent) RT_OVERRIDE;
/** Assigns clipping of @a rect geometry for passed @a painter. */
void configureClipping(const QRect &rect, QPainter &painter);
/** Paints background of @a rect geometry using @a painter. */
void paintBackground(const QRect &rect, QPainter &painter);
/** Paints frame of @a rect geometry using @a painter. */
void paintFrame(QPainter &painter);
/** Closes pane with @a iResultCode. */
void done(int iResultCode);
/** Returns size-hint in hidden state. */
QSize hiddenSizeHint() const { return m_hiddenSizeHint; }
/** Returns size-hint in shown state. */
QSize shownSizeHint() const { return m_shownSizeHint; }
/** Returns default opacity. */
int defaultOpacity() const { return m_iDefaultOpacity; }
/** Returns hovered opacity. */
int hoveredOpacity() const { return m_iHoveredOpacity; }
/** Returns current opacity. */
int opacity() const { return m_iOpacity; }
/** Defines current @a iOpacity. */
void setOpacity(int iOpacity) { m_iOpacity = iOpacity; update(); }
/** Returns details text. */
QString prepareDetailsText() const;
/** Prepares passed @a aDetailsList. */
void prepareDetailsList(QStringPairList &aDetailsList) const;
/** Holds whether the pane was polished. */
bool m_fPolished;
/** Holds the pane ID. */
const QString m_strId;
/** Holds the layout margin. */
const int m_iLayoutMargin;
/** Holds the layout spacing. */
const int m_iLayoutSpacing;
/** Holds the minimum size-hint. */
QSize m_minimumSizeHint;
/** Holds the pane message. */
QString m_strMessage;
/** Holds the pane details. */
QString m_strDetails;
/** Holds the button descriptions. */
QMap<int, QString> m_buttonDescriptions;
/** Holds whether the pane is shown fully. */
bool m_fShown;
/** Holds the show/hide animation instance. */
UIAnimation *m_pShowAnimation;
/** Holds the size-hint of pane in hidden state. */
QSize m_hiddenSizeHint;
/** Holds the size-hint of pane in shown state. */
QSize m_shownSizeHint;
/** Holds whether the pane can loose focus. */
bool m_fCanLooseFocus;
/** Holds whether the pane is focused. */
bool m_fFocused;
/** Holds whether the pane is hovered. */
bool m_fHovered;
/** Holds the default opacity. */
const int m_iDefaultOpacity;
/** Holds the hovered opacity. */
const int m_iHoveredOpacity;
/** Holds the current opacity. */
int m_iOpacity;
/** Holds the message pane instance. */
UIPopupPaneMessage *m_pMessagePane;
/** Holds the details pane instance. */
UIPopupPaneDetails *m_pDetailsPane;
/** Holds the buttons pane instance. */
UIPopupPaneButtonPane *m_pButtonPane;
};
#endif /* !FEQT_INCLUDED_SRC_widgets_UIPopupPane_h */
|
