Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#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 (int result) |
\qmlmethod void QtQuick.Dialogs::Dialog::done(int result) | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals | |
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 | |
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 Types | |
enum class | CreateOptions { TryAllDialogTypes = 0 , DontTryNativeDialog = 1 } |
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 (CreateOptions=CreateOptions::TryAllDialogTypes) |
void | destroy () |
virtual bool | useNativeDialog () const |
virtual void | onCreate (QPlatformDialogHelper *dialog) |
virtual void | onShow (QPlatformDialogHelper *dialog) |
virtual void | onHide (QPlatformDialogHelper *dialog) |
virtual int | dialogCode () const |
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) | |
Protected Attributes | |
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 |
Properties | |
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 | |
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) |
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 38 of file qquickabstractdialog_p.h.
|
strongprotected |
Enumerator | |
---|---|
TryAllDialogTypes | |
DontTryNativeDialog |
Definition at line 105 of file qquickabstractdialog_p.h.
Enumerator | |
---|---|
Rejected | |
Accepted |
Definition at line 78 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 | | | +-------------------+ | | m_handle->show()? |------------------->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
! \nativetype 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 113 of file qquickabstractdialog.cpp.
QQuickAbstractDialog::~QQuickAbstractDialog | ( | ) |
Definition at line 119 of file qquickabstractdialog.cpp.
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::accept()
Closes the dialog and emits the \l accepted() signal.
Reimplemented in QQuickFileDialog.
Definition at line 366 of file qquickabstractdialog.cpp.
|
signal |
|
overrideprotectedvirtual |
Invoked after class creation, but before any properties have been set.
Implements QQmlParserStatus.
Definition at line 396 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 341 of file qquickabstractdialog.cpp.
|
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 400 of file qquickabstractdialog.cpp.
|
protected |
Definition at line 434 of file qquickabstractdialog.cpp.
QQmlListProperty< QObject > QQuickAbstractDialog::data | ( | ) |
Definition at line 531 of file qquickabstractdialog.cpp.
|
protected |
Definition at line 461 of file qquickabstractdialog.cpp.
|
protectedvirtual |
Reimplemented in QQuickMessageDialog.
Definition at line 508 of file qquickabstractdialog.cpp.
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::done(int result)
Closes the dialog and sets the result.
Definition at line 390 of file qquickabstractdialog.cpp.
|
protected |
Definition at line 510 of file qquickabstractdialog.cpp.
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 202 of file qquickabstractdialog.cpp.
|
signal |
QPlatformDialogHelper * QQuickAbstractDialog::handle | ( | ) | const |
Definition at line 124 of file qquickabstractdialog.cpp.
bool QQuickAbstractDialog::isVisible | ( | ) | const |
\qmlproperty bool QtQuick.Dialogs::Dialog::visible
This property holds the visibility of the dialog. The default value is false
.
Definition at line 247 of file qquickabstractdialog.cpp.
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 226 of file qquickabstractdialog.cpp.
|
signal |
|
protectedvirtual |
Called at the end of \l create().
Reimplemented in QQuickColorDialog, QQuickFileDialog, QQuickFolderDialog, QQuickFontDialog, and QQuickMessageDialog.
Definition at line 486 of file qquickabstractdialog.cpp.
|
protectedvirtual |
Reimplemented in QQuickFileDialog.
Definition at line 503 of file qquickabstractdialog.cpp.
|
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 497 of file qquickabstractdialog.cpp.
|
slot |
\qmlmethod void QtQuick.Dialogs::Dialog::open()
Opens the dialog.
Definition at line 301 of file qquickabstractdialog.cpp.
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 150 of file qquickabstractdialog.cpp.
|
signal |
|
virtualslot |
\qmlmethod void QtQuick.Dialogs::Dialog::reject()
Closes the dialog and emits the \l rejected() signal.
Definition at line 378 of file qquickabstractdialog.cpp.
|
signal |
void QQuickAbstractDialog::resetParentWindow | ( | ) |
Definition at line 167 of file qquickabstractdialog.cpp.
int QQuickAbstractDialog::result | ( | ) | const |
\qmlproperty int QtQuick.Dialogs::Dialog::result
This property holds the result code.
Standard result codes: \value Dialog.Accepted \value Dialog.Rejected
Definition at line 280 of file qquickabstractdialog.cpp.
|
signal |
void QQuickAbstractDialog::setFlags | ( | Qt::WindowFlags | flags | ) |
Definition at line 207 of file qquickabstractdialog.cpp.
void QQuickAbstractDialog::setModality | ( | Qt::WindowModality | modality | ) |
Definition at line 231 of file qquickabstractdialog.cpp.
Definition at line 155 of file qquickabstractdialog.cpp.
void QQuickAbstractDialog::setResult | ( | int | result | ) |
Definition at line 285 of file qquickabstractdialog.cpp.
Definition at line 188 of file qquickabstractdialog.cpp.
void QQuickAbstractDialog::setVisible | ( | bool | visible | ) |
Definition at line 252 of file qquickabstractdialog.cpp.
QString QQuickAbstractDialog::title | ( | ) | const |
\qmlproperty string QtQuick.Dialogs::Dialog::title
This property holds the title of the dialog.
Definition at line 183 of file qquickabstractdialog.cpp.
|
signal |
|
protectedvirtual |
Reimplemented in QQuickColorDialog, QQuickFileDialog, QQuickFolderDialog, and QQuickFontDialog.
Definition at line 466 of file qquickabstractdialog.cpp.
|
signal |
|
protected |
Definition at line 522 of file qquickabstractdialog.cpp.
|
protected |
Definition at line 129 of file qquickabstractdialog_p.h.
Definition at line 125 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 131 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 122 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 126 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 123 of file qquickabstractdialog_p.h.
Definition at line 120 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 130 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 119 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 121 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 124 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 128 of file qquickabstractdialog_p.h.
|
protected |
Definition at line 127 of file qquickabstractdialog_p.h.
|
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 42 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 45 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 46 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 43 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 48 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 44 of file qquickabstractdialog_p.h.
|
readwrite |
Definition at line 47 of file qquickabstractdialog_p.h.