#include <qquicksystempalette_p.h>

Inheritance diagram for QQuickSystemPalette:

Collaboration diagram for QQuickSystemPalette:

Public Types
enum	ColorGroup { Active = QPalette::Active , Inactive = QPalette::Inactive , Disabled = QPalette::Disabled }

Signals
void	paletteChanged ()
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
	QQuickSystemPalette (QObject *parent=nullptr)
	\qmltype SystemPalette \nativetype QQuickSystemPalette \inqmlmodule QtQuick
QColor	window () const
	\qmlproperty color QtQuick::SystemPalette::window The window (general background) color of the current color group.
QColor	windowText () const
	\qmlproperty color QtQuick::SystemPalette::windowText The window text (general foreground) color of the current color group.
QColor	base () const
	\qmlproperty color QtQuick::SystemPalette::base The base color of the current color group.
QColor	text () const
	\qmlproperty color QtQuick::SystemPalette::text The text color of the current color group.
QColor	alternateBase () const
	\qmlproperty color QtQuick::SystemPalette::alternateBase The alternate base color of the current color group.
QColor	button () const
	\qmlproperty color QtQuick::SystemPalette::button The button color of the current color group.
QColor	buttonText () const
	\qmlproperty color QtQuick::SystemPalette::buttonText The button text foreground color of the current color group.
QColor	light () const
	\qmlproperty color QtQuick::SystemPalette::light The light color of the current color group.
QColor	midlight () const
	\qmlproperty color QtQuick::SystemPalette::midlight The midlight color of the current color group.
QColor	dark () const
	\qmlproperty color QtQuick::SystemPalette::dark The dark color of the current color group.
QColor	mid () const
	\qmlproperty color QtQuick::SystemPalette::mid The mid color of the current color group.
QColor	shadow () const
	\qmlproperty color QtQuick::SystemPalette::shadow The shadow color of the current color group.
QColor	highlight () const
	\qmlproperty color QtQuick::SystemPalette::highlight The highlight color of the current color group.
QColor	highlightedText () const
	\qmlproperty color QtQuick::SystemPalette::highlightedText The highlighted text color of the current color group.
QColor	placeholderText () const
	\qmlproperty color QtQuick::SystemPalette::placeholderText The placeholder text color of the current color group.
QColor	accent () const
	\qmlproperty color QtQuick::SystemPalette::accent The accent color of the current color group.
QQuickSystemPalette::ColorGroup	colorGroup () const
	\qmlproperty enumeration QtQuick::SystemPalette::colorGroup
void	setColorGroup (QQuickSystemPalette::ColorGroup)
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.
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	isQmlExposed () const noexcept
	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`.

Protected Member Functions
bool	eventFilter (QObject watched, QEvent event) override
	Filters events if this object has been installed as an event filter for the watched object.
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
QQuickSystemPalette::ColorGroup	colorGroup
QColor	window
QColor	windowText
QColor	base
QColor	text
QColor	alternateBase
QColor	button
QColor	buttonText
QColor	light
QColor	midlight
QColor	dark
QColor	mid
QColor	shadow
QColor	highlight
QColor	highlightedText
QColor	placeholderText
QColor	accent
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 30 of file qquicksystempalette_p.h.

Member Enumeration Documentation

◆ ColorGroup

enum QQuickSystemPalette::ColorGroup

Enumerator
Active
Inactive
Disabled

Definition at line 58 of file qquicksystempalette_p.h.

Constructor & Destructor Documentation

◆ QQuickSystemPalette()

QQuickSystemPalette::QQuickSystemPalette ( QObject * parent = nullptr )

\qmltype SystemPalette \nativetype QQuickSystemPalette \inqmlmodule QtQuick

Provides access to the Qt palettes.

The SystemPalette type provides access to the Qt application palettes. This provides information about the standard colors used for application windows, buttons and other features. These colors are grouped into three {color groups}: active, inactive, and disabled. See the QPalette documentation for details about color groups and the properties provided by SystemPalette.

This can be used to color items in a way that provides a more native look and feel.

The following example creates a palette from the Active color group and uses this to color the window and text items appropriately:

import QtQuick
 
Rectangle {
    SystemPalette { id: myPalette; colorGroup: SystemPalette.Active }
 
    width: 640; height: 480
    color: myPalette.window
 
    Text {
        anchors.fill: parent
        text: "Hello!"; color: myPalette.windowText
    }
}

See also: QPalette

Definition at line 48 of file qquicksystempalette.cpp.

Member Function Documentation

◆ accent()

QColor QQuickSystemPalette::accent ( ) const

\qmlproperty color QtQuick::SystemPalette::accent The accent color of the current color group.

Since: 6.7

See also: QPalette::ColorRole

Definition at line 244 of file qquicksystempalette.cpp.

◆ alternateBase()

QColor QQuickSystemPalette::alternateBase ( ) const

\qmlproperty color QtQuick::SystemPalette::alternateBase The alternate base color of the current color group.

See also: QPalette::ColorRole

Definition at line 110 of file qquicksystempalette.cpp.

◆ base()

QColor QQuickSystemPalette::base ( ) const

\qmlproperty color QtQuick::SystemPalette::base The base color of the current color group.

See also: QPalette::ColorRole

Definition at line 86 of file qquicksystempalette.cpp.

◆ button()

QColor QQuickSystemPalette::button ( ) const

\qmlproperty color QtQuick::SystemPalette::button The button color of the current color group.

See also: QPalette::ColorRole

Definition at line 122 of file qquicksystempalette.cpp.

◆ buttonText()

QColor QQuickSystemPalette::buttonText ( ) const

\qmlproperty color QtQuick::SystemPalette::buttonText The button text foreground color of the current color group.

See also: QPalette::ColorRole

Definition at line 134 of file qquicksystempalette.cpp.

◆ colorGroup()

QQuickSystemPalette::ColorGroup QQuickSystemPalette::colorGroup ( ) const

\qmlproperty enumeration QtQuick::SystemPalette::colorGroup

The color group of the palette. This can be one of:

\value SystemPalette.Active (default) QPalette::Active \value SystemPalette.Inactive QPalette::Inactive \value SystemPalette.Disabled QPalette::Disabled

See also: QPalette::ColorGroup

Definition at line 261 of file qquicksystempalette.cpp.

◆ dark()

QColor QQuickSystemPalette::dark ( ) const

\qmlproperty color QtQuick::SystemPalette::dark The dark color of the current color group.

See also: QPalette::ColorRole

Definition at line 170 of file qquicksystempalette.cpp.

◆ eventFilter()

bool QQuickSystemPalette::eventFilter	(	QObject *	watched,
		QEvent *	event )

overrideprotectedvirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
    MainWindow();
 
protected:
    bool eventFilter(QObject *obj, QEvent *ev) override;
 
private:
    QTextEdit *textEdit;
};
 
MainWindow::MainWindow()
{
    textEdit = new QTextEdit;
    setCentralWidget(textEdit);
 
    textEdit->installEventFilter(this);
}
 
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
    if (obj == textEdit) {
        if (event->type() == QEvent::KeyPress) {
            QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
            qDebug() << "Ate key press" << keyEvent->key();
            return true;
        } else {
            return false;
        }
    } else {
        // pass the event on to the parent class
        return QMainWindow::eventFilter(obj, event);
    }
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning: If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also: installEventFilter()

Reimplemented from QObject.

Definition at line 274 of file qquicksystempalette.cpp.

◆ highlight()

QColor QQuickSystemPalette::highlight ( ) const

\qmlproperty color QtQuick::SystemPalette::highlight The highlight color of the current color group.

See also: QPalette::ColorRole

Definition at line 206 of file qquicksystempalette.cpp.

◆ highlightedText()

QColor QQuickSystemPalette::highlightedText ( ) const

\qmlproperty color QtQuick::SystemPalette::highlightedText The highlighted text color of the current color group.

See also: QPalette::ColorRole

Definition at line 218 of file qquicksystempalette.cpp.

◆ light()

QColor QQuickSystemPalette::light ( ) const

\qmlproperty color QtQuick::SystemPalette::light The light color of the current color group.

See also: QPalette::ColorRole

Definition at line 146 of file qquicksystempalette.cpp.

◆ mid()

QColor QQuickSystemPalette::mid ( ) const

\qmlproperty color QtQuick::SystemPalette::mid The mid color of the current color group.

See also: QPalette::ColorRole

Definition at line 182 of file qquicksystempalette.cpp.

◆ midlight()

QColor QQuickSystemPalette::midlight ( ) const

\qmlproperty color QtQuick::SystemPalette::midlight The midlight color of the current color group.

See also: QPalette::ColorRole

Definition at line 158 of file qquicksystempalette.cpp.

◆ paletteChanged

void QQuickSystemPalette::paletteChanged ( )

signal

◆ placeholderText()

QColor QQuickSystemPalette::placeholderText ( ) const

\qmlproperty color QtQuick::SystemPalette::placeholderText The placeholder text color of the current color group.

Since: 6.2

See also: QPalette::ColorRole

Definition at line 231 of file qquicksystempalette.cpp.

◆ setColorGroup()

void QQuickSystemPalette::setColorGroup ( QQuickSystemPalette::ColorGroup colorGroup )

Definition at line 267 of file qquicksystempalette.cpp.

◆ shadow()

QColor QQuickSystemPalette::shadow ( ) const

\qmlproperty color QtQuick::SystemPalette::shadow The shadow color of the current color group.

See also: QPalette::ColorRole

Definition at line 194 of file qquicksystempalette.cpp.

◆ text()

QColor QQuickSystemPalette::text ( ) const

\qmlproperty color QtQuick::SystemPalette::text The text color of the current color group.

See also: QPalette::ColorRole

Definition at line 98 of file qquicksystempalette.cpp.

◆ window()

QColor QQuickSystemPalette::window ( ) const

\qmlproperty color QtQuick::SystemPalette::window The window (general background) color of the current color group.

See also: QPalette::ColorRole

Definition at line 62 of file qquicksystempalette.cpp.

◆ windowText()

QColor QQuickSystemPalette::windowText ( ) const

\qmlproperty color QtQuick::SystemPalette::windowText The window text (general foreground) color of the current color group.

See also: QPalette::ColorRole

Definition at line 74 of file qquicksystempalette.cpp.

Property Documentation

◆ accent

QColor QQuickSystemPalette::accent

read

Definition at line 51 of file qquicksystempalette_p.h.

◆ alternateBase

QColor QQuickSystemPalette::alternateBase

read

Definition at line 40 of file qquicksystempalette_p.h.

◆ base

QColor QQuickSystemPalette::base

read

Definition at line 38 of file qquicksystempalette_p.h.

◆ button

QColor QQuickSystemPalette::button

read

Definition at line 41 of file qquicksystempalette_p.h.

◆ buttonText

QColor QQuickSystemPalette::buttonText

read

Definition at line 42 of file qquicksystempalette_p.h.

◆ colorGroup

QQuickSystemPalette::ColorGroup QQuickSystemPalette::colorGroup

readwrite

Definition at line 35 of file qquicksystempalette_p.h.

◆ dark

QColor QQuickSystemPalette::dark

read

Definition at line 45 of file qquicksystempalette_p.h.

◆ highlight

QColor QQuickSystemPalette::highlight

read

Definition at line 48 of file qquicksystempalette_p.h.

◆ highlightedText

QColor QQuickSystemPalette::highlightedText

read

Definition at line 49 of file qquicksystempalette_p.h.

◆ light

QColor QQuickSystemPalette::light

read

Definition at line 43 of file qquicksystempalette_p.h.

◆ mid

QColor QQuickSystemPalette::mid

read

Definition at line 46 of file qquicksystempalette_p.h.

◆ midlight

QColor QQuickSystemPalette::midlight

read

Definition at line 44 of file qquicksystempalette_p.h.

◆ placeholderText

QColor QQuickSystemPalette::placeholderText

read

Definition at line 50 of file qquicksystempalette_p.h.

◆ shadow

QColor QQuickSystemPalette::shadow

read

Definition at line 47 of file qquicksystempalette_p.h.

◆ text

QColor QQuickSystemPalette::text

read

Definition at line 39 of file qquicksystempalette_p.h.

◆ window

QColor QQuickSystemPalette::window

read

Definition at line 36 of file qquicksystempalette_p.h.

◆ windowText

QColor QQuickSystemPalette::windowText

read

Definition at line 37 of file qquicksystempalette_p.h.

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

qtdeclarative/src/quick/util/qquicksystempalette_p.h (dc5442618038f8a2972c42fb424ff37efe9909d5)
qtdeclarative/src/quick/util/qquicksystempalette.cpp (dc5442618038f8a2972c42fb424ff37efe9909d5)

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColorGroup

Constructor & Destructor Documentation

◆ QQuickSystemPalette()

Member Function Documentation

◆ accent()

◆ alternateBase()

◆ base()

◆ button()

◆ buttonText()

◆ colorGroup()

◆ dark()

◆ eventFilter()

◆ highlight()

◆ highlightedText()

◆ light()

◆ mid()

◆ midlight()

◆ paletteChanged

◆ placeholderText()

◆ setColorGroup()

◆ shadow()

◆ text()

◆ window()

◆ windowText()

Property Documentation

◆ accent

◆ alternateBase

◆ base

◆ button

◆ buttonText

◆ colorGroup

◆ dark

◆ highlight

◆ highlightedText

◆ light

◆ mid

◆ midlight

◆ placeholderText

◆ shadow

◆ text

◆ window

◆ windowText