 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qquickcolor_p.h>
Public Member Functions | |
| QQuickColor (QObject *parent=nullptr) | |
| \qmltype Color \nativetype QQuickColor \inqmlmodule QtQuick | |
| Q_INVOKABLE QColor | rgba (double r, double g, double b, double a) const |
| \qmlmethod color Color::rgba(real red, real green, real blue, real alpha) | |
| Q_INVOKABLE QColor | hsla (double h, double s, double l, double a) const |
| \qmlmethod color Color::hsla(real hue, real saturation, real lightness, real alpha) | |
| Q_INVOKABLE QColor | hsva (double h, double s, double v, double a) const |
| \qmlmethod color Color::hsva(real hue, real saturation, real value, real alpha) | |
| Q_INVOKABLE QColor | fromString (const QString &name) const |
| \qmlmethod color Color::fromString(string name) | |
| Q_INVOKABLE bool | equal (const QColor &lhs, const QColor &rhs) const |
| \qmlmethod bool Color::equal(color lhs, color rhs) | |
| Q_INVOKABLE QColor | transparent (const QColor &color, qreal opacity) const |
| \qmlmethod color Color::transparent(color c, real opacity) | |
| Q_INVOKABLE QColor | blend (const QColor &a, const QColor &b, qreal factor) const |
| \qmlmethod color Color::blend(color a, color b, real factor) | |
| Q_INVOKABLE QColor | alpha (const QColor &baseColor, double value) const |
| \qmlmethod color Color::alpha(color baseColor, real value) | |
| Q_INVOKABLE QColor | darker (const QColor &baseColor, double factor) const |
| \qmlmethod color Color::darker(color baseColor, real factor) | |
| Q_INVOKABLE QColor | lighter (const QColor &baseColor, double factor) const |
| \qmlmethod color Color::lighter(color baseColor, real factor) | |
| Q_INVOKABLE QColor | tint (const QColor &baseColor, const QColor &tintColor) const |
| \qmlmethod color Color::tint(color baseColor, color tintColor) | |
| 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. | |
Additional Inherited Members | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| 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. | |
| 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 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) | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
| 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) | |
Definition at line 28 of file qquickcolor_p.h.
|
explicit |
\qmltype Color \nativetype QQuickColor \inqmlmodule QtQuick
Holds utility functions for colors.
Definition at line 19 of file qquickcolor.cpp.
\qmlmethod color Color::alpha(color baseColor, real value)
Returns baseColor with an alpha value of value. value is a real ranging from 0 (completely transparent) to 1 (completely opaque).
Definition at line 133 of file qquickcolor.cpp.
\qmlmethod color Color::blend(color a, color b, real factor)
Returns a color that is a blend of a and b. The resulting color is constructed from the independent linear interpolations of the RGB color channels of a and b.
If factor is smaller than 0.0, a is returned. If factor is larger than 1.0, b is returned.
Definition at line 111 of file qquickcolor.cpp.
\qmlmethod color Color::darker(color baseColor, real factor)
Returns a color darker than baseColor by the factor provided.
The function converts the current RGB color to HSV, divides the value (V) component by factor and converts the color back to RGB.
If the factor is greater than 1.0, this function returns a darker color. Setting factor to 3.0 returns a color that has one-third the brightness. If the factor is less than 1.0, the return color is lighter, but we recommend using the \l{Color::lighter()} function for this purpose. If the factor is 0 or negative, the return value is unspecified.
Definition at line 151 of file qquickcolor.cpp.
\qmlmethod bool Color::equal(color lhs, color rhs)
Returns true if lhs and rhs are equal. See \l{QColor::operator==(const QColor &color) const}.
Definition at line 85 of file qquickcolor.cpp.
\qmlmethod color Color::fromString(string name)
Returns the color corresponding to the given name (i.e. red or #ff0000). If there is no such color, an exception is thrown.
Definition at line 62 of file qquickcolor.cpp.
| QColor QQuickColor::hsla | ( | double | h, |
| double | s, | ||
| double | l, | ||
| double | a ) const |
\qmlmethod color Color::hsla(real hue, real saturation, real lightness, real alpha)
Returns a color with the specified hue, saturation, lightness, and alpha components. All components should be in the range 0-1 (inclusive).
Definition at line 40 of file qquickcolor.cpp.
| QColor QQuickColor::hsva | ( | double | h, |
| double | s, | ||
| double | v, | ||
| double | a ) const |
\qmlmethod color Color::hsva(real hue, real saturation, real value, real alpha)
Returns a color with the specified hue, saturation, value and alpha components. All components should be in the range 0-1 (inclusive).
Definition at line 51 of file qquickcolor.cpp.
\qmlmethod color Color::lighter(color baseColor, real factor)
Returns a color lighter than baseColor by the factor provided.
The function converts the current RGB color to HSV, multiplies the value (V) component by factor and converts the color back to RGB.
If the factor is greater than 1.0, this functions returns a lighter color. Setting factor to 1.5 returns a color that is 50% brighter. If the factor is less than 1.0, the return color is darker, but we recommend using the \l{Color::darker()} function for this purpose. If the factor is 0 or negative, the return value is unspecified.
Definition at line 169 of file qquickcolor.cpp.
| QColor QQuickColor::rgba | ( | double | r, |
| double | g, | ||
| double | b, | ||
| double | a ) const |
\qmlmethod color Color::rgba(real red, real green, real blue, real alpha)
Returns a color with the specified red, green, blue, and alpha components. All components should be in the range 0-1 (inclusive).
Definition at line 29 of file qquickcolor.cpp.
\qmlmethod color Color::tint(color baseColor, color tintColor)
This function allows tinting one color (baseColor) with another (tintColor).
The tint color should usually be mostly transparent, or you will not be able to see the underlying color. The example below provides a slight red tint by having the tint color be pure red, which is only 1/16th opaque.
\qml Item { Rectangle { x: 0 width: 80 height: 80 color: "lightsteelblue" } Rectangle { x: 100; width: 80; height: 80 color: Color.tint("lightsteelblue", "#10FF0000") } } \endqml {Side-by-side representation of a light steel blue square and a light steel blue square with a tint applied}
Tint is most useful when a subtle change is intended to be conveyed due to some event; you can then use tinting to more effectively tune the visible color.
Definition at line 203 of file qquickcolor.cpp.
\qmlmethod color Color::transparent(color c, real opacity)
Returns the color c with a given opacity
Definition at line 95 of file qquickcolor.cpp.
1.16.1