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
|
#pragma once
#include <QObject>
#include <QMessageBox>
#include <QMutex>
#include <QString>
#include <QList>
#include "util/class.h"
/** Class used to allow all threads to display message boxes on error conditions
* with a custom list of standard buttons and to be able to react to them. */
typedef enum {
DLG_FATAL = 5,
DLG_CRITICAL = 4,
DLG_WARNING = 3,
DLG_INFO = 2,
DLG_QUESTION = 1,
DLG_NONE = 0 // No icon (default)
} DialogType;
class ErrorDialogProperties {
public:
/** Set the window title. ("Mixxx" is always prepended.) */
void setTitle(const QString& title);
/** Set a key to prevent multiple dialogs until the first is closed */
inline void setKey(const QString& key) {
m_key = key;
}
QString getKey() const {
return m_key;
}
/** Set the primary window text */
void setText(const QString& text);
QString getText() const {
return m_text;
}
/** Set additional window text */
inline void setInfoText(const QString& text) {
m_infoText = text;
}
/** Set detailed text (causes "Show Details" button to appear.) */
inline void setDetails(const QString& text, bool bUseMonospaceFont = false) {
m_details = text;
m_detailsUseMonospaceFont = bUseMonospaceFont;
}
/** Set whether the box is modal (blocks the GUI) or not */
inline void setModal(bool modal) {
m_modal = modal;
}
/** Set whether Mixxx should quit after the user acknowledges the error. */
inline void setShouldQuit(bool shouldQuit) {
m_shouldQuit = shouldQuit;
}
/** Automatically sets the icon to match the type for convenience. */
void setType(DialogType typeToSet);
/** Set the box's icon to one of the standard ones */
inline void setIcon(QMessageBox::Icon icon) {
m_icon = icon;
}
/** Add a standard button to the box */
void addButton(QMessageBox::StandardButton);
/** Set the default button to highlight */
inline void setDefaultButton(QMessageBox::StandardButton button) {
m_defaultButton = button;
}
/** Set the button to click if the Escape key is pressed */
inline void setEscapeButton(QMessageBox::StandardButton button) {
m_escapeButton = button;
}
private:
// Only ErrorDialogHandler should instantiate this
ErrorDialogProperties();
QString m_title;
QString m_key;
QString m_text;
QString m_infoText;
QString m_details;
bool m_detailsUseMonospaceFont;
bool m_modal;
bool m_shouldQuit;
DialogType m_type;
QMessageBox::Icon m_icon;
/** List of standard buttons to add to the box, in order
Note that a QMessageBox::Ignore button, if clicked, will suppress
error boxes with the same key for the duration of the application. */
QList<QMessageBox::StandardButton> m_buttons;
/** The default button to highlight, if any. */
QMessageBox::StandardButton m_defaultButton;
/** The button that's clicked if the Escape key is pressed. */
QMessageBox::StandardButton m_escapeButton;
// Befriending ErrorDialogHandler allows it to have cleaner code since
// the two are closely related anyway
friend class ErrorDialogHandler;
};
/** Singleton class because we only need one Handler to manage all error dialogs */
class ErrorDialogHandler : public QObject {
Q_OBJECT
public:
static ErrorDialogHandler* instance() {
if (!s_pInstance)
s_pInstance = new ErrorDialogHandler();
return s_pInstance;
}
static void setEnabled(bool enabled);
~ErrorDialogHandler() override;
// Call this to get a new instance of ErrorDialogProperties to populate with
// data
ErrorDialogProperties* newDialogProperties();
// Any thread may call either of these to emit a signal to display the
// requested message box. They return false if a dialog with the same key
// (or title if no key) is already displayed. If shouldQuit is true, Mixxx
// will shut down.
bool requestErrorDialog(DialogType type, const QString& message, bool shouldQuit = false);
bool requestErrorDialog(ErrorDialogProperties* props);
// Allows a means for main() to skip exec() if there was a critical or fatal
// error dialog displayed on app initialization.
bool checkError();
signals:
void showErrorDialog(ErrorDialogProperties* props);
void stdButtonClicked(const QString& key, QMessageBox::StandardButton whichStdButton);
private slots:
/** Actually displays the box */
void errorDialog(ErrorDialogProperties* props);
void boxClosed(const QString& key, QMessageBox* msgBox);
private:
// Private constructor
ErrorDialogHandler();
static ErrorDialogHandler *s_pInstance;
static bool s_bEnabled;
bool m_errorCondition;
QList<QString> m_dialogKeys;
QMutex m_mutex;
DISALLOW_COPY_AND_ASSIGN(ErrorDialogHandler);
};
|
