#include <qquicklabsplatformdialog_p.h>

Inheritance diagram for QQuickLabsPlatformDialog:

Collaboration diagram for QQuickLabsPlatformDialog:

Public Types
enum	StandardCode { Rejected , Accepted }

Public Slots
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)

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
	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)

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	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

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
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

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)

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)

Detailed Description

Definition at line 31 of file qquicklabsplatformdialog_p.h.

Member Enumeration Documentation

◆ StandardCode

enum QQuickLabsPlatformDialog::StandardCode

Enumerator
Rejected
Accepted

Definition at line 69 of file qquicklabsplatformdialog_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformDialog()

QT_BEGIN_NAMESPACE QQuickLabsPlatformDialog::QQuickLabsPlatformDialog	(	QPlatformTheme::DialogType	type,
		QObject *	parent = nullptr )

explicit

The base class of native dialogs.

\qmltype Dialog
\inherits QtObject

! \nativetype QQuickLabsPlatformDialog \inqmlmodule Qt.labs.platform

Since: 5.8

The Dialog type provides common QML API for native platform dialogs.

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.

\labs

\qmlsignal void Qt.labs.platform::Dialog::accepted()

This signal is emitted when the dialog has been accepted either interactively or by calling \l accept().

Note: This signal is not emitted when closing the dialog with \l close().

See also: rejected()

\qmlsignal void Qt.labs.platform::Dialog::rejected()

This signal is emitted when the dialog has been rejected either interactively or by calling \l reject().

Note: This signal is not emitted when closing the dialog with \l close().

See also: accepted()

Definition at line 57 of file qquicklabsplatformdialog.cpp.

◆ ~QQuickLabsPlatformDialog()

QQuickLabsPlatformDialog::~QQuickLabsPlatformDialog ( )

Definition at line 70 of file qquicklabsplatformdialog.cpp.

References destroy().

Here is the call graph for this function:

Member Function Documentation

◆ accept

void QQuickLabsPlatformDialog::accept ( )

virtualslot

\qmlmethod void Qt.labs.platform::Dialog::accept()

Closes the dialog and emits the \l accepted() signal.

See also: reject()

Reimplemented in QQuickLabsPlatformColorDialog, QQuickLabsPlatformFileDialog, QQuickLabsPlatformFolderDialog, and QQuickLabsPlatformFontDialog.

Definition at line 266 of file qquicklabsplatformdialog.cpp.

References Accepted, and done().

Referenced by QQuickLabsPlatformColorDialog::accept(), QQuickLabsPlatformFileDialog::accept(), QQuickLabsPlatformFolderDialog::accept(), and QQuickLabsPlatformFontDialog::accept().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accepted

void QQuickLabsPlatformDialog::accepted ( )

signal

◆ classBegin()

void QQuickLabsPlatformDialog::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 301 of file qquicklabsplatformdialog.cpp.

◆ close

void QQuickLabsPlatformDialog::close ( )

slot

\qmlmethod void Qt.labs.platform::Dialog::close()

Closes the dialog.

See also: visible, open()

Definition at line 248 of file qquicklabsplatformdialog.cpp.

References onHide().

Referenced by done(), and setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ componentComplete()

void QQuickLabsPlatformDialog::componentComplete ( )

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 305 of file qquicklabsplatformdialog.cpp.

References findParentWindow(), and setParentWindow().

Here is the call graph for this function:

◆ create()

bool QQuickLabsPlatformDialog::create ( )

protected

Definition at line 317 of file qquicklabsplatformdialog.cpp.

References onCreate().

Referenced by open().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

QQmlListProperty< QObject > QQuickLabsPlatformDialog::data ( )

◆ destroy()

void QQuickLabsPlatformDialog::destroy ( )

protected

Definition at line 334 of file qquicklabsplatformdialog.cpp.

Referenced by ~QQuickLabsPlatformDialog().

Here is the caller graph for this function:

◆ done

void QQuickLabsPlatformDialog::done ( int result )

virtualslot

\qmlmethod void Qt.labs.platform::Dialog::done(int result)

Closes the dialog and sets the result.

See also: accept(), reject(), result

Definition at line 290 of file qquicklabsplatformdialog.cpp.

References Accepted, close(), Rejected, and setResult().

Referenced by accept(), and reject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findParentWindow()

QWindow * QQuickLabsPlatformDialog::findParentWindow ( ) const

protected

Definition at line 361 of file qquicklabsplatformdialog.cpp.

Referenced by componentComplete().

Here is the caller graph for this function:

◆ flags()

Qt::WindowFlags QQuickLabsPlatformDialog::flags ( ) const

\qmlproperty Qt::WindowFlags Qt.labs.platform::Dialog::flags

This property holds the window flags of the dialog. The default value is Qt.Dialog.

Definition at line 139 of file qquicklabsplatformdialog.cpp.

◆ flagsChanged

void QQuickLabsPlatformDialog::flagsChanged ( )

signal

◆ handle()

QPlatformDialogHelper * QQuickLabsPlatformDialog::handle ( ) const

Definition at line 75 of file qquicklabsplatformdialog.cpp.

◆ isVisible()

bool QQuickLabsPlatformDialog::isVisible ( ) const

\qmlproperty bool Qt.labs.platform::Dialog::visible

This property holds the visibility of the dialog. The default value is false.

See also: open(), close()

Definition at line 184 of file qquicklabsplatformdialog.cpp.

◆ modality()

Qt::WindowModality QQuickLabsPlatformDialog::modality ( ) const

\qmlproperty Qt::WindowModality Qt.labs.platform::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 163 of file qquicklabsplatformdialog.cpp.

◆ modalityChanged

void QQuickLabsPlatformDialog::modalityChanged ( )

signal

◆ onCreate()

void QQuickLabsPlatformDialog::onCreate ( QPlatformDialogHelper * dialog )

protectedvirtual

Reimplemented in QQuickLabsPlatformColorDialog, QQuickLabsPlatformFileDialog, QQuickLabsPlatformFolderDialog, QQuickLabsPlatformFontDialog, and QQuickLabsPlatformMessageDialog.

Definition at line 346 of file qquicklabsplatformdialog.cpp.

Referenced by create().

Here is the caller graph for this function:

◆ onHide()

void QQuickLabsPlatformDialog::onHide ( QPlatformDialogHelper * dialog )

protectedvirtual

Reimplemented in QQuickLabsPlatformFileDialog.

Definition at line 356 of file qquicklabsplatformdialog.cpp.

Referenced by close().

Here is the caller graph for this function:

◆ onShow()

void QQuickLabsPlatformDialog::onShow ( QPlatformDialogHelper * dialog )

protectedvirtual

Reimplemented in QQuickLabsPlatformColorDialog, QQuickLabsPlatformFileDialog, QQuickLabsPlatformFolderDialog, QQuickLabsPlatformFontDialog, and QQuickLabsPlatformMessageDialog.

Definition at line 351 of file qquicklabsplatformdialog.cpp.

Referenced by open().

Here is the caller graph for this function:

◆ open

void QQuickLabsPlatformDialog::open ( )

slot

\qmlmethod void Qt.labs.platform::Dialog::open()

Opens the dialog.

See also: visible, close()

Definition at line 230 of file qquicklabsplatformdialog.cpp.

References create(), and onShow().

Here is the call graph for this function:

◆ parentWindow()

QWindow * QQuickLabsPlatformDialog::parentWindow ( ) const

\qmlproperty Window Qt.labs.platform::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 101 of file qquicklabsplatformdialog.cpp.

◆ parentWindowChanged

void QQuickLabsPlatformDialog::parentWindowChanged ( )

signal

◆ reject

void QQuickLabsPlatformDialog::reject ( )

virtualslot

\qmlmethod void Qt.labs.platform::Dialog::reject()

Closes the dialog and emits the \l rejected() signal.

See also: accept()

Definition at line 278 of file qquicklabsplatformdialog.cpp.

References done(), and Rejected.

Here is the call graph for this function:

◆ rejected

void QQuickLabsPlatformDialog::rejected ( )

signal

◆ result()

int QQuickLabsPlatformDialog::result ( ) const

\qmlproperty int Qt.labs.platform::Dialog::result

This property holds the result code.

Standard result codes: \value Dialog.Accepted \value Dialog.Rejected

Note: MessageDialog sets the result to the value of the clicked standard button instead of using the standard result codes.

Definition at line 209 of file qquicklabsplatformdialog.cpp.

◆ resultChanged

void QQuickLabsPlatformDialog::resultChanged ( )

signal

◆ setFlags()

void QQuickLabsPlatformDialog::setFlags ( Qt::WindowFlags flags )

Definition at line 144 of file qquicklabsplatformdialog.cpp.

◆ setModality()

void QQuickLabsPlatformDialog::setModality ( Qt::WindowModality modality )

Definition at line 168 of file qquicklabsplatformdialog.cpp.

◆ setParentWindow()

void QQuickLabsPlatformDialog::setParentWindow ( QWindow * window )

Definition at line 106 of file qquicklabsplatformdialog.cpp.

Referenced by componentComplete().

Here is the caller graph for this function:

◆ setResult()

void QQuickLabsPlatformDialog::setResult ( int result )

Definition at line 214 of file qquicklabsplatformdialog.cpp.

Referenced by done().

Here is the caller graph for this function:

◆ setTitle()

void QQuickLabsPlatformDialog::setTitle ( const QString & title )

Definition at line 125 of file qquicklabsplatformdialog.cpp.

◆ setVisible()

void QQuickLabsPlatformDialog::setVisible ( bool visible )

Definition at line 189 of file qquicklabsplatformdialog.cpp.

References close().

Here is the call graph for this function:

◆ title()

QString QQuickLabsPlatformDialog::title ( ) const

\qmlproperty string Qt.labs.platform::Dialog::title

This property holds the title of the dialog.

Definition at line 120 of file qquicklabsplatformdialog.cpp.

◆ titleChanged

void QQuickLabsPlatformDialog::titleChanged ( )

signal

◆ useNativeDialog()

bool QQuickLabsPlatformDialog::useNativeDialog ( ) const

protectedvirtual

Reimplemented in QQuickLabsPlatformColorDialog, QQuickLabsPlatformFileDialog, QQuickLabsPlatformFolderDialog, and QQuickLabsPlatformFontDialog.

Definition at line 340 of file qquicklabsplatformdialog.cpp.

◆ visibleChanged

void QQuickLabsPlatformDialog::visibleChanged ( )

signal

Property Documentation

◆ data

QQmlListProperty< QObject > QQuickLabsPlatformDialog::data

read

\qmldefault \qmlproperty list<QtObject> Qt.labs.platform::Dialog::data

This default property holds the list of all objects declared as children of the dialog.

Definition at line 37 of file qquicklabsplatformdialog_p.h.

◆ flags

Qt::WindowFlags QQuickLabsPlatformDialog::flags

readwrite

Definition at line 40 of file qquicklabsplatformdialog_p.h.

◆ modality

Qt::WindowModality QQuickLabsPlatformDialog::modality

readwrite

Definition at line 41 of file qquicklabsplatformdialog_p.h.

◆ parentWindow

QWindow * QQuickLabsPlatformDialog::parentWindow

readwrite

Definition at line 38 of file qquicklabsplatformdialog_p.h.

◆ result

int QQuickLabsPlatformDialog::result

readwrite

Definition at line 43 of file qquicklabsplatformdialog_p.h.

◆ title

QString QQuickLabsPlatformDialog::title

readwrite

Definition at line 39 of file qquicklabsplatformdialog_p.h.

◆ visible

bool QQuickLabsPlatformDialog::visible

readwrite

Definition at line 42 of file qquicklabsplatformdialog_p.h.

The documentation for this class was generated from the following files:

qtdeclarative/src/labs/platform/qquicklabsplatformdialog_p.h (9dbc9fc2648d2a6960b6fb39650a494423a49949)
qtdeclarative/src/labs/platform/qquicklabsplatformdialog.cpp (a464ff5bfa15201de64d05121dc192dbd4655890)

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ StandardCode

Constructor & Destructor Documentation

◆ QQuickLabsPlatformDialog()

◆ ~QQuickLabsPlatformDialog()

Member Function Documentation

◆ accept

◆ accepted

◆ classBegin()

◆ close

◆ componentComplete()

◆ create()

◆ data()

◆ destroy()

◆ done

◆ findParentWindow()

◆ flags()

◆ flagsChanged

◆ handle()

◆ isVisible()

◆ modality()

◆ modalityChanged

◆ onCreate()

◆ onHide()

◆ onShow()

◆ open

◆ parentWindow()

◆ parentWindowChanged

◆ reject

◆ rejected

◆ result()

◆ resultChanged

◆ setFlags()

◆ setModality()

◆ setParentWindow()

◆ setResult()

◆ setTitle()

◆ setVisible()

◆ title()

◆ titleChanged

◆ useNativeDialog()

◆ visibleChanged

Property Documentation

◆ data

◆ flags

◆ modality

◆ parentWindow

◆ result

◆ title

◆ visible