#include <qquickcolordialog_p.h>

Inheritance diagram for QQuickColorDialog:

Collaboration diagram for QQuickColorDialog:

Signals
void	selectedColorChanged ()

void	optionsChanged ()

Signals inherited from QQuickAbstractDialog
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
	QQuickColorDialog (QObject *parent=nullptr)
	\qmltype ColorDialog \inherits Dialog \inqmlmodule QtQuick.Dialogs

QColor	selectedColor () const
	\qmlproperty color QtQuick.Dialogs::ColorDialog::selectedColor

void	setSelectedColor (const QColor &color)

QColorDialogOptions::ColorDialogOptions	options () const
	\qmlproperty flags QtQuick.Dialogs::ColorDialog::options

void	setOptions (QColorDialogOptions::ColorDialogOptions options)

void	resetOptions ()

Public Member Functions inherited from QQuickAbstractDialog
	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)

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.

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

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

void	onCreate (QPlatformDialogHelper *dialog) override

void	onShow (QPlatformDialogHelper *dialog) override

Protected Member Functions inherited from QQuickAbstractDialog
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
QColor	selectedColor

QColorDialogOptions::ColorDialogOptions	options

Properties inherited from QQuickAbstractDialog
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

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QQuickAbstractDialog
enum	StandardCode { Rejected , Accepted }

Public Slots inherited from QQuickAbstractDialog
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)

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

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 qquickcolordialog_p.h.

Constructor & Destructor Documentation

◆ QQuickColorDialog()

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

explicit

\qmltype ColorDialog \inherits Dialog \inqmlmodule QtQuick.Dialogs

Since: 6.4

A color dialog.

The ColorDialog type provides a QML API for color dialogs.

To show a color dialog, construct an instance of ColorDialog, set the desired properties, and call \l {Dialog::}{open()}. The \l selectedColor property can be used to determine the initially selected color in the dialog.

MenuItem {
    text: qsTr("Color")
    onTriggered: colorDialog.open()
}
 
ColorDialog {
    id: colorDialog
    selectedColor: document.color
    onAccepted: document.color = selectedColor
}
 
MyDocument {
    id: document
}

Definition at line 56 of file qquickcolordialog.cpp.

Member Function Documentation

◆ onCreate()

void QQuickColorDialog::onCreate ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Called at the end of \l create().

Reimplemented from QQuickAbstractDialog.

Definition at line 134 of file qquickcolordialog.cpp.

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

Here is the call graph for this function:

◆ onShow()

void QQuickColorDialog::onShow ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Called by \l open(), after the call to \l create() and before the handle/helper's show function is called.

Reimplemented from QQuickAbstractDialog.

Definition at line 143 of file qquickcolordialog.cpp.

References dialog, QQuickAbstractDialog::onShow(), and QQuickAbstractDialog::title.

Here is the call graph for this function:

◆ options()

QColorDialogOptions::ColorDialogOptions QQuickColorDialog::options ( ) const

\qmlproperty flags QtQuick.Dialogs::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 Show a slider and additional input fields for the alpha value. \value ColorDialog.NoButtons Don't display \uicontrol Open and \uicontrol Cancel buttons (useful for "live dialogs"). \value ColorDialog.NoEyeDropperButton Don't display \uicontrol {Eye Dropper} button. This value was added in Qt 6.6. \value ColorDialog.DontUseNativeDialog Forces the dialog to use a non-native quick implementation.

Definition at line 109 of file qquickcolordialog.cpp.

◆ optionsChanged

void QQuickColorDialog::optionsChanged ( )

signal

Referenced by setOptions().

Here is the caller graph for this function:

◆ resetOptions()

void QQuickColorDialog::resetOptions ( )

Definition at line 123 of file qquickcolordialog.cpp.

References setOptions().

Here is the call graph for this function:

◆ selectedColor()

QColor QQuickColorDialog::selectedColor ( ) const

\qmlproperty color QtQuick.Dialogs::ColorDialog::selectedColor

This property holds the currently selected color in the dialog.

The \l {Dialog::}{accepted()} signal can be handled to get the final selection. When the user has clicked \uicontrol Open to accept a color, a signal handler for the \l {Dialog::}{accepted()} signal can query the selectedColor property to get the final color that was selected by the user.

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

Definition at line 75 of file qquickcolordialog.cpp.

◆ selectedColorChanged

void QQuickColorDialog::selectedColorChanged ( )

signal

Referenced by setSelectedColor().

Here is the caller graph for this function:

◆ setOptions()

void QQuickColorDialog::setOptions ( QColorDialogOptions::ColorDialogOptions options )

Definition at line 114 of file qquickcolordialog.cpp.

References emit, options, and optionsChanged().

Referenced by resetOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelectedColor()

void QQuickColorDialog::setSelectedColor ( const QColor & color )

Definition at line 80 of file qquickcolordialog.cpp.

References emit, and selectedColorChanged().

Referenced by onCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ useNativeDialog()

bool QQuickColorDialog::useNativeDialog ( ) const

overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 128 of file qquickcolordialog.cpp.

References QQuickAbstractDialog::useNativeDialog().

Here is the call graph for this function:

Property Documentation

◆ options

QColorDialogOptions::ColorDialogOptions QQuickColorDialog::options

readwrite

Definition at line 57 of file qquickcolordialog_p.h.

Referenced by setOptions().

◆ selectedColor

QColor QQuickColorDialog::selectedColor

readwrite

Definition at line 57 of file qquickcolordialog_p.h.

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

qtdeclarative/src/quickdialogs/quickdialogs/qquickcolordialog_p.h
qtdeclarative/src/quickdialogs/quickdialogs/qquickcolordialog.cpp

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickColorDialog()

Member Function Documentation

◆ onCreate()

◆ onShow()

◆ options()

◆ optionsChanged

◆ resetOptions()

◆ selectedColor()

◆ selectedColorChanged

◆ setOptions()

◆ setSelectedColor()

◆ useNativeDialog()

Property Documentation

◆ options

◆ selectedColor