d6/dde/qmessagebox_8h_source.html

// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QMESSAGEBOX_H

#define QMESSAGEBOX_H


#include <QtWidgets/qtwidgetsglobal.h>

#include <QtWidgets/qdialog.h>

#include <QtWidgets/qdialogbuttonbox.h>


QT_REQUIRE_CONFIG(messagebox);


QT_BEGIN_NAMESPACE


class QAnyStringView;

class QLabel;

class QMessageBoxPrivate;

class QAbstractButton;

class QCheckBox;


class Q_WIDGETS_EXPORT QMessageBox : public QDialog

{

    Q_OBJECT

    Q_PROPERTY(QString text READ text WRITE setText)

    Q_PROPERTY(Icon icon READ icon WRITE setIcon)

    Q_PROPERTY(QPixmap iconPixmap READ iconPixmap WRITE setIconPixmap)

    Q_PROPERTY(Qt::TextFormat textFormat READ textFormat WRITE setTextFormat)

    Q_PROPERTY(StandardButtons standardButtons READ standardButtons WRITE setStandardButtons)

#if QT_CONFIG(textedit)

    Q_PROPERTY(QString detailedText READ detailedText WRITE setDetailedText)

#endif

    Q_PROPERTY(QString informativeText READ informativeText WRITE setInformativeText)

    Q_PROPERTY(Qt::TextInteractionFlags textInteractionFlags READ textInteractionFlags

               WRITE setTextInteractionFlags)

    Q_PROPERTY(Options options READ options WRITE setOptions)

public:

    // Keep in sync with MessageBoxOption in qplatformdialoghelper.h


    enum class Option {

        DontUseNativeDialog = 0x00000001

    };


    Q_FLAG(Option)


    enum Icon {

        // keep this in sync with QMessageDialogOptions::StandardIcon

        NoIcon = 0,

        Information = 1,

        Warning = 2,

        Critical = 3,

        Question = 4

    };


    Q_ENUM(Icon)


    enum ButtonRole {

        // keep this in sync with QDialogButtonBox::ButtonRole and QPlatformDialogHelper::ButtonRole

        InvalidRole = -1,

        AcceptRole,

        RejectRole,

        DestructiveRole,

        ActionRole,

        HelpRole,

        YesRole,

        NoRole,

        ResetRole,

        ApplyRole,


        NRoles

    };


    Q_ENUM(ButtonRole)


    enum StandardButton {

        // keep this in sync with QDialogButtonBox::StandardButton and QPlatformDialogHelper::StandardButton

        NoButton           = 0x00000000,

        Ok                 = 0x00000400,

        Save               = 0x00000800,

        SaveAll            = 0x00001000,

        Open               = 0x00002000,

        Yes                = 0x00004000,

        YesToAll           = 0x00008000,

        No                 = 0x00010000,

        NoToAll            = 0x00020000,

        Abort              = 0x00040000,

        Retry              = 0x00080000,

        Ignore             = 0x00100000,

        Close              = 0x00200000,

        Cancel             = 0x00400000,

        Discard            = 0x00800000,

        Help               = 0x01000000,

        Apply              = 0x02000000,

        Reset              = 0x04000000,

        RestoreDefaults    = 0x08000000,


        FirstButton        = Ok,                // internal

        LastButton         = RestoreDefaults,   // internal


        YesAll             = YesToAll,          // obsolete

        NoAll              = NoToAll,           // obsolete


        Default            = 0x00000100,        // obsolete

        Escape             = 0x00000200,        // obsolete

        FlagMask           = 0x00000300,        // obsolete

        ButtonMask         = ~FlagMask          // obsolete

    };


    Q_ENUM(StandardButton)


#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

    typedef StandardButton Button;

#endif

    Q_DECLARE_FLAGS(Options, Option)

    Q_DECLARE_FLAGS(StandardButtons, StandardButton)


    Q_FLAG(StandardButtons)


    explicit QMessageBox(QWidget *parent = nullptr);

    QMessageBox(Icon icon, const QString &title, const QString &text,

                StandardButtons buttons = NoButton, QWidget *parent = nullptr,

                Qt::WindowFlags flags = Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint);

    ~QMessageBox();


    void addButton(QAbstractButton *button, ButtonRole role);

    QPushButton *addButton(const QString &text, ButtonRole role);

    QPushButton *addButton(StandardButton button);

    void removeButton(QAbstractButton *button);


    using QDialog::open;

    void open(QObject *receiver, const char *member);


    QList<QAbstractButton *> buttons() const;

    ButtonRole buttonRole(QAbstractButton *button) const;


    void setStandardButtons(StandardButtons buttons);

    StandardButtons standardButtons() const;

    StandardButton standardButton(QAbstractButton *button) const;

    QAbstractButton *button(StandardButton which) const;


    QPushButton *defaultButton() const;

    void setDefaultButton(QPushButton *button);

    void setDefaultButton(StandardButton button);


    QAbstractButton *escapeButton() const;

    void setEscapeButton(QAbstractButton *button);

    void setEscapeButton(StandardButton button);


    QAbstractButton *clickedButton() const;


    QString text() const;

    void setText(const QString &text);


    Icon icon() const;

    void setIcon(Icon);


    QPixmap iconPixmap() const;

    void setIconPixmap(const QPixmap &pixmap);


    Qt::TextFormat textFormat() const;

    void setTextFormat(Qt::TextFormat format);


    void setTextInteractionFlags(Qt::TextInteractionFlags flags);

    Qt::TextInteractionFlags textInteractionFlags() const;


    void setCheckBox(QCheckBox *cb);

    QCheckBox* checkBox() const;


    void setOption(Option option, bool on = true);

    bool testOption(Option option) const;

    void setOptions(Options options);

    Options options() const;


    static StandardButton information(QWidget *parent, const QString &title,

         const QString &text, StandardButtons buttons = Ok,

         StandardButton defaultButton = NoButton);

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0) // needed as long as we have int overloads

    inline static StandardButton information(QWidget *parent, const QString &title,

                                  const QString& text,

                                  StandardButton button0, StandardButton button1 = NoButton)

    { return information(parent, title, text, StandardButtons(button0), button1); }

#endif


    static StandardButton question(QWidget *parent, const QString &title,

         const QString &text, StandardButtons buttons = StandardButtons(Yes | No),

         StandardButton defaultButton = NoButton);

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

    inline static int question(QWidget *parent, const QString &title,

                               const QString& text,

                               StandardButton button0, StandardButton button1)

    { return question(parent, title, text, StandardButtons(button0), button1); }

#endif


    static StandardButton warning(QWidget *parent, const QString &title,

         const QString &text, StandardButtons buttons = Ok,

         StandardButton defaultButton = NoButton);

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

    inline static int warning(QWidget *parent, const QString &title,

                              const QString& text,

                              StandardButton button0, StandardButton button1)

    { return warning(parent, title, text, StandardButtons(button0), button1); }

#endif


    static StandardButton critical(QWidget *parent, const QString &title,

         const QString &text, StandardButtons buttons = Ok,

         StandardButton defaultButton = NoButton);

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

    inline static int critical(QWidget *parent, const QString &title,

                               const QString& text,

                               StandardButton button0, StandardButton button1)

    { return critical(parent, title, text, StandardButtons(button0), button1); }

#endif


    static void about(QWidget *parent, const QString &title, const QString &text);

    static void aboutQt(QWidget *parent, const QString &title = QString());


#if QT_DEPRECATED_SINCE(6,2)

    // the following functions are obsolete:

    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    QMessageBox(const QString &title, const QString &text, Icon icon,

                  int button0, int button1, int button2,

                  QWidget *parent = nullptr,

                  Qt::WindowFlags f = Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint);


    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int information(QWidget *parent, const QString &title,

                           const QString& text,

                           int button0, int button1 = 0, int button2 = 0);

    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int information(QWidget *parent, const QString &title,

                           const QString& text,

                           const QString& button0Text,

                           const QString& button1Text = QString(),

                           const QString& button2Text = QString(),

                           int defaultButtonNumber = 0,

                           int escapeButtonNumber = -1);


    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int question(QWidget *parent, const QString &title,

                        const QString& text,

                        int button0, int button1 = 0, int button2 = 0);

    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int question(QWidget *parent, const QString &title,

                        const QString& text,

                        const QString& button0Text,

                        const QString& button1Text = QString(),

                        const QString& button2Text = QString(),

                        int defaultButtonNumber = 0,

                        int escapeButtonNumber = -1);


    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int warning(QWidget *parent, const QString &title,

                       const QString& text,

                       int button0, int button1, int button2 = 0);

    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int warning(QWidget *parent, const QString &title,

                       const QString& text,

                       const QString& button0Text,

                       const QString& button1Text = QString(),

                       const QString& button2Text = QString(),

                       int defaultButtonNumber = 0,

                       int escapeButtonNumber = -1);


    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int critical(QWidget *parent, const QString &title,

                        const QString& text,

                        int button0, int button1, int button2 = 0);

    QT_DEPRECATED_VERSION_X_6_2("Use the overload taking StandardButtons instead.")

    static int critical(QWidget *parent, const QString &title,

                        const QString& text,

                        const QString& button0Text,

                        const QString& button1Text = QString(),

                        const QString& button2Text = QString(),

                        int defaultButtonNumber = 0,

                        int escapeButtonNumber = -1);


    QT_DEPRECATED_VERSION_X_6_2("Use button() and QPushButton::text() instead.")

    QString buttonText(int button) const;

    QT_DEPRECATED_VERSION_X_6_2("Use addButton() instead.")

    void setButtonText(int button, const QString &text);

#endif


    QString informativeText() const;

    void setInformativeText(const QString &text);


#if QT_CONFIG(textedit)

    QString detailedText() const;

    void setDetailedText(const QString &text);

#endif


    void setWindowTitle(const QString &title);

    void setWindowModality(Qt::WindowModality windowModality);


#if QT_DEPRECATED_SINCE(6,2)

    QT_DEPRECATED_VERSION_X_6_2("Use QStyle::standardIcon() instead.")

    static QPixmap standardIcon(Icon icon);

#endif


Q_SIGNALS:

    void buttonClicked(QAbstractButton *button);


#ifdef Q_QDOC

public Q_SLOTS:

    int exec() override;

#endif


protected:

    bool event(QEvent *e) override;

    void resizeEvent(QResizeEvent *event) override;

    void showEvent(QShowEvent *event) override;

    void closeEvent(QCloseEvent *event) override;

    void keyPressEvent(QKeyEvent *event) override;

    void changeEvent(QEvent *event) override;


private:

    Q_DISABLE_COPY(QMessageBox)

    Q_DECLARE_PRIVATE(QMessageBox)

};


Q_DECLARE_OPERATORS_FOR_FLAGS(QMessageBox::StandardButtons)


Q_WIDGETS_EXPORT void qRequireVersion(int argc, char *argv[], QAnyStringView req);


#define QT_REQUIRE_VERSION(argc, argv, str) qRequireVersion(argc, argv, str);


QT_END_NAMESPACE


#endif // QMESSAGEBOX_H

QAbstractButton
The QAbstractButton class is the abstract base class of button widgets, providing functionality commo...
Definition qabstractbutton.h:23

QAnyStringView
\inmodule QtCore
Definition qanystringview.h:33

QCheckBox
The QCheckBox widget provides a checkbox with a text label.
Definition qcheckbox.h:19

QCloseEvent
The QCloseEvent class contains parameters that describe a close event.
Definition qevent.h:562

QDialog
The QDialog class is the base class of dialog windows.
Definition qdialog.h:19

QDialog::open
virtual void open()
Definition qdialog.cpp:503

QEvent
\inmodule QtCore
Definition qcoreevent.h:45

QKeyEvent
The QKeyEvent class describes a key event.
Definition qevent.h:424

QLabel
The QLabel widget provides a text or image display.
Definition qlabel.h:20

QMessageBoxPrivate
Definition qmessagebox.cpp:181

QMessageBox
The QMessageBox class provides a modal dialog for informing the user or for asking the user a questio...
Definition qmessagebox.h:22

QMessageBox::buttonClicked
void buttonClicked(QAbstractButton *button)
This signal is emitted whenever a button is clicked inside the QMessageBox.

QMessageBox::StandardButton
StandardButton
Definition qmessagebox.h:70

QMessageBox::ButtonRole
ButtonRole
Definition qmessagebox.h:53

QMessageBox::ResetRole
@ ResetRole
Definition qmessagebox.h:63

QMessageBox::NoRole
@ NoRole
Definition qmessagebox.h:62

QMessageBox::HelpRole
@ HelpRole
Definition qmessagebox.h:60

QMessageBox::DestructiveRole
@ DestructiveRole
Definition qmessagebox.h:58

QMessageBox::YesRole
@ YesRole
Definition qmessagebox.h:61

QMessageBox::AcceptRole
@ AcceptRole
Definition qmessagebox.h:56

QMessageBox::ActionRole
@ ActionRole
Definition qmessagebox.h:59

QMessageBox::RejectRole
@ RejectRole
Definition qmessagebox.h:57

QMessageBox::ApplyRole
@ ApplyRole
Definition qmessagebox.h:64

QMessageBox::Icon
Icon
This enum has the following values:
Definition qmessagebox.h:43

QObject
\inmodule QtCore
Definition qobject.h:103

QPixmap
Returns a copy of the pixmap that is transformed using the given transformation transform and transfo...
Definition qpixmap.h:27

QPushButton
The QPushButton widget provides a command button.
Definition qpushbutton.h:20

QResizeEvent
The QResizeEvent class contains event parameters for resize events.
Definition qevent.h:548

QShowEvent
The QShowEvent class provides an event that is sent when a widget is shown.
Definition qevent.h:578

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129

QWidget
The QWidget class is the base class of all user interface objects.
Definition qwidget.h:99

text
QString text
Definition doc_src_properties.cpp:105

button
QPushButton * button
[2]
Definition doc_src_properties.cpp:35

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590

Qt
Definition qcompare.h:63

Qt::WindowModality
WindowModality
Definition qnamespace.h:1547

Qt::TextFormat
TextFormat
Definition qnamespace.h:1183

Qt::MSWindowsFixedSizeDialogHint
@ MSWindowsFixedSizeDialogHint
Definition qnamespace.h:221

Qt::Dialog
@ Dialog
Definition qnamespace.h:208

ButtonMask
@ ButtonMask
Definition qabstractspinbox_p.h:48

Ok
@ Ok
Definition qbezier.cpp:173

Discard
@ Discard
Definition qbezier.cpp:174

Q_DECLARE_FLAGS
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174

Q_DECLARE_OPERATORS_FOR_FLAGS
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
Definition qflags.h:194

Button
Button
Definition qmessagebox.cpp:73

qRequireVersion
Q_WIDGETS_EXPORT void qRequireVersion(int argc, char *argv[], QAnyStringView req)
Definition qmessagebox.cpp:2935

f
GLfloat GLfloat f
Definition qopengles2ext.h:795

flags
GLbitfield flags
Definition qopengles2ext.h:1026

format
GLint GLsizei GLsizei GLenum format
Definition qopengles2ext.h:206

event
struct _cl_event * event
Definition qopenglext.h:2998

option
GLuint GLenum option
Definition qopenglext.h:5929

warning
QDebug warning(QAnyStringView fileName, int lineNumber)
Definition qqmltyperegistrarutils.cpp:39

Default
static QT_BEGIN_NAMESPACE const uint Default
Definition qsplitter_p.h:27

cb
SSL_CTX int(* cb)(SSL *ssl, unsigned char **out, unsigned char *outlen, const unsigned char *in, unsigned int inlen, void *arg)
Definition qsslsocket_openssl_symbols.cpp:398

QT_REQUIRE_CONFIG
#define QT_REQUIRE_CONFIG(feature)
Definition qtconfigmacros.h:67

QT_DEPRECATED_VERSION_X_6_2
#define QT_DEPRECATED_VERSION_X_6_2(text)
Definition qtdeprecationmarkers.h:143

Q_ENUM
#define Q_ENUM(x)
Definition qtmetamacros.h:68

Q_PROPERTY
#define Q_PROPERTY(...)
Definition qtmetamacros.h:56

Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:119

Q_FLAG
#define Q_FLAG(x)
Definition qtmetamacros.h:69

Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44

Q_SIGNALS
#define Q_SIGNALS
Definition qtmetamacros.h:45

icon
QIcon icon
[15]
Definition src_corelib_global_qglobal.cpp:144

open
file open(QIODevice::ReadOnly)

title
QString title
[35]
Definition src_corelib_kernel_qobject.cpp:314

exec
dialog exec()

setInformativeText
msgBox setInformativeText("Do you want to save your changes?")

setDefaultButton
msgBox setDefaultButton(QMessageBox::Save)

setStandardButtons
msgBox setStandardButtons(QMessageBox::Save|QMessageBox::Discard|QMessageBox::Cancel)

setIcon
myAction setIcon(SomeIcon)

pixmap
widget render & pixmap
Definition src_gui_kernel_qwidget.cpp:32

setText
insertRed setText("insert red text")

Option
Definition option.h:13

Options
Definition main.cpp:91