Contains color groups for each QML item state. \inmodule QtQuick. More...

#include <qquickpalette_p.h>

Inheritance diagram for QQuickPalette:

Collaboration diagram for QQuickPalette:

Public Types
using	PalettePtr = QPointer<QQuickPalette>
Public Types inherited from QQuickColorGroup
using	GroupPtr = QPointer<QQuickColorGroup>

Public Slots
void	setActive (QQuickColorGroup *active)
void	setInactive (QQuickColorGroup *inactive)
void	setDisabled (QQuickColorGroup *disabled)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	activeChanged ()
void	inactiveChanged ()
void	disabledChanged ()
Signals inherited from QQuickColorGroup
void	alternateBaseChanged ()
void	baseChanged ()
void	brightTextChanged ()
void	buttonChanged ()
void	buttonTextChanged ()
void	darkChanged ()
void	highlightChanged ()
void	highlightedTextChanged ()
void	lightChanged ()
void	linkChanged ()
void	linkVisitedChanged ()
void	midChanged ()
void	midlightChanged ()
void	shadowChanged ()
void	textChanged ()
void	toolTipBaseChanged ()
void	toolTipTextChanged ()
void	windowChanged ()
void	windowTextChanged ()
	Q_REVISION (6, 2) void placeholderTextChanged()
	Q_REVISION (6, 6) void accentChanged()
void	changed ()
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
	QQuickPalette (QObject *parent=nullptr)
	\qmltype Palette \nativetype QQuickPalette \inherits ColorGroup \inqmlmodule QtQuick
QQuickColorGroup *	active () const
QQuickColorGroup *	inactive () const
QQuickColorGroup *	disabled () const
void	resetActive ()
void	resetInactive ()
void	resetDisabled ()
QPalette::ColorGroup	currentColorGroup () const override
void	setCurrentGroup (QPalette::ColorGroup currentGroup)
void	fromQPalette (QPalette palette)
QPalette	toQPalette () const
const QQuickAbstractPaletteProvider *	paletteProvider () const
void	setPaletteProvider (const QQuickAbstractPaletteProvider *paletteProvider)
void	reset ()
void	inheritPalette (const QPalette &palette)
Public Member Functions inherited from QQuickColorGroup
	QQuickColorGroup (QObject *parent=nullptr)
QColor	alternateBase () const
void	setAlternateBase (const QColor &color)
void	resetAlternateBase ()
QColor	base () const
void	setBase (const QColor &color)
void	resetBase ()
QColor	brightText () const
void	setBrightText (const QColor &color)
void	resetBrightText ()
QColor	button () const
void	setButton (const QColor &color)
void	resetButton ()
QColor	buttonText () const
void	setButtonText (const QColor &color)
void	resetButtonText ()
QColor	dark () const
void	setDark (const QColor &color)
void	resetDark ()
QColor	highlight () const
void	setHighlight (const QColor &color)
void	resetHighlight ()
QColor	highlightedText () const
void	setHighlightedText (const QColor &color)
void	resetHighlightedText ()
QColor	light () const
void	setLight (const QColor &color)
void	resetLight ()
QColor	link () const
void	setLink (const QColor &color)
void	resetLink ()
QColor	linkVisited () const
void	setLinkVisited (const QColor &color)
void	resetLinkVisited ()
QColor	mid () const
void	setMid (const QColor &color)
void	resetMid ()
QColor	midlight () const
void	setMidlight (const QColor &color)
void	resetMidlight ()
QColor	shadow () const
void	setShadow (const QColor &color)
void	resetShadow ()
QColor	text () const
void	setText (const QColor &color)
void	resetText ()
QColor	toolTipBase () const
void	setToolTipBase (const QColor &color)
void	resetToolTipBase ()
QColor	toolTipText () const
void	setToolTipText (const QColor &color)
void	resetToolTipText ()
QColor	window () const
void	setWindow (const QColor &color)
void	resetWindow ()
QColor	windowText () const
void	setWindowText (const QColor &color)
void	resetWindowText ()
QColor	placeholderText () const
void	setPlaceholderText (const QColor &color)
void	resetPlaceholderText ()
QColor	accent () const
void	setAccent (const QColor &color)
void	resetAccent ()
QPalette::ColorGroup	groupTag () const
void	setGroupTag (QPalette::ColorGroup tag)
const QQuickPaletteColorProvider &	colorProvider () const
QQuickPaletteColorProvider &	colorProvider ()
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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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`.

Properties
QQuickColorGroup *	active
QQuickColorGroup *	inactive
QQuickColorGroup *	disabled
Properties inherited from QQuickColorGroup
QColor	alternateBase
QColor	base
QColor	brightText
QColor	button
QColor	buttonText
QColor	dark
QColor	highlight
QColor	highlightedText
QColor	light
QColor	link
QColor	linkVisited
QColor	mid
QColor	midlight
QColor	shadow
QColor	text
QColor	toolTipBase
QColor	toolTipText
QColor	window
QColor	windowText
QColor	placeholderText
FINALQColor	accent
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QQuickColorGroup
static QQuickColorGroup *	createWithParent (QQuickPalette &parent)
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 Member Functions inherited from QQuickColorGroup
	QQuickColorGroup (QQuickPalette &parent)
	\qmltype ColorGroup \nativetype QQuickColorGroup \inherits QtObject \inqmlmodule QtQuick
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)
Static Protected Member Functions inherited from QQuickColorGroup
static constexpr QPalette::ColorGroup	defaultGroupTag ()
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

Contains color groups for each QML item state. \inmodule QtQuick.

Since: 6.0

This class is the wrapper around QPalette.

See also: QQuickColorGroup, QQuickAbstractPaletteProvider, QPalette

Definition at line 28 of file qquickpalette_p.h.

Member Typedef Documentation

◆ PalettePtr

using QQuickPalette::PalettePtr = QPointer<QQuickPalette>

Definition at line 39 of file qquickpalette_p.h.

Constructor & Destructor Documentation

◆ QQuickPalette()

QQuickPalette::QQuickPalette ( QObject * parent = nullptr )

explicit

\qmltype Palette \nativetype QQuickPalette \inherits ColorGroup \inqmlmodule QtQuick

Contains color groups for each QML item state.

A palette consists of three color groups: active, disabled, and inactive. The active color group is the default group: its colors are used for other groups if colors of these groups aren't explicitly specified.

In the following example, color is applied for all color groups:

ApplicationWindow {
    palette.buttonText: "salmon"
 
    ColumnLayout {
        Button {
            text: qsTr("Disabled button")
            enabled: false
        }
 
        Button {
            text: qsTr("Enabled button")
        }
    }
}

It means that text color will be the same for both buttons.

In the following example, colors will be different for enabled and disabled states:

ApplicationWindow {
    palette.buttonText: "salmon"
    palette.disabled.buttonText: "lavender"
 
    ColumnLayout {
        Button {
            text: qsTr("Disabled button")
            enabled: false
        }
 
        Button {
            text: qsTr("Enabled button")
        }
    }
}

It is also possible to specify colors like this:

    palette {
        buttonText: "red"
        button: "khaki"
 
        disabled {
            buttonText: "lavender"
            button: "coral"
        }
    }

This approach is especially convenient when you need to specify a whole palette with all color groups; but as with the other cases above, the colors that are not specified are initialized from SystemPalette, or potentially the \l {Styling Qt Quick Controls}{Qt Quick Controls style}, if one is in use.

Note: Some Controls styles use some palette colors, but many styles use independent colors.

See also: Window::palette, Item::palette, Popup::palette, SystemPalette

\qmlproperty ColorGroup QtQuick::Palette::active

The Active group is used for windows that are in focus.

See also: QPalette::Active

\qmlproperty ColorGroup QtQuick::Palette::inactive

The Inactive group is used for windows that have no keyboard focus.

See also: QPalette::Inactive

\qmlproperty ColorGroup QtQuick::Palette::disabled

The Disabled group is used for elements that are disabled for some reason.

See also: QPalette::Disabled

Definition at line 136 of file qquickpalette.cpp.

Member Function Documentation

◆ active()

QQuickColorGroup * QQuickPalette::active ( ) const

Definition at line 142 of file qquickpalette.cpp.

◆ activeChanged

void QQuickPalette::activeChanged ( )

signal

◆ currentColorGroup()

QPalette::ColorGroup QQuickPalette::currentColorGroup ( ) const

overridevirtual

Returns the palette's current color group. The default value is Active.

Reimplemented from QQuickColorGroup.

Definition at line 181 of file qquickpalette.cpp.

◆ disabled()

QQuickColorGroup * QQuickPalette::disabled ( ) const

Definition at line 152 of file qquickpalette.cpp.

◆ disabledChanged

void QQuickPalette::disabledChanged ( )

signal

◆ fromQPalette()

void QQuickPalette::fromQPalette ( QPalette palette )

Definition at line 216 of file qquickpalette.cpp.

◆ inactive()

QQuickColorGroup * QQuickPalette::inactive ( ) const

Definition at line 147 of file qquickpalette.cpp.

◆ inactiveChanged

void QQuickPalette::inactiveChanged ( )

signal

◆ inheritPalette()

void QQuickPalette::inheritPalette ( const QPalette & palette )

Definition at line 245 of file qquickpalette.cpp.

◆ paletteProvider()

const QQuickAbstractPaletteProvider * QQuickPalette::paletteProvider ( ) const

Definition at line 228 of file qquickpalette.cpp.

◆ reset()

void QQuickPalette::reset ( )

Definition at line 238 of file qquickpalette.cpp.

◆ resetActive()

void QQuickPalette::resetActive ( )

Definition at line 157 of file qquickpalette.cpp.

◆ resetDisabled()

void QQuickPalette::resetDisabled ( )

Definition at line 169 of file qquickpalette.cpp.

◆ resetInactive()

void QQuickPalette::resetInactive ( )

Definition at line 163 of file qquickpalette.cpp.

◆ setActive

void QQuickPalette::setActive ( QQuickColorGroup * active )

slot

Definition at line 252 of file qquickpalette.cpp.

◆ setCurrentGroup()

void QQuickPalette::setCurrentGroup ( QPalette::ColorGroup currentGroup )

Sets currentGroup for this palette.

The current color group is used when accessing colors of this palette. For example, if color group is Disabled, color accessors will be returning colors form the respective group.

QQuickPalette palette;
 
palette.setAlternateBase(Qt::green);
palette.disabled()->setAlternateBase(Qt::red);
 
auto color = palette.alternateBase(); // Qt::green
 
palette.setCurrentGroup(QPalette::Disabled);
color = palette.alternateBase(); // Qt::red

Emits QColorGroup::changed().

Definition at line 208 of file qquickpalette.cpp.

◆ setDisabled

void QQuickPalette::setDisabled ( QQuickColorGroup * disabled )

slot

Definition at line 262 of file qquickpalette.cpp.

◆ setInactive

void QQuickPalette::setInactive ( QQuickColorGroup * inactive )

slot

Definition at line 257 of file qquickpalette.cpp.

◆ setPaletteProvider()

void QQuickPalette::setPaletteProvider ( const QQuickAbstractPaletteProvider * paletteProvider )

Definition at line 233 of file qquickpalette.cpp.

◆ toQPalette()

QPalette QQuickPalette::toQPalette ( ) const

Definition at line 223 of file qquickpalette.cpp.

Property Documentation

◆ active

QQuickColorGroup * QQuickPalette::active

readwrite

Definition at line 32 of file qquickpalette_p.h.

◆ disabled

QQuickColorGroup * QQuickPalette::disabled

readwrite

Definition at line 34 of file qquickpalette_p.h.

◆ inactive

QQuickColorGroup * QQuickPalette::inactive

readwrite

Definition at line 33 of file qquickpalette_p.h.

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

qtdeclarative/src/quick/items/qquickpalette_p.h (01cd43d30e3ca2c4dd94a4a4711604adb9417517)
qtdeclarative/src/quick/items/qquickpalette.cpp (01cd43d30e3ca2c4dd94a4a4711604adb9417517)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PalettePtr

Constructor & Destructor Documentation

◆ QQuickPalette()

Member Function Documentation

◆ active()

◆ activeChanged

◆ currentColorGroup()

◆ disabled()

◆ disabledChanged

◆ fromQPalette()

◆ inactive()

◆ inactiveChanged

◆ inheritPalette()

◆ paletteProvider()

◆ reset()

◆ resetActive()

◆ resetDisabled()

◆ resetInactive()

◆ setActive

◆ setCurrentGroup()

◆ setDisabled

◆ setInactive

◆ setPaletteProvider()

◆ toQPalette()

Property Documentation

◆ active

◆ disabled

◆ inactive