![]() |
Qt 6.x
The Qt SDK
|
#include <qquicklabsplatformmessagedialog_p.h>
Public Member Functions | |
QQuickLabsPlatformMessageDialog (QObject *parent=nullptr) | |
A native message dialog. | |
QString | text () const |
\qmlproperty string Qt.labs.platform::MessageDialog::text | |
void | setText (const QString &text) |
QString | informativeText () const |
\qmlproperty string Qt.labs.platform::MessageDialog::informativeText | |
void | setInformativeText (const QString &text) |
QString | detailedText () const |
\qmlproperty string Qt.labs.platform::MessageDialog::detailedText | |
void | setDetailedText (const QString &text) |
QPlatformDialogHelper::StandardButtons | buttons () const |
\qmlproperty flags Qt.labs.platform::MessageDialog::buttons | |
void | setButtons (QPlatformDialogHelper::StandardButtons buttons) |
![]() | |
QQuickLabsPlatformDialog (QPlatformTheme::DialogType type, QObject *parent=nullptr) | |
The base class of native dialogs. | |
~QQuickLabsPlatformDialog () | |
QPlatformDialogHelper * | handle () const |
QQmlListProperty< QObject > | data () |
QWindow * | parentWindow () const |
\qmlproperty Window Qt.labs.platform::Dialog::parentWindow | |
void | setParentWindow (QWindow *window) |
QString | title () const |
\qmlproperty string Qt.labs.platform::Dialog::title | |
void | setTitle (const QString &title) |
Qt::WindowFlags | flags () const |
\qmlproperty Qt::WindowFlags Qt.labs.platform::Dialog::flags | |
void | setFlags (Qt::WindowFlags flags) |
Qt::WindowModality | modality () const |
\qmlproperty Qt::WindowModality Qt.labs.platform::Dialog::modality | |
void | setModality (Qt::WindowModality modality) |
bool | isVisible () const |
\qmlproperty bool Qt.labs.platform::Dialog::visible | |
void | setVisible (bool visible) |
int | result () const |
\qmlproperty int Qt.labs.platform::Dialog::result | |
void | setResult (int result) |
![]() | |
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. | |
void | moveToThread (QThread *thread) |
Changes the thread affinity for this object and its children. | |
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
template<typename T > | |
T | findChild (const QString &aName=QString(), 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 (const QString &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 > | |
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 . | |
![]() | |
QQmlParserStatus () | |
virtual | ~QQmlParserStatus () |
virtual void | classBegin ()=0 |
Invoked after class creation, but before any properties have been set. | |
virtual void | componentComplete ()=0 |
Invoked after the root component that caused this instantiation has completed construction. | |
Protected Member Functions | |
void | onCreate (QPlatformDialogHelper *dialog) override |
void | onShow (QPlatformDialogHelper *dialog) override |
![]() | |
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 | onCreate (QPlatformDialogHelper *dialog) |
virtual void | onShow (QPlatformDialogHelper *dialog) |
virtual void | onHide (QPlatformDialogHelper *dialog) |
QWindow * | findParentWindow () const |
![]() | |
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 |
![]() | |
QQmlListProperty< QObject > | data |
\qmldefault \qmlproperty list<QtObject> Qt.labs.platform::Dialog::data | |
QWindow * | parentWindow |
QString | title |
Qt::WindowFlags | flags |
Qt::WindowModality | modality |
bool | visible |
int | result |
![]() | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
![]() | |
enum | StandardCode { Rejected , Accepted } |
![]() | |
void | open () |
\qmlmethod void Qt.labs.platform::Dialog::open() | |
void | close () |
\qmlmethod void Qt.labs.platform::Dialog::close() | |
virtual void | accept () |
\qmlmethod void Qt.labs.platform::Dialog::accept() | |
virtual void | reject () |
\qmlmethod void Qt.labs.platform::Dialog::reject() | |
virtual void | done (int result) |
\qmlmethod void Qt.labs.platform::Dialog::done(int result) | |
![]() | |
void | deleteLater () |
\threadsafe | |
![]() | |
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) |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
![]() | |
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 23 of file qquicklabsplatformmessagedialog_p.h.
|
explicit |
A native message dialog.
\qmltype MessageDialog \inherits Dialog
! \instantiates QQuickLabsPlatformMessageDialog \inqmlmodule Qt.labs.platform
The MessageDialog type provides a QML API for native platform 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 modal message dialog blocks the rest of the GUI until the message is dismissed.
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. The display order for the buttons is platform dependent.
The \l clicked() signal passes the information of which button was clicked.
A native platform message dialog is currently available on the following platforms:
\list
\input includes/widgets.qdocinc 1
\labs
\qmlsignal Qt.labs.platform::MessageDialog::clicked(button)
This signal is emitted when a dialog button is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::okClicked()
This signal is emitted when \uicontrol Ok is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::saveClicked()
This signal is emitted when \uicontrol Save is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::saveAllClicked()
This signal is emitted when \uicontrol {Save All} is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::openClicked()
This signal is emitted when \uicontrol Open is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::yesClicked()
This signal is emitted when \uicontrol Yes is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::yesToAllClicked()
This signal is emitted when \uicontrol {Yes To All} is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::noClicked()
This signal is emitted when \uicontrol No is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::noToAllClicked()
This signal is emitted when \uicontrol {No To All} is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::abortClicked()
This signal is emitted when \uicontrol Abort is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::retryClicked()
This signal is emitted when \uicontrol Retry is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::ignoreClicked()
This signal is emitted when \uicontrol Ignore is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::closeClicked()
This signal is emitted when \uicontrol Close is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::cancelClicked()
This signal is emitted when \uicontrol Cancel is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::discardClicked()
This signal is emitted when \uicontrol Discard is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::helpClicked()
This signal is emitted when \uicontrol Help is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::applyClicked()
This signal is emitted when \uicontrol Apply is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::resetClicked()
This signal is emitted when \uicontrol Reset is clicked.
\qmlsignal Qt.labs.platform::MessageDialog::restoreDefaultsClicked()
This signal is emitted when \uicontrol {Restore Defaults} is clicked.
Definition at line 193 of file qquicklabsplatformmessagedialog.cpp.
|
signal |
|
signal |
QPlatformDialogHelper::StandardButtons QQuickLabsPlatformMessageDialog::buttons | ( | ) | const |
\qmlproperty flags Qt.labs.platform::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 293 of file qquicklabsplatformmessagedialog.cpp.
References QMessageDialogOptions::standardButtons().
|
signal |
|
signal |
|
signal |
|
signal |
QString QQuickLabsPlatformMessageDialog::detailedText | ( | ) | const |
\qmlproperty string Qt.labs.platform::MessageDialog::detailedText
This property holds the text to be displayed in the details area.
Definition at line 250 of file qquicklabsplatformmessagedialog.cpp.
References QMessageDialogOptions::detailedText().
|
signal |
|
signal |
|
signal |
|
signal |
QString QQuickLabsPlatformMessageDialog::informativeText | ( | ) | const |
\qmlproperty string Qt.labs.platform::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 229 of file qquicklabsplatformmessagedialog.cpp.
References QMessageDialogOptions::informativeText().
|
signal |
|
signal |
|
signal |
|
signal |
|
overrideprotectedvirtual |
Reimplemented from QQuickLabsPlatformDialog.
Definition at line 307 of file qquicklabsplatformmessagedialog.cpp.
References QPlatformMessageDialogHelper::clicked(), QObject::connect(), and dialog.
|
overrideprotectedvirtual |
Reimplemented from QQuickLabsPlatformDialog.
Definition at line 315 of file qquicklabsplatformmessagedialog.cpp.
References dialog, QMessageDialogOptions::setWindowTitle(), and QQuickLabsPlatformDialog::title.
|
signal |
|
signal |
|
signal |
|
signal |
|
signal |
|
signal |
void QQuickLabsPlatformMessageDialog::setButtons | ( | QPlatformDialogHelper::StandardButtons | buttons | ) |
Definition at line 298 of file qquicklabsplatformmessagedialog.cpp.
References buttons, buttonsChanged(), emit, QMessageDialogOptions::setStandardButtons(), and QMessageDialogOptions::standardButtons().
Definition at line 255 of file qquicklabsplatformmessagedialog.cpp.
References QMessageDialogOptions::detailedText(), detailedTextChanged(), emit, QMessageDialogOptions::setDetailedText(), and text.
Definition at line 234 of file qquicklabsplatformmessagedialog.cpp.
References emit, QMessageDialogOptions::informativeText(), informativeTextChanged(), QMessageDialogOptions::setInformativeText(), and text.
Definition at line 211 of file qquicklabsplatformmessagedialog.cpp.
References emit, QMessageDialogOptions::setText(), QMessageDialogOptions::text(), text, and textChanged().
QString QQuickLabsPlatformMessageDialog::text | ( | ) | const |
\qmlproperty string Qt.labs.platform::MessageDialog::text
This property holds the text to be displayed on the message dialog.
Definition at line 206 of file qquicklabsplatformmessagedialog.cpp.
References QMessageDialogOptions::text().
|
signal |
|
signal |
|
signal |
|
readwrite |
Definition at line 85 of file qquicklabsplatformmessagedialog_p.h.
Referenced by setButtons().
|
readwrite |
Definition at line 85 of file qquicklabsplatformmessagedialog_p.h.
|
readwrite |
Definition at line 85 of file qquicklabsplatformmessagedialog_p.h.
|
readwrite |
Definition at line 85 of file qquicklabsplatformmessagedialog_p.h.
Referenced by setDetailedText(), setInformativeText(), and setText().