1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QQUICKSTATE_H
5#define QQUICKSTATE_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <qqml.h>
19#include <qqmlproperty.h>
20#include <QtCore/qobject.h>
21#include <QtCore/qsharedpointer.h>
22#include <private/qtquickglobal_p.h>
23#include <private/qqmlabstractbinding_p.h>
24#include <private/qqmlanybinding_p.h>
25
26#include <QtCore/private/qproperty_p.h>
27
28QT_BEGIN_NAMESPACE
29
30Q_DECLARE_LOGGING_CATEGORY(lcStates)
31
32class QQuickStateActionEvent;
33class QQmlBinding;
34class QQmlExpression;
35
36class Q_QUICK_EXPORT QQuickStateAction
37{
38public:
39 QQuickStateAction();
40 QQuickStateAction(QObject *, const QString &, const QVariant &);
41 QQuickStateAction(QObject *, const QQmlProperty &property, const QString &,
42 const QVariant &);
43
44 bool restore:1;
45 bool actionDone:1;
46 bool reverseEvent:1;
47 bool deletableToBinding:1;
48
49 QQmlProperty property;
50 QVariant fromValue;
51 QVariant toValue;
52
53 QQmlAnyBinding fromBinding;
54 QQmlAnyBinding toBinding;
55 QQuickStateActionEvent *event;
56
57 //strictly for matching
58 QObject *specifiedObject;
59 QString specifiedProperty;
60
61 void deleteFromBinding();
62};
63
64class Q_AUTOTEST_EXPORT QQuickStateActionEvent
65{
66public:
67 virtual ~QQuickStateActionEvent();
68
69 enum EventType { Script, SignalHandler, ParentChange, AnchorChanges };
70
71 virtual EventType type() const = 0;
72
73 virtual void execute();
74 virtual bool isReversable();
75 virtual void reverse();
76 virtual void saveOriginals() {}
77 virtual bool needsCopy() { return false; }
78 virtual void copyOriginals(QQuickStateActionEvent *) {}
79
80 virtual bool isRewindable() { return isReversable(); }
81 virtual void rewind() {}
82 virtual void saveCurrentValues() {}
83 virtual void saveTargetValues() {}
84
85 virtual bool changesBindings();
86 virtual void clearBindings();
87 virtual bool mayOverride(QQuickStateActionEvent*other);
88};
89
90//### rename to QQuickStateChange?
91class QQuickStateGroup;
92class QQuickState;
93class QQuickStateOperationPrivate;
94class Q_QUICK_EXPORT QQuickStateOperation : public QObject
95{
96 Q_OBJECT
97 QML_ANONYMOUS
98 QML_ADDED_IN_VERSION(2, 0)
99public:
100 QQuickStateOperation(QObject *parent = nullptr)
101 : QObject(parent) {}
102 typedef QList<QQuickStateAction> ActionList;
103
104 virtual ActionList actions();
105
106 QQuickState *state() const;
107 void setState(QQuickState *state);
108
109protected:
110 QQuickStateOperation(QObjectPrivate &dd, QObject *parent = nullptr);
111
112private:
113 Q_DECLARE_PRIVATE(QQuickStateOperation)
114 Q_DISABLE_COPY(QQuickStateOperation)
115};
116
117typedef QQuickStateOperation::ActionList QQuickStateActions;
118
119class QQuickTransition;
120class QQuickStatePrivate;
121class Q_QUICK_EXPORT QQuickState : public QObject
122{
123 Q_OBJECT
124
125 Q_PROPERTY(QString name READ name WRITE setName)
126 Q_PROPERTY(bool when READ when WRITE setWhen)
127 Q_PROPERTY(QString extend READ extends WRITE setExtends)
128 Q_PROPERTY(QQmlListProperty<QQuickStateOperation> changes READ changes)
129 Q_CLASSINFO("DefaultProperty", "changes")
130 Q_CLASSINFO("DeferredPropertyNames", "changes")
131 QML_NAMED_ELEMENT(State)
132 QML_ADDED_IN_VERSION(2, 0)
133
134public:
135 QQuickState(QObject *parent=nullptr);
136 ~QQuickState() override;
137
138 QString name() const;
139 void setName(const QString &);
140 bool isNamed() const;
141
142 bool isWhenKnown() const;
143 bool when() const;
144 void setWhen(bool);
145
146 QString extends() const;
147 void setExtends(const QString &);
148
149 QQmlListProperty<QQuickStateOperation> changes();
150 int operationCount() const;
151 QQuickStateOperation *operationAt(int) const;
152
153 QQuickState &operator<<(QQuickStateOperation *);
154
155 void apply(QQuickTransition *, QQuickState *revert);
156 void cancel();
157
158 QQuickStateGroup *stateGroup() const;
159 void setStateGroup(QQuickStateGroup *);
160
161 bool containsPropertyInRevertList(QObject *target, const QString &name) const;
162 bool changeValueInRevertList(QObject *target, const QString &name, const QVariant &revertValue);
163 bool changeBindingInRevertList(QObject *target, const QString &name, QQmlAnyBinding binding);
164 bool removeEntryFromRevertList(QObject *target, const QString &name);
165 void addEntryToRevertList(const QQuickStateAction &action);
166 void removeAllEntriesFromRevertList(QObject *target);
167 void addEntriesToRevertList(const QList<QQuickStateAction> &actions);
168 QVariant valueInRevertList(QObject *target, const QString &name) const;
169 QQmlAnyBinding bindingInRevertList(QObject *target, const QString &name) const;
170
171 bool isStateActive() const;
172
173Q_SIGNALS:
174 void completed();
175
176private:
177 Q_DECLARE_PRIVATE(QQuickState)
178 Q_DISABLE_COPY(QQuickState)
179};
180
181QT_END_NAMESPACE
182
183#endif // QQUICKSTATE_H
184

source code of qtdeclarative/src/quick/util/qquickstate_p.h