#include <qquicklabsplatformcolordialog_p.h>

Inheritance diagram for QQuickLabsPlatformColorDialog:

Collaboration diagram for QQuickLabsPlatformColorDialog:

Signals
void	colorChanged ()

void	currentColorChanged ()

void	optionsChanged ()

Signals inherited from QQuickLabsPlatformDialog
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
	QQuickLabsPlatformColorDialog (QObject *parent=nullptr)
	A native color dialog.

QColor	color () const
	\qmlproperty color Qt.labs.platform::ColorDialog::color

void	setColor (const QColor &color)

QColor	currentColor () const
	\qmlproperty color Qt.labs.platform::ColorDialog::currentColor

void	setCurrentColor (const QColor &color)

QColorDialogOptions::ColorDialogOptions	options () const
	\qmlproperty flags Qt.labs.platform::ColorDialog::options

void	setOptions (QColorDialogOptions::ColorDialogOptions options)

Public Member Functions inherited from QQuickLabsPlatformDialog
	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
bool	useNativeDialog () const override

void	onCreate (QPlatformDialogHelper *dialog) override

void	onShow (QPlatformDialogHelper *dialog) override

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

Protected Member Functions inherited from QQuickLabsPlatformDialog
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 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
QColor	color

QColor	currentColor

QColorDialogOptions::ColorDialogOptions	options

Properties inherited from QQuickLabsPlatformDialog
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
Public Types inherited from QQuickLabsPlatformDialog
enum	StandardCode { Rejected , Accepted }

Public Slots inherited from QQuickLabsPlatformDialog
void	open ()
	\qmlmethod void Qt.labs.platform::Dialog::open()

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

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

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 24 of file qquicklabsplatformcolordialog_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformColorDialog()

QT_BEGIN_NAMESPACE QQuickLabsPlatformColorDialog::QQuickLabsPlatformColorDialog ( QObject * parent = nullptr )

explicit

A native color dialog.

\qmltype ColorDialog
\inherits Dialog

! \instantiates QQuickLabsPlatformColorDialog \inqmlmodule Qt.labs.platform

Since: 5.8

The ColorDialog type provides a QML API for native platform color dialogs.

To show a color dialog, construct an instance of ColorDialog, set the desired properties, and call \l {Dialog::}{open()}. The \l currentColor property can be used to determine the currently selected color in the dialog. The \l color property is updated only after the final selection has been made by accepting the dialog.

MenuItem {
    text: "Color"
    onTriggered: colorDialog.open()
}
 
ColorDialog {
    id: colorDialog
    currentColor: document.color
}
 
MyDocument {
    id: document
    color: colorDialog.color
}

Definition at line 58 of file qquicklabsplatformcolordialog.cpp.

Member Function Documentation

◆ accept()

void QQuickLabsPlatformColorDialog::accept ( )

overrideprotectedvirtual

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

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

See also: reject()

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 168 of file qquicklabsplatformcolordialog.cpp.

References QQuickLabsPlatformDialog::accept(), currentColor, and setColor().

Here is the call graph for this function:

◆ color()

QColor QQuickLabsPlatformColorDialog::color ( ) const

\qmlproperty color Qt.labs.platform::ColorDialog::color

This property holds the final accepted color.

Unlike the \l currentColor property, the color property is not updated while the user is selecting colors in the dialog, but only after the final selection has been made. That is, when the user has clicked \uicontrol OK to accept a color. Alternatively, the \l {Dialog::}{accepted()} signal can be handled to get the final selection.

See also: currentColor, {Dialog::}{accepted()}

Definition at line 77 of file qquicklabsplatformcolordialog.cpp.

◆ colorChanged

void QQuickLabsPlatformColorDialog::colorChanged ( )

signal

Referenced by setColor().

Here is the caller graph for this function:

◆ currentColor()

QColor QQuickLabsPlatformColorDialog::currentColor ( ) const

\qmlproperty color Qt.labs.platform::ColorDialog::currentColor

This property holds the currently selected color in the dialog.

Unlike the \l color property, the currentColor property is updated while the user is selecting colors in the dialog, even before the final selection has been made.

See also: color

Definition at line 103 of file qquicklabsplatformcolordialog.cpp.

References QQuickLabsPlatformDialog::handle().

Here is the call graph for this function:

◆ currentColorChanged

void QQuickLabsPlatformColorDialog::currentColorChanged ( )

signal

Referenced by onCreate().

Here is the caller graph for this function:

◆ onCreate()

void QQuickLabsPlatformColorDialog::onCreate ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 152 of file qquicklabsplatformcolordialog.cpp.

References QObject::connect(), currentColorChanged(), QPlatformColorDialogHelper::currentColorChanged(), and dialog.

Here is the call graph for this function:

◆ onShow()

void QQuickLabsPlatformColorDialog::onShow ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 161 of file qquicklabsplatformcolordialog.cpp.

References dialog, and QQuickLabsPlatformDialog::title.

◆ options()

QColorDialogOptions::ColorDialogOptions QQuickLabsPlatformColorDialog::options ( ) const

\qmlproperty flags Qt.labs.platform::ColorDialog::options

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Available options: \value ColorDialog.ShowAlphaChannel Allow the user to select the alpha component of a color. \value ColorDialog.NoButtons Don't display \uicontrol OK and \uicontrol Cancel buttons (useful for "live dialogs").

Definition at line 132 of file qquicklabsplatformcolordialog.cpp.