summaryrefslogtreecommitdiff
path: root/src/libs/utils/checkablemessagebox.h
blob: e6988fc8e9ca9b382a632723a97f047244bf85d7 (plain)
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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "utils_global.h"

#include "aspects.h"

#include <QMessageBox>

QT_BEGIN_NAMESPACE
class QSettings;
QT_END_NAMESPACE

namespace Utils {

class CheckableMessageBoxPrivate;

class QTCREATOR_UTILS_EXPORT CheckableMessageBox
{
public:
    struct BoolDecision
    {
        QString text;
        bool &value;
    };

    struct SettingsDecision
    {
        QString text;
        QSettings *settings;
        QString settingsSubKey;
    };

    struct AspectDecision
    {
        QString text;
        BoolAspect &aspect;
    };

    using Decider = std::variant<BoolDecision, SettingsDecision, AspectDecision>;

    static Decider make_decider(QSettings *settings,
                                const QString &settingsSubKey,
                                const QString &text = msgDoNotAskAgain())
    {
        return Decider{SettingsDecision{text, settings, settingsSubKey}};
    }

    static Decider make_decider(bool &value, const QString &text = msgDoNotAskAgain())
    {
        return Decider{BoolDecision{text, value}};
    }

    static Decider make_decider(BoolAspect &aspect, const QString &text = msgDoNotAskAgain())
    {
        return Decider{AspectDecision{text, aspect}};
    }

    static QMessageBox::StandardButton question(
        QWidget *parent,
        const QString &title,
        const QString &question,
        std::optional<Decider> decider = std::nullopt,
        QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No,
        QMessageBox::StandardButton defaultButton = QMessageBox::No,
        QMessageBox::StandardButton acceptButton = QMessageBox::Yes,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {});

    static QMessageBox::StandardButton question(
        QWidget *parent,
        const QString &title,
        const QString &question,
        bool &value,
        QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No,
        QMessageBox::StandardButton defaultButton = QMessageBox::No,
        QMessageBox::StandardButton acceptButton = QMessageBox::Yes,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(value, text);
        return CheckableMessageBox::question(parent,
                                             title,
                                             question,
                                             decider,
                                             buttons,
                                             defaultButton,
                                             acceptButton,
                                             buttonTextOverrides);
    }

    static QMessageBox::StandardButton question(
        QWidget *parent,
        const QString &title,
        const QString &question,
        QSettings *settings,
        const QString &settingsSubKey,
        QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No,
        QMessageBox::StandardButton defaultButton = QMessageBox::No,
        QMessageBox::StandardButton acceptButton = QMessageBox::Yes,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(settings, settingsSubKey, text);
        return CheckableMessageBox::question(parent,
                                             title,
                                             question,
                                             decider,
                                             buttons,
                                             defaultButton,
                                             acceptButton,
                                             buttonTextOverrides);
    }

    static QMessageBox::StandardButton question(
        QWidget *parent,
        const QString &title,
        const QString &question,
        BoolAspect &aspect,
        QMessageBox::StandardButtons buttons = QMessageBox::Yes | QMessageBox::No,
        QMessageBox::StandardButton defaultButton = QMessageBox::No,
        QMessageBox::StandardButton acceptButton = QMessageBox::Yes,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(aspect, text);
        return CheckableMessageBox::question(parent,
                                             title,
                                             question,
                                             decider,
                                             buttons,
                                             defaultButton,
                                             acceptButton,
                                             buttonTextOverrides);
    }

    static QMessageBox::StandardButton information(
        QWidget *parent,
        const QString &title,
        const QString &text,
        std::optional<Decider> decider = std::nullopt,
        QMessageBox::StandardButtons buttons = QMessageBox::Ok,
        QMessageBox::StandardButton defaultButton = QMessageBox::NoButton,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {});

    static QMessageBox::StandardButton information(
        QWidget *parent,
        const QString &title,
        const QString &information,
        bool &value,
        QMessageBox::StandardButtons buttons = QMessageBox::Ok,
        QMessageBox::StandardButton defaultButton = QMessageBox::NoButton,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(value, text);
        return CheckableMessageBox::information(parent,
                                                title,
                                                information,
                                                decider,
                                                buttons,
                                                defaultButton,
                                                buttonTextOverrides);
    }

    static QMessageBox::StandardButton information(
        QWidget *parent,
        const QString &title,
        const QString &information,
        QSettings *settings,
        const QString &settingsSubKey,
        QMessageBox::StandardButtons buttons = QMessageBox::Ok,
        QMessageBox::StandardButton defaultButton = QMessageBox::NoButton,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(settings, settingsSubKey, text);
        return CheckableMessageBox::information(parent,
                                                title,
                                                information,
                                                decider,
                                                buttons,
                                                defaultButton,
                                                buttonTextOverrides);
    }

    static QMessageBox::StandardButton information(
        QWidget *parent,
        const QString &title,
        const QString &information,
        BoolAspect &aspect,
        QMessageBox::StandardButtons buttons = QMessageBox::Ok,
        QMessageBox::StandardButton defaultButton = QMessageBox::NoButton,
        QMap<QMessageBox::StandardButton, QString> buttonTextOverrides = {},
        const QString &text = msgDoNotAskAgain())
    {
        Decider decider = make_decider(aspect, text);
        return CheckableMessageBox::information(parent,
                                                title,
                                                information,
                                                decider,
                                                buttons,
                                                defaultButton,
                                                buttonTextOverrides);
    }

    // check and set "ask again" status
    static bool shouldAskAgain(const Decider &decider);
    static void doNotAskAgain(Decider &decider);

    static bool shouldAskAgain(QSettings *settings, const QString &key);
    static void doNotAskAgain(QSettings *settings, const QString &key);

    // Conversion convenience
    static void resetAllDoNotAskAgainQuestions(QSettings *settings);
    static bool hasSuppressedQuestions(QSettings *settings);
    static QString msgDoNotAskAgain();
    static QString msgDoNotShowAgain();
};

} // namespace Utils