1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQUICKBOUNDARYRULE_H
41#define QQUICKBOUNDARYRULE_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <private/qtquickglobal_p.h>
55
56#include <private/qqmlpropertyvalueinterceptor_p.h>
57#include <qqml.h>
58
59QT_BEGIN_NAMESPACE
60
61class QQuickAbstractAnimation;
62class QQuickBoundaryRulePrivate;
63class Q_QUICK_PRIVATE_EXPORT QQuickBoundaryRule : public QObject, public QQmlPropertyValueInterceptor
64{
65 Q_OBJECT
66 Q_DECLARE_PRIVATE(QQuickBoundaryRule)
67
68 Q_INTERFACES(QQmlPropertyValueInterceptor)
69 Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
70 Q_PROPERTY(qreal minimum READ minimum WRITE setMinimum NOTIFY minimumChanged)
71 Q_PROPERTY(qreal minimumOvershoot READ minimumOvershoot WRITE setMinimumOvershoot NOTIFY minimumOvershootChanged)
72 Q_PROPERTY(qreal maximum READ maximum WRITE setMaximum NOTIFY maximumChanged)
73 Q_PROPERTY(qreal maximumOvershoot READ maximumOvershoot WRITE setMaximumOvershoot NOTIFY maximumOvershootChanged)
74 Q_PROPERTY(qreal overshootScale READ overshootScale WRITE setOvershootScale NOTIFY overshootScaleChanged)
75 Q_PROPERTY(qreal currentOvershoot READ currentOvershoot NOTIFY currentOvershootChanged)
76 Q_PROPERTY(qreal peakOvershoot READ peakOvershoot NOTIFY peakOvershootChanged)
77 Q_PROPERTY(OvershootFilter overshootFilter READ overshootFilter WRITE setOvershootFilter NOTIFY overshootFilterChanged)
78 Q_PROPERTY(QEasingCurve easing READ easing WRITE setEasing NOTIFY easingChanged)
79 Q_PROPERTY(int returnDuration READ returnDuration WRITE setReturnDuration NOTIFY returnDurationChanged)
80
81public:
82 enum OvershootFilter {
83 None,
84 Peak
85 };
86 Q_ENUM(OvershootFilter)
87
88 QQuickBoundaryRule(QObject *parent=nullptr);
89 ~QQuickBoundaryRule();
90
91 void setTarget(const QQmlProperty &) override;
92 void write(const QVariant &value) override;
93
94 bool enabled() const;
95 void setEnabled(bool enabled);
96
97 qreal minimum() const;
98 void setMinimum(qreal minimum);
99 qreal minimumOvershoot() const;
100 void setMinimumOvershoot(qreal minimum);
101
102 qreal maximum() const;
103 void setMaximum(qreal maximum);
104 qreal maximumOvershoot() const;
105 void setMaximumOvershoot(qreal maximum);
106
107 qreal overshootScale() const;
108 void setOvershootScale(qreal scale);
109
110 qreal currentOvershoot() const;
111 qreal peakOvershoot() const;
112
113 OvershootFilter overshootFilter() const;
114 void setOvershootFilter(OvershootFilter overshootFilter);
115
116 Q_INVOKABLE bool returnToBounds();
117
118 QEasingCurve easing() const;
119 void setEasing(const QEasingCurve &easing);
120
121 int returnDuration() const;
122 void setReturnDuration(int duration);
123
124Q_SIGNALS:
125 void enabledChanged();
126 void minimumChanged();
127 void minimumOvershootChanged();
128 void maximumChanged();
129 void maximumOvershootChanged();
130 void overshootScaleChanged();
131 void currentOvershootChanged();
132 void peakOvershootChanged();
133 void overshootFilterChanged();
134 void easingChanged();
135 void returnDurationChanged();
136
137private Q_SLOTS:
138 void componentFinalized();
139};
140
141QT_END_NAMESPACE
142
143QML_DECLARE_TYPE(QQuickBoundaryRule)
144
145#endif // QQUICKBOUNDARYRULE_H
146