Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | Properties | Friends | List of all members
QQuickGradient Class Reference

#include <qquickrectangle_p.h>

+ Inheritance diagram for QQuickGradient:
+ Collaboration diagram for QQuickGradient:

Public Types

enum  Orientation { Vertical = Qt::Vertical , Horizontal = Qt::Horizontal }
 

Signals

void updated ()
 
void orientationChanged ()
 
- 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

 QQuickGradient (QObject *parent=nullptr)
 \qmltype Gradient \instantiates QQuickGradient \inqmlmodule QtQuick
 
 ~QQuickGradient () override
 
QQmlListProperty< QQuickGradientStop > stops ()
 
Orientation orientation () const
 
void setOrientation (Orientation orientation)
 \qmlproperty enumeration QtQuick::Gradient::orientation
 
QGradientStops gradientStops () const
 
- 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.
 

Properties

QQmlListProperty< QQuickGradientStop > stops
 
Orientation orientation
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickRectangle
 
class QQuickGradientStop
 

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 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
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 87 of file qquickrectangle_p.h.

Member Enumeration Documentation

◆ Orientation

enum QQuickGradient::Orientation
Enumerator
Vertical 
Horizontal 

Definition at line 102 of file qquickrectangle_p.h.

Constructor & Destructor Documentation

◆ QQuickGradient()

QQuickGradient::QQuickGradient ( QObject * parent = nullptr)

\qmltype Gradient \instantiates QQuickGradient \inqmlmodule QtQuick

Defines a gradient fill.

A gradient is defined by two or more colors, which will be blended seamlessly.

The colors are specified as a set of GradientStop child items, each of which defines a position on the gradient from 0.0 to 1.0 and a color. The position of each GradientStop is defined by setting its \l{GradientStop::}{position} property; its color is defined using its \l{GradientStop::}{color} property.

A gradient without any gradient stops is rendered as a solid white fill.

Note that this item is not a visual representation of a gradient. To display a gradient, use a visual item (like \l Rectangle) which supports the use of gradients.

Definition at line 213 of file qquickrectangle.cpp.

◆ ~QQuickGradient()

QQuickGradient::~QQuickGradient ( )
override

Definition at line 218 of file qquickrectangle.cpp.

Member Function Documentation

◆ gradientStops()

QGradientStops QQuickGradient::gradientStops ( ) const

Definition at line 248 of file qquickrectangle.cpp.

References QList< T >::at(), QQuickGradientStop::color, i, j, QQuickGradientStop::position, QList< T >::size(), and stops.

Referenced by QQuickShapeCurveRenderer::setFillGradient(), and QQuickShapeGenericRenderer::setFillGradient().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ orientation()

Orientation QQuickGradient::orientation ( ) const
inline

Definition at line 108 of file qquickrectangle_p.h.

◆ orientationChanged

void QQuickGradient::orientationChanged ( )
signal

Referenced by setOrientation().

+ Here is the caller graph for this function:

◆ setOrientation()

void QQuickGradient::setOrientation ( Orientation orientation)

\qmlproperty enumeration QtQuick::Gradient::orientation

Since
5.12

Set this property to define the direction of the gradient.

\value Gradient.Vertical a vertical gradient \value Gradient.Horizontal a horizontal gradient

The default is Gradient.Vertical.

Definition at line 238 of file qquickrectangle.cpp.

References emit, orientation, orientationChanged(), and updated().

+ Here is the call graph for this function:

◆ stops()

QQmlListProperty< QQuickGradientStop > QQuickGradient::stops ( )

◆ updated

void QQuickGradient::updated ( )
signal

Referenced by QQuickShapeConicalGradient::setAngle(), QQuickShapeRadialGradient::setCenterRadius(), QQuickShapeRadialGradient::setCenterX(), QQuickShapeConicalGradient::setCenterX(), QQuickShapeRadialGradient::setCenterY(), QQuickShapeConicalGradient::setCenterY(), QQuickShapeRadialGradient::setFocalRadius(), QQuickShapeRadialGradient::setFocalX(), QQuickShapeRadialGradient::setFocalY(), QQuickRectangle::setGradient(), setOrientation(), QQuickShapeGradient::setSpread(), QQuickShapeLinearGradient::setX1(), QQuickShapeLinearGradient::setX2(), QQuickShapeLinearGradient::setY1(), and QQuickShapeLinearGradient::setY2().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QQuickGradientStop

friend class QQuickGradientStop
friend

Definition at line 124 of file qquickrectangle_p.h.

◆ QQuickRectangle

friend class QQuickRectangle
friend

Definition at line 123 of file qquickrectangle_p.h.

Property Documentation

◆ orientation

Orientation QQuickGradient::orientation
readwrite

Definition at line 92 of file qquickrectangle_p.h.

Referenced by setOrientation().

◆ stops

QQmlListProperty< QQuickGradientStop > QQuickGradient::stops
read

Definition at line 91 of file qquickrectangle_p.h.

Referenced by gradientStops().

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