File size: 5,367 Bytes
985c397
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
// SPDX-License-Identifier: LGPL-2.1-or-later

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef CHECKABLEMESSAGEBOX_H
#define CHECKABLEMESSAGEBOX_H

#include <QDialog>
#include <QDialogButtonBox>
#include <QMessageBox>
#include <FCGlobal.h>

namespace Gui
{
namespace Dialog
{

struct DlgCheckableMessageBoxPrivate;

/* A messagebox suitable for questions with a
 * "Do not ask me again" checkbox. Emulates the QMessageBox API with
 * static conveniences. */

class GuiExport DlgCheckableMessageBox: public QDialog
{
    Q_OBJECT
    Q_PROPERTY(QString text READ text WRITE setText)  // clazy:exclude=qproperty-without-notify
    Q_PROPERTY(
        QPixmap iconPixmap READ iconPixmap WRITE setIconPixmap
    )  // clazy:exclude=qproperty-without-notify
    Q_PROPERTY(bool isChecked READ isChecked WRITE setChecked)  // clazy:exclude=qproperty-without-notify
    // Q_PROPERTY(QString prefEntry WRITE setPrefEntry) // Must have a READ accessor!
    Q_PROPERTY(
        QString checkBoxText READ checkBoxText WRITE setCheckBoxText
    )  // clazy:exclude=qproperty-without-notify
    Q_PROPERTY(
        QDialogButtonBox::StandardButtons buttons READ standardButtons WRITE setStandardButtons
    )  // clazy:exclude=qproperty-without-notify
    Q_PROPERTY(
        QDialogButtonBox::StandardButton defaultButton READ defaultButton WRITE setDefaultButton
    )  // clazy:exclude=qproperty-without-notify
public:
    explicit DlgCheckableMessageBox(QWidget* parent);
    ~DlgCheckableMessageBox() override;

    static QDialogButtonBox::StandardButton question(
        QWidget* parent,
        const QString& title,
        const QString& question,
        const QString& checkBoxText,
        bool* checkBoxSetting,
        QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Yes | QDialogButtonBox::No,
        QDialogButtonBox::StandardButton defaultButton = QDialogButtonBox::No
    );

    QString text() const;
    void setText(const QString&);

    void setPrefEntry(const QString& entry);

    void setPrefPath(const QString& path);

    void accept() override;
    void reject() override;

    bool isChecked() const;
    void setChecked(bool s);

    QString checkBoxText() const;
    void setCheckBoxText(const QString&);

    QDialogButtonBox::StandardButtons standardButtons() const;
    void setStandardButtons(QDialogButtonBox::StandardButtons s);

    QDialogButtonBox::StandardButton defaultButton() const;
    void setDefaultButton(QDialogButtonBox::StandardButton s);

    // see static QMessageBox::standardPixmap()
    QPixmap iconPixmap() const;
    void setIconPixmap(const QPixmap& p);

    // Query the result
    QAbstractButton* clickedButton() const;
    QDialogButtonBox::StandardButton clickedStandardButton() const;

    // Conversion convenience
    static QMessageBox::StandardButton dialogButtonBoxToMessageBoxButton(
        QDialogButtonBox::StandardButton
    );

    /// convenient show method
    /// It shows a dialog with header and message provided and a checkbox in check state with the
    /// message provided. It uses a parameter in path "User parameter:BaseApp/CheckMessages" derived
    /// from the header test, defaulting to false, to store the status of the checkbox, when the
    /// user exits the modal dialog.
    static void showMessage(
        const QString& header,
        const QString& message,
        bool check = false,
        const QString& checkText = tr("Don't show me again")
    );

    /// Same as showMessage above, but it checks the specific preference path and parameter
    /// provided, defaulting to entryDefault value if the parameter is not present.
    static void showMessage(
        const QString& header,
        const QString& message,
        const QString& prefPath,
        const QString& paramEntry,
        bool entryDefault = false,
        bool check = false,
        const QString& checkText = QStringLiteral("Don't show me again")
    );

private Q_SLOTS:
    void slotClicked(QAbstractButton* b);

private:
    DlgCheckableMessageBoxPrivate* m_d;
    QByteArray paramEntry;
    QString prefPath;
};

}  // namespace Dialog
}  // namespace Gui

#endif  // CHECKABLEMESSAGEBOX_H