Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
#include <qquickmessagedialog_p.h>
Signals | |
void | textChanged () |
void | informativeTextChanged () |
void | detailedTextChanged () |
void | buttonsChanged () |
void | buttonClicked (QPlatformDialogHelper::StandardButton button, QPlatformDialogHelper::ButtonRole role) |
Signals inherited from QQuickAbstractDialog | |
void | accepted () |
void | rejected () |
void | parentWindowChanged () |
void | titleChanged () |
void | flagsChanged () |
void | modalityChanged () |
void | visibleChanged () |
void | resultChanged () |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
QQuickMessageDialog (QObject *parent=nullptr) | |
A message dialog. | |
QString | text () const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::text | |
void | setText (const QString &text) |
QString | informativeText () const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::informativeText | |
void | setInformativeText (const QString &text) |
QString | detailedText () const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::detailedText | |
void | setDetailedText (const QString &text) |
QPlatformDialogHelper::StandardButtons | buttons () const |
\qmlproperty flags QtQuick.Dialogs::MessageDialog::buttons | |
void | setButtons (QPlatformDialogHelper::StandardButtons buttons) |
Public Member Functions inherited from QQuickAbstractDialog | |
QQuickAbstractDialog (QQuickDialogType type, QObject *parent=nullptr) | |
The base class of native dialogs. | |
~QQuickAbstractDialog () | |
QPlatformDialogHelper * | handle () const |
QQmlListProperty< QObject > | data () |
QWindow * | parentWindow () const |
\qmlproperty Window QtQuick.Dialogs::Dialog::parentWindow | |
void | setParentWindow (QWindow *window) |
void | resetParentWindow () |
QString | title () const |
\qmlproperty string QtQuick.Dialogs::Dialog::title | |
void | setTitle (const QString &title) |
Qt::WindowFlags | flags () const |
\qmlproperty Qt::WindowFlags QtQuick.Dialogs::Dialog::flags | |
void | setFlags (Qt::WindowFlags flags) |
Qt::WindowModality | modality () const |
\qmlproperty Qt::WindowModality QtQuick.Dialogs::Dialog::modality | |
void | setModality (Qt::WindowModality modality) |
bool | isVisible () const |
\qmlproperty bool QtQuick.Dialogs::Dialog::visible | |
void | setVisible (bool visible) |
int | result () const |
\qmlproperty int QtQuick.Dialogs::Dialog::result | |
void | setResult (int result) |
Public Member Functions inherited from QObject | |
Q_INVOKABLE | QObject (QObject *parent=nullptr) |
Constructs an object with parent object parent. | |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. | |
virtual bool | event (QEvent *event) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
Filters events if this object has been installed as an event filter for the watched object. | |
QString | objectName () const |
Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
Sets the object's name to name. | |
void | setObjectName (QAnyStringView name) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBindable< QString > | bindableObjectName () |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false . | |
bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false . | |
bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false . | |
bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false . | |
bool | blockSignals (bool b) noexcept |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
QThread * | thread () const |
Returns the thread in which the object lives. | |
bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
void | killTimer (Qt::TimerId id) |
template<typename T > | |
T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
template<typename T > | |
QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
template<typename T > | |
T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const QObjectList & | children () const |
Returns a list of child objects. | |
void | setParent (QObject *parent) |
Makes the object a child of parent. | |
void | installEventFilter (QObject *filterObj) |
Installs an event filter filterObj on this object. | |
void | removeEventFilter (QObject *obj) |
Removes an event filter object obj from this object. | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
void | dumpObjectTree () const |
Dumps a tree of children to the debug output. | |
void | dumpObjectInfo () const |
Dumps information about signal connections, etc. | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. | |
bool | setProperty (const char *name, QVariant &&value) |
QVariant | property (const char *name) const |
Returns the value of the object's name property. | |
QList< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () const |
Returns a pointer to the parent object. | |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false . | |
Public Member Functions inherited from QQmlParserStatus | |
QQmlParserStatus () | |
virtual | ~QQmlParserStatus () |
Protected Member Functions | |
void | onCreate (QPlatformDialogHelper *dialog) override |
void | onShow (QPlatformDialogHelper *dialog) override |
int | dialogCode () const override |
Protected Member Functions inherited from QQuickAbstractDialog | |
void | classBegin () override |
Invoked after class creation, but before any properties have been set. | |
void | componentComplete () override |
Invoked after the root component that caused this instantiation has completed construction. | |
bool | create () |
void | destroy () |
virtual bool | useNativeDialog () const |
virtual void | onHide (QPlatformDialogHelper *dialog) |
QQuickItem * | findParentItem () const |
QWindow * | windowForOpen () const |
void | deferredOpen (QWindow *window) |
Protected Member Functions inherited from QObject | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. | |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
virtual void | childEvent (QChildEvent *event) |
This event handler can be reimplemented in a subclass to receive child events. | |
virtual void | customEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive custom events. | |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Properties | |
QString | text |
QString | informativeText |
QString | detailedText |
QPlatformDialogHelper::StandardButtons | buttons |
Properties inherited from QQuickAbstractDialog | |
QQmlListProperty< QObject > | data |
\qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data | |
QWindow * | parentWindow |
QString | title |
Qt::WindowFlags | flags |
Qt::WindowModality | modality |
bool | visible |
int | result |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
Public Types inherited from QQuickAbstractDialog | |
enum | StandardCode { Rejected , Accepted } |
Public Slots inherited from QQuickAbstractDialog | |
void | open () |
\qmlmethod void QtQuick.Dialogs::Dialog::open() | |
void | close () |
\qmlmethod void QtQuick.Dialogs::Dialog::close() | |
virtual void | accept () |
\qmlmethod void QtQuick.Dialogs::Dialog::accept() | |
virtual void | reject () |
\qmlmethod void QtQuick.Dialogs::Dialog::reject() | |
virtual void | done (int result) |
\qmlmethod void QtQuick.Dialogs::Dialog::done(int result) | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Static Public Member Functions inherited from QObject | |
static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
\threadsafe | |
static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
\threadsafe | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static bool | disconnect (const QMetaObject::Connection &) |
Disconnect a connection. | |
template<typename Func1 , typename Func2 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
template<typename Func1 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
Protected Attributes inherited from QQuickAbstractDialog | |
int | m_result = Rejected |
QWindow * | m_parentWindow = nullptr |
QString | m_title |
Qt::WindowFlags | m_flags = Qt::Dialog |
Qt::WindowModality | m_modality = Qt::WindowModal |
QQuickDialogType | m_type = QQuickDialogType::FileDialog |
QList< QObject * > | m_data |
std::unique_ptr< QPlatformDialogHelper > | m_handle |
bool | m_visibleRequested = false |
bool | m_visible = false |
bool | m_complete = false |
bool | m_parentWindowExplicitlySet = false |
bool | m_firstShow = true |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Related Symbols inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) | |
Definition at line 22 of file qquickmessagedialog_p.h.
|
explicit |
A message dialog.
\qmltype MessageDialog \inherits Dialog
! \instantiates QQuickMessageDialog \inqmlmodule QtQuick.Dialogs
The MessageDialog type provides a QML API for message dialogs.
A message dialog is used to inform the user, or ask the user a question. A message dialog displays a primary \l text to alert the user to a situation, an \l {informativeText}{informative text} to further explain the alert or to ask the user a question, and an optional \l {detailedText}{detailed text} to provide even more data if the user requests it. A message box can also display a configurable set of \l buttons for accepting a user response.
To show a message dialog, construct an instance of MessageDialog, set the desired properties, and call \l {Dialog::}{open()}.
The user must click the \uicontrol OK button to dismiss the message dialog.
A more elaborate approach than just alerting the user to an event is to also ask the user what to do about it. Store the question in the \l {informativeText}{informative text} property, and specify the \l buttons property to the set of buttons you want as the set of user responses. The buttons are specified by combining values using the bitwise OR operator.
\section2 Availability A native platform message dialog is currently available on the following platforms: \list \li Android \li iOS \li macOS \endlist \include includes/fallback.qdocinc
\qmlsignal QtQuick.Dialogs::MessageDialog::buttonClicked(QPlatformDialogHelper::StandardButton button, QPlatformDialogHelper::ButtonRole role)
This signal is emitted when a button with the specified role is clicked.
By giving this signal a handler, you can respond to any custom button being pressed. The button argument tells which button was clicked, while the role argument tells the functional role of that button.
Definition at line 99 of file qquickmessagedialog.cpp.
|
signal |
QPlatformDialogHelper::StandardButtons QQuickMessageDialog::buttons | ( | ) | const |
\qmlproperty flags QtQuick.Dialogs::MessageDialog::buttons
This property holds a combination of buttons that are used by the message dialog. The default value is MessageDialog.NoButton
.
Possible flags: \value MessageDialog.Ok An "OK" button defined with the AcceptRole
. \value MessageDialog.Open An "Open" button defined with the AcceptRole
. \value MessageDialog.Save A "Save" button defined with the AcceptRole
. \value MessageDialog.Cancel A "Cancel" button defined with the RejectRole
. \value MessageDialog.Close A "Close" button defined with the RejectRole
. \value MessageDialog.Discard A "Discard" or "Don't Save" button, depending on the platform, defined with the DestructiveRole
. \value MessageDialog.Apply An "Apply" button defined with the ApplyRole
. \value MessageDialog.Reset A "Reset" button defined with the ResetRole
. \value MessageDialog.RestoreDefaults A "Restore Defaults" button defined with the ResetRole
. \value MessageDialog.Help A "Help" button defined with the HelpRole
. \value MessageDialog.SaveAll A "Save All" button defined with the AcceptRole
. \value MessageDialog.Yes A "Yes" button defined with the YesRole
. \value MessageDialog.YesToAll A "Yes to All" button defined with the YesRole
. \value MessageDialog.No A "No" button defined with the NoRole
. \value MessageDialog.NoToAll A "No to All" button defined with the NoRole
. \value MessageDialog.Abort An "Abort" button defined with the RejectRole
. \value MessageDialog.Retry A "Retry" button defined with the AcceptRole
. \value MessageDialog.Ignore An "Ignore" button defined with the AcceptRole
. \value MessageDialog.NoButton The dialog has no buttons.
Definition at line 203 of file qquickmessagedialog.cpp.
References QMessageDialogOptions::standardButtons().
|
signal |
QString QQuickMessageDialog::detailedText | ( | ) | const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::detailedText
This property holds the text to be displayed in the details area.
Definition at line 158 of file qquickmessagedialog.cpp.
References QMessageDialogOptions::detailedText().
|
signal |
|
overrideprotectedvirtual |
Reimplemented from QQuickAbstractDialog.
Definition at line 245 of file qquickmessagedialog.cpp.
References QQuickAbstractDialog::Accepted, QPlatformDialogHelper::AcceptRole, QQuickAbstractDialog::dialogCode(), QPlatformDialogHelper::NoRole, QQuickAbstractDialog::Rejected, QPlatformDialogHelper::RejectRole, and QPlatformDialogHelper::YesRole.
QString QQuickMessageDialog::informativeText | ( | ) | const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::informativeText
This property holds the informative text that provides a fuller description for the message.
Informative text can be used to expand upon the \l text to give more information to the user.
Definition at line 136 of file qquickmessagedialog.cpp.
References QMessageDialogOptions::informativeText().
|
signal |
|
overrideprotectedvirtual |
Called at the end of \l create().
Reimplemented from QQuickAbstractDialog.
Definition at line 226 of file qquickmessagedialog.cpp.
References QPlatformMessageDialogHelper::clicked(), QObject::connect(), and dialog.
|
overrideprotectedvirtual |
Called by \l open(), after the call to \l create() and before the handle/helper's show
function is called.
Reimplemented from QQuickAbstractDialog.
Definition at line 236 of file qquickmessagedialog.cpp.
References dialog, QMessageDialogOptions::setWindowTitle(), and QQuickAbstractDialog::title.
void QQuickMessageDialog::setButtons | ( | QPlatformDialogHelper::StandardButtons | buttons | ) |
Definition at line 208 of file qquickmessagedialog.cpp.
References buttons, buttonsChanged(), emit, QMessageDialogOptions::setStandardButtons(), and QMessageDialogOptions::standardButtons().
Definition at line 163 of file qquickmessagedialog.cpp.
References QMessageDialogOptions::detailedText(), detailedTextChanged(), emit, QMessageDialogOptions::setDetailedText(), and text.
Definition at line 141 of file qquickmessagedialog.cpp.
References emit, QMessageDialogOptions::informativeText(), informativeTextChanged(), QMessageDialogOptions::setInformativeText(), and text.
Definition at line 117 of file qquickmessagedialog.cpp.
References emit, QMessageDialogOptions::setText(), QMessageDialogOptions::text(), text, and textChanged().
QString QQuickMessageDialog::text | ( | ) | const |
\qmlproperty string QtQuick.Dialogs::MessageDialog::text
This property holds the text to be displayed on the message dialog.
Definition at line 112 of file qquickmessagedialog.cpp.
References QMessageDialogOptions::text().
|
signal |
|
readwrite |
Definition at line 30 of file qquickmessagedialog_p.h.
Referenced by setButtons().
|
readwrite |
Definition at line 29 of file qquickmessagedialog_p.h.
|
readwrite |
Definition at line 28 of file qquickmessagedialog_p.h.
|
readwrite |
Definition at line 27 of file qquickmessagedialog_p.h.
Referenced by setDetailedText(), setInformativeText(), and setText().