![]() |
Qt 6.x
The Qt SDK
|
#include <qquickabstractdialog_p.h>
Public Types | |
enum | StandardCode { Rejected , Accepted } |
Public Slots | |
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 (StandardCode result) |
\qmlmethod void QtQuick.Dialogs::Dialog::done(StandardCode result) | |
![]() | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | accepted () |
void | rejected () |
void | parentWindowChanged () |
void | titleChanged () |
void | flagsChanged () |
void | modalityChanged () |
void | visibleChanged () |
void | resultChanged () |
![]() | |
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 | |
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) |
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) |
StandardCode | result () const |
\qmlproperty StandardCode QtQuick.Dialogs::Dialog::result | |
void | setResult (StandardCode 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 | 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) | |
Protected Attributes | |
bool | m_visibleRequested = false |
bool | m_visible = false |
bool | m_complete = false |
bool | m_firstShow = true |
StandardCode | 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 |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
Properties | |
QQmlListProperty< QObject > | data |
\qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data | |
QWindow * | parentWindow |
QString | title |
Qt::WindowFlags | flags |
Qt::WindowModality | modality |
bool | visible |
StandardCode | result |
![]() | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
![]() | |
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) |
![]() | |
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 35 of file qquickabstractdialog_p.h.
Enumerator | |
---|---|
Rejected | |
Accepted |
Definition at line 74 of file qquickabstractdialog_p.h.
|
explicit |
The base class of native dialogs.
A dialog that can be backed by different implementations.
Each dialog has a QPlatformDialogHelper handle, which is created in create():
The handle acts as an intermediary between the QML-facing dialog object and the native/widget/quick implementation:
+---------------------------+ | FileDialog created in QML | +---------------------------+ | | v +----------------------+ +------------------+ | attempt to create | +------+ |useNativeDialog()?|-----false---->| QQuickPlatformDialog |---->| done | +------------------+ | instance and set | +------+ | | m_handle to it | | +----------------------+ v ^ true | | | v | +---------------------+ | | attempt to create | | | QWindowsFileDialog- | | | Helper instance and | | | set m_handle to it | | +---------------------+ | | | v | +-----------------+ | | m_handle valid? |--------------------->false +-----------------+ | v true | +------+ | done | +------+
If QWindowsFileDialogHelper is created, it creates a native dialog. If QQuickPlatformDialog is created, it creates a non-native QQuickFileDialogImpl.
\qmltype Dialog \inherits QtObject
! \instantiates QQuickAbstractDialog \inqmlmodule QtQuick.Dialogs
The Dialog type provides common QML API for native platform dialogs. For the non-native dialog, see \l [QML QtQuickControls]{Dialog}.
To show a native dialog, construct an instance of one of the concrete Dialog implementations, set the desired properties, and call \l open(). Dialog emits \l accepted() or \l rejected() when the user is done with the dialog.
\qmlsignal void QtQuick.Dialogs::Dialog::accepted()
This signal is emitted when the dialog has been accepted either interactively or by calling \l accept().
\qmlsignal void QtQuick.Dialogs::Dialog::rejected()
This signal is emitted when the dialog has been rejected either interactively or by calling \l reject().
This signal is also emitted when closing the dialog with \l close().
Definition at line 108 of file qquickabstractdialog.cpp.
QQuickAbstractDialog::~QQuickAbstractDialog | ( | ) |
Definition at line 114 of file qquickabstractdialog.cpp.
References destroy().
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::accept()
Closes the dialog and emits the \l accepted() signal.
Reimplemented in QQuickFileDialog.
Definition at line 328 of file qquickabstractdialog.cpp.
References Accepted, and done().
Referenced by QQuickFileDialog::accept(), and create().
|
signal |
|
overrideprotectedvirtual |
Invoked after class creation, but before any properties have been set.
Implements QQmlParserStatus.
Definition at line 358 of file qquickabstractdialog.cpp.
|
slot |
\qmlmethod void QtQuick.Dialogs::Dialog::close()
Closes the dialog and emits either the \l accepted() or \l rejected() signal.
Definition at line 305 of file qquickabstractdialog.cpp.
References Accepted, accepted(), emit, m_handle, m_result, m_visible, onHide(), rejected(), and visibleChanged().
Referenced by done(), and setVisible().
|
overrideprotectedvirtual |
Invoked after the root component that caused this instantiation has completed construction.
At this point all static values and binding values have been assigned to the class.
Implements QQmlParserStatus.
Definition at line 362 of file qquickabstractdialog.cpp.
References findParentWindow(), m_complete, m_parentWindow, m_visibleRequested, open(), qCDebug, and setParentWindow().
|
protected |
Definition at line 390 of file qquickabstractdialog.cpp.
References QPlatformDialogHelper::accept(), accept(), QObject::connect(), QQuickDialogImplFactory::createPlatformDialogHelper(), m_handle, m_parentWindow, m_type, onCreate(), QGuiApplicationPrivate::platformTheme(), qCDebug, qmlTypeName(), QPlatformDialogHelper::reject(), reject(), toPlatformDialogType(), and useNativeDialog().
Referenced by open().
QQmlListProperty< QObject > QQuickAbstractDialog::data | ( | ) |
|
protected |
Definition at line 417 of file qquickabstractdialog.cpp.
References m_handle.
Referenced by ~QQuickAbstractDialog().
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::done(StandardCode result)
Closes the dialog and sets the result.
Definition at line 352 of file qquickabstractdialog.cpp.
References close(), and setResult().
Referenced by accept(), and reject().
|
protected |
Definition at line 464 of file qquickabstractdialog.cpp.
References item, QObject::parent(), QGraphicsObject::parent, qobject_cast< QQuickItem * >(), qobject_cast< QWindow * >(), window(), and QGraphicsItem::window().
Referenced by componentComplete().
Qt::WindowFlags QQuickAbstractDialog::flags | ( | ) | const |
\qmlproperty Qt::WindowFlags QtQuick.Dialogs::Dialog::flags
This property holds the window flags of the dialog. The default value is Qt.Dialog
.
Definition at line 184 of file qquickabstractdialog.cpp.
References m_flags.
|
signal |
QPlatformDialogHelper * QQuickAbstractDialog::handle | ( | ) | const |
Definition at line 119 of file qquickabstractdialog.cpp.
References m_handle.
Referenced by QQuickFileDialog::accept(), QQuickFileDialog::currentFolder(), QQuickFolderDialog::currentFolder(), QQuickFolderDialog::selectedFolder(), QQuickFileDialog::setCurrentFolder(), and QQuickFolderDialog::setSelectedFolder().
bool QQuickAbstractDialog::isVisible | ( | ) | const |
Qt::WindowModality QQuickAbstractDialog::modality | ( | ) | const |
\qmlproperty Qt::WindowModality QtQuick.Dialogs::Dialog::modality
This property holds the modality of the dialog. The default value is Qt.WindowModal
.
Available values: \value Qt.NonModal The dialog is not modal and does not block input to other windows. \value Qt.WindowModal The dialog is modal to a single window hierarchy and blocks input to its parent window, all grandparent windows, and all siblings of its parent and grandparent windows. \value Qt.ApplicationModal The dialog is modal to the application and blocks input to all windows.
Definition at line 208 of file qquickabstractdialog.cpp.
References m_modality.
|
signal |
|
protectedvirtual |
Called at the end of \l create().
Reimplemented in QQuickColorDialog, QQuickFileDialog, QQuickFolderDialog, QQuickFontDialog, and QQuickMessageDialog.
Definition at line 442 of file qquickabstractdialog.cpp.
References dialog, and Q_UNUSED.
Referenced by create().
|
protectedvirtual |
Reimplemented in QQuickFileDialog.
Definition at line 459 of file qquickabstractdialog.cpp.
References dialog, and Q_UNUSED.
Referenced by close().
|
protectedvirtual |
Called by \l open(), after the call to \l create() and before the handle/helper's show
function is called.
Reimplemented in QQuickColorDialog, QQuickFileDialog, QQuickFolderDialog, QQuickFontDialog, and QQuickMessageDialog.
Definition at line 453 of file qquickabstractdialog.cpp.
References dialog, m_firstShow, and Q_UNUSED.
Referenced by QQuickColorDialog::onShow(), QQuickFileDialog::onShow(), QQuickFolderDialog::onShow(), QQuickFontDialog::onShow(), and open().
|
slot |
\qmlmethod void QtQuick.Dialogs::Dialog::open()
Opens the dialog.
Definition at line 283 of file qquickabstractdialog.cpp.
References create(), emit, m_flags, m_handle, m_modality, m_parentWindow, m_result, m_visible, onShow(), qCDebug, Rejected, and visibleChanged().
Referenced by componentComplete(), and setVisible().
QWindow * QQuickAbstractDialog::parentWindow | ( | ) | const |
\qmlproperty Window QtQuick.Dialogs::Dialog::parentWindow
This property holds the parent window of the dialog.
Unless explicitly set, the window is automatically resolved by iterating the QML parent objects until a \l Window or an \l Item that has a window is found.
Definition at line 145 of file qquickabstractdialog.cpp.
References m_parentWindow.
|
signal |
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::reject()
Closes the dialog and emits the \l rejected() signal.
Definition at line 340 of file qquickabstractdialog.cpp.
References done(), and Rejected.
Referenced by create().
|
signal |
QQuickAbstractDialog::StandardCode QQuickAbstractDialog::result | ( | ) | const |
\qmlproperty StandardCode QtQuick.Dialogs::Dialog::result
This property holds the result code.
Standard result codes: \value Dialog.Accepted \value Dialog.Rejected
Definition at line 262 of file qquickabstractdialog.cpp.
References m_result.
|
signal |
void QQuickAbstractDialog::setFlags | ( | Qt::WindowFlags | flags | ) |
Definition at line 189 of file qquickabstractdialog.cpp.
References emit, flags, flagsChanged(), and m_flags.
void QQuickAbstractDialog::setModality | ( | Qt::WindowModality | modality | ) |
Definition at line 213 of file qquickabstractdialog.cpp.
References emit, m_modality, modality, and modalityChanged().
Definition at line 150 of file qquickabstractdialog.cpp.
References emit, m_parentWindow, parentWindowChanged(), qCDebug, and window().
Referenced by componentComplete().
void QQuickAbstractDialog::setResult | ( | StandardCode | result | ) |
Definition at line 267 of file qquickabstractdialog.cpp.
References emit, m_result, result, and resultChanged().
Referenced by done().
Definition at line 170 of file qquickabstractdialog.cpp.
References emit, m_title, title, and titleChanged().
void QQuickAbstractDialog::setVisible | ( | bool | visible | ) |
Definition at line 234 of file qquickabstractdialog.cpp.
References close(), m_complete, m_visibleRequested, open(), qCDebug, and visible.
QString QQuickAbstractDialog::title | ( | ) | const |
\qmlproperty string QtQuick.Dialogs::Dialog::title
This property holds the title of the dialog.
Definition at line 165 of file qquickabstractdialog.cpp.
References m_title.
|
signal |
|
protectedvirtual |
Reimplemented in QQuickColorDialog, QQuickFileDialog, QQuickFolderDialog, and QQuickFontDialog.
Definition at line 422 of file qquickabstractdialog.cpp.
References Qt::AA_DontUseNativeDialogs, m_type, QGuiApplicationPrivate::platformTheme(), qCDebug, QCoreApplication::testAttribute(), and toPlatformDialogType().
Referenced by create(), QQuickColorDialog::useNativeDialog(), QQuickFileDialog::useNativeDialog(), QQuickFolderDialog::useNativeDialog(), and QQuickFontDialog::useNativeDialog().
|
signal |
|
protected |
Definition at line 113 of file qquickabstractdialog_p.h.
Referenced by componentComplete(), and setVisible().
Definition at line 121 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 114 of file qquickabstractdialog_p.h.
Referenced by onShow(), QQuickFileDialog::onShow(), and QQuickFolderDialog::onShow().
|
protected |
Definition at line 118 of file qquickabstractdialog_p.h.
Referenced by flags(), open(), and setFlags().
|
protected |
Definition at line 122 of file qquickabstractdialog_p.h.
Referenced by close(), create(), destroy(), handle(), isVisible(), and open().
|
protected |
Definition at line 119 of file qquickabstractdialog_p.h.
Referenced by modality(), open(), and setModality().
Definition at line 116 of file qquickabstractdialog_p.h.
Referenced by componentComplete(), create(), open(), parentWindow(), and setParentWindow().
|
protected |
Definition at line 115 of file qquickabstractdialog_p.h.
Referenced by close(), open(), result(), and setResult().
|
protected |
Definition at line 117 of file qquickabstractdialog_p.h.
Referenced by setTitle(), and title().
|
protected |
Definition at line 120 of file qquickabstractdialog_p.h.
Referenced by create(), and useNativeDialog().
|
protected |
Definition at line 112 of file qquickabstractdialog_p.h.
Referenced by close(), isVisible(), and open().
|
protected |
Definition at line 111 of file qquickabstractdialog_p.h.
Referenced by componentComplete(), and setVisible().
|
read |
\qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data
This default property holds the list of all objects declared as children of the dialog.
Definition at line 125 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
Referenced by setFlags().
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
Referenced by setModality().
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
Referenced by setResult().
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
Referenced by QQuickColorDialog::onShow(), QQuickFileDialog::onShow(), QQuickFolderDialog::onShow(), QQuickFontDialog::onShow(), QQuickMessageDialog::onShow(), and setTitle().
|
readwrite |
Definition at line 125 of file qquickabstractdialog_p.h.
Referenced by setVisible().