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 Member Functions | Properties | List of all members
QQuickColorAnimation Class Reference

#include <qquickanimation_p.h>

+ Inheritance diagram for QQuickColorAnimation:
+ Collaboration diagram for QQuickColorAnimation:

Public Member Functions

 QQuickColorAnimation (QObject *parent=nullptr)
 \qmltype ColorAnimation \instantiates QQuickColorAnimation \inqmlmodule QtQuick\inherits PropertyAnimation
 
 ~QQuickColorAnimation () override
 
QColor from () const
 
void setFrom (const QColor &)
 
QColor to () const
 \qmlproperty color QtQuick::ColorAnimation::to
 
void setTo (const QColor &)
 
- Public Member Functions inherited from QQuickPropertyAnimation
 QQuickPropertyAnimation (QObject *parent=nullptr)
 \qmltype PropertyAnimation \instantiates QQuickPropertyAnimation \inqmlmodule QtQuick\inherits Animation
 
 ~QQuickPropertyAnimation () override
 
virtual int duration () const
 \qmlproperty int QtQuick::PropertyAnimation::duration This property holds the duration of the animation, in milliseconds.
 
virtual void setDuration (int)
 
QVariant from () const
 \qmlproperty variant QtQuick::PropertyAnimation::from This property holds the starting value for the animation.
 
void setFrom (const QVariant &)
 
QVariant to () const
 \qmlproperty variant QtQuick::PropertyAnimation::to This property holds the end value for the animation.
 
void setTo (const QVariant &)
 
QEasingCurve easing () const
 Specifies the easing curve used for the animation.
 
void setEasing (const QEasingCurve &)
 
QObject * target () const
 
void setTargetObject (QObject *)
 
QString property () const
 
void setProperty (const QString &)
 
QString properties () const
 
void setProperties (const QString &)
 
QQmlListProperty< QObject > targets ()
 
QQmlListProperty< QObject > exclude ()
 
- Public Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QObject *parent=nullptr)
 \qmltype Animation \instantiates QQuickAbstractAnimation \inqmlmodule QtQuick
 
 ~QQuickAbstractAnimation () override
 
bool isRunning () const
 \qmlproperty bool QtQuick::Animation::running This property holds whether the animation is currently running.
 
void setRunning (bool)
 \qmlsignal QtQuick::Animation::started()
 
bool isPaused () const
 \qmlproperty bool QtQuick::Animation::paused This property holds whether the animation is currently paused.
 
void setPaused (bool)
 
bool alwaysRunToEnd () const
 \qmlproperty bool QtQuick::Animation::alwaysRunToEnd This property holds whether the animation should run to completion when it is stopped.
 
void setAlwaysRunToEnd (bool)
 
int loops () const
 \qmlproperty int QtQuick::Animation::loops This property holds the number of times the animation should play.
 
void setLoops (int)
 
int duration () const
 
int currentTime ()
 
void setCurrentTime (int)
 
QQuickAnimationGroup * group () const
 
void setGroup (QQuickAnimationGroup *, int index=-1)
 
void setDefaultTarget (const QQmlProperty &)
 
void setDisableUserControl ()
 
void setEnableUserControl ()
 
bool userControlDisabled () const
 
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.
 
virtual ThreadingModel threadingModel () const
 
QAbstractAnimationJob * qtAnimation ()
 
- 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.
 
- Public Member Functions inherited from QQmlPropertyValueSource
 QQmlPropertyValueSource ()
 Constructs a QQmlPropertyValueSource.
 
virtual ~QQmlPropertyValueSource ()
 Destroys the value source.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

QColor from
 
QColor to
 
- Properties inherited from QQuickPropertyAnimation
int duration
 
QVariant from
 
QVariant to
 
QEasingCurve easing
 
QObject * target
 
QString property
 
QString properties
 
QQmlListProperty< QObject > targets
 
QQmlListProperty< QObject > exclude
 \qmlproperty list<QtObject> QtQuick::PropertyAnimation::exclude This property holds the items not to be affected by this animation.
 
- Properties inherited from QQuickAbstractAnimation
bool running
 
bool paused
 
bool alwaysRunToEnd
 
int loops
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQuickAbstractAnimation
enum  ThreadingModel { GuiThread , RenderThread , AnyThread }
 
enum  Loops { Infinite = -2 }
 
enum  TransitionDirection { Forward , Backward }
 
- Public Slots inherited from QQuickAbstractAnimation
void restart ()
 \qmlmethod QtQuick::Animation::restart()
 
void start ()
 \qmlmethod QtQuick::Animation::start()
 
void pause ()
 \qmlmethod QtQuick::Animation::pause()
 
void resume ()
 \qmlmethod QtQuick::Animation::resume()
 
void stop ()
 \qmlmethod QtQuick::Animation::stop()
 
void complete ()
 \qmlmethod QtQuick::Animation::complete()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QQuickPropertyAnimation
void durationChanged (int)
 
void fromChanged ()
 
void toChanged ()
 
void easingChanged (const QEasingCurve &)
 
void propertiesChanged (const QString &)
 
void targetChanged ()
 
void propertyChanged ()
 
- Signals inherited from QQuickAbstractAnimation
void started ()
 
void stopped ()
 
void runningChanged (bool)
 
void pausedChanged (bool)
 
void alwaysRunToEndChanged (bool)
 
void loopCountChanged (int)
 
 Q_REVISION (2, 12) void finished()
 
- 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 QQuickPropertyAnimation
QQuickStateActions createTransitionActions (QQuickStateActions &actions, QQmlProperties &modified, QObject *defaultTarget=nullptr)
 
 QQuickPropertyAnimation (QQuickPropertyAnimationPrivate &dd, QObject *parent)
 
QAbstractAnimationJob * transition (QQuickStateActions &actions, QQmlProperties &modified, TransitionDirection direction, QObject *defaultTarget=nullptr) override
 
- Protected Member Functions inherited from QQuickAbstractAnimation
 QQuickAbstractAnimation (QQuickAbstractAnimationPrivate &dd, QObject *parent)
 
QAbstractAnimationJob * initInstance (QAbstractAnimationJob *animation)
 
- 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 295 of file qquickanimation_p.h.

Constructor & Destructor Documentation

◆ QQuickColorAnimation()

QQuickColorAnimation::QQuickColorAnimation ( QObject * parent = nullptr)

\qmltype ColorAnimation \instantiates QQuickColorAnimation \inqmlmodule QtQuick\inherits PropertyAnimation

Animates changes in color values.

ColorAnimation is a specialized PropertyAnimation that defines an animation to be applied when a color value changes.

Here is a ColorAnimation applied to the color property of a \l Rectangle as a property value source. It animates the color property's value from its current value to a value of "red", over 1000 milliseconds:

import QtQuick
Rectangle {
width: 100; height: 100
color: "red"
ColorAnimation on color { to: "yellow"; duration: 1000 }
}

Like any other animation type, a ColorAnimation can be applied in a number of ways, including transitions, behaviors and property value sources. The \l {Animation and Transitions in Qt Quick} documentation shows a variety of methods for creating animations.

For convenience, when a ColorAnimation is used in a \l Transition, it will animate any color properties that have been modified during the state change. If a \l{PropertyAnimation::}{property} or \l{PropertyAnimation::}{properties} are explicitly set for the animation, then those are used instead.

See also
{Animation and Transitions in Qt Quick}, {Qt Quick Examples - Animation}

Definition at line 768 of file qquickanimation.cpp.

References d, and QVariantAnimationPrivate::getInterpolator().

+ Here is the call graph for this function:

◆ ~QQuickColorAnimation()

QQuickColorAnimation::~QQuickColorAnimation ( )
override

Definition at line 777 of file qquickanimation.cpp.

Member Function Documentation

◆ from()

QColor QQuickColorAnimation::from ( ) const 
\qmlproperty color QtQuick::ColorAnimation::from
This property holds the color value at which the animation should begin.

For example, the following animation is not applied until a color value
has reached "#c0c0c0":

\qml
Item {
    states: [

States are defined here... ]

transitions: Transition { ColorAnimation { from: "#c0c0c0"; duration: 2000 } } } \endqml

If the ColorAnimation is defined within a \l Transition or \l Behavior, this value defaults to the value defined in the starting state of the \l Transition, or the current value of the property at the moment the \l Behavior is triggered.

See also
{Animation and Transitions in Qt Quick}

Definition at line 807 of file qquickanimation.cpp.

References d.

◆ setFrom()

void QQuickColorAnimation::setFrom ( const QColor & f)

Definition at line 813 of file qquickanimation.cpp.

References QQuickPropertyAnimation::setFrom().

+ Here is the call graph for this function:

◆ setTo()

void QQuickColorAnimation::setTo ( const QColor & t)

Definition at line 836 of file qquickanimation.cpp.

References QQuickPropertyAnimation::setTo().

+ Here is the call graph for this function:

◆ to()

QColor QQuickColorAnimation::to ( ) const

\qmlproperty color QtQuick::ColorAnimation::to

This property holds the color value at which the animation should end.

If the ColorAnimation is defined within a \l Transition or \l Behavior, this value defaults to the value defined in the end state of the \l Transition, or the value of the property change that triggered the \l Behavior.

See also
{Animation and Transitions in Qt Quick}

Definition at line 830 of file qquickanimation.cpp.

References d.

Property Documentation

◆ from

QColor QQuickColorAnimation::from
readwrite

Definition at line 299 of file qquickanimation_p.h.

◆ to

QColor QQuickColorAnimation::to
readwrite

Definition at line 300 of file qquickanimation_p.h.

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