diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2016-09-19 08:20:00 +0200 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2016-09-19 14:01:21 +0000 |
commit | 60bbe9d5157c50a35f891105819aaf851eb136bc (patch) | |
tree | 9b333a95badd834dabe4017e97a5f03cbb9d028a /src | |
parent | 0f6c236f47087ea96e587a9f03d18996551f8764 (diff) |
Dial: clarify the documentation for some properties
- Document the range of the angle property
- Fix handle's property type
- Explain stepSize more thoroughly
Change-Id: I72ce8b493b3faf49d7f155ac802109bd9bdb4089
Task-number: QTBUG-55904
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/quicktemplates2/qquickdial.cpp | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/src/quicktemplates2/qquickdial.cpp b/src/quicktemplates2/qquickdial.cpp index 3b096255..48d02faa 100644 --- a/src/quicktemplates2/qquickdial.cpp +++ b/src/quicktemplates2/qquickdial.cpp @@ -300,6 +300,8 @@ qreal QQuickDial::position() const Like the \l position property, angle is continuously updated while the handle is dragged. + The range is from \c -140 degrees to \c 140 degrees. + \sa position */ qreal QQuickDial::angle() const @@ -311,7 +313,18 @@ qreal QQuickDial::angle() const /*! \qmlproperty real QtQuick.Controls::Dial::stepSize - This property holds the step size. The default value is \c 0.0. + This property holds the step size. + + The step size determines the amount by which the dial's value + is increased and decreased when interacted with via the keyboard. + For example, a step size of \c 0.2, will result in the dial's + value increasing and decreasing in increments of \c 0.2. + + The step size is only respected for touch and mouse interaction + when \l snapMode is set to a value other than \c Dial.NoSnap. + + The default value is \c 0.0, which results in an effective step + size of \c 0.1 for keyboard interaction. \sa snapMode, increase(), decrease() */ @@ -460,7 +473,7 @@ void QQuickDial::decrease() } /*! - \qmlproperty component QtQuick.Controls::Dial::handle + \qmlproperty Item QtQuick.Controls::Dial::handle This property holds the handle of the dial. |