C
Dial QML Type
Circular dial that is rotated to set a value. More...
| Import Statement: | import QtQuick.Controls |
| Since: | Qt Quick Ultralite 1.0 |
| Inherits: |
- List of all members, including inherited members
- Dial is part of Input Controls.
Properties
- angle : real
- from : real
- handle : Item
- inputMode : enumeration
- live : bool
- position : real
- snapMode : enumeration
- stepSize : real
- to : real
- value : real
- wrap : bool
Signals
- moved()
Detailed Description
The Dial is similar to a traditional dial knob that is found on devices such as stereos or industrial equipment. It allows the user to specify a value within a range.
The value of the dial is set using its value property. The range is set using the from and to properties. To enable or disable wrapping, use the wrap property.
Dial supports three input modes: Dial.Circular, Dial.Horizontal and Dial.Vertical. The circular input mode operates on an absolute input system, where the position of the cursor within the dial directly reflects its value. The horizontal and vertical input modes use a relative input system, where changes in the cursor's position are "added" to the value of the dial.
The following image illustrates the directions in which the various input modes track movement:
See also Input Controls and Controls Styling.
Property Documentation
angle : real [read-only]
This property holds the angle of the handle.
The range is from -140 degrees to 140 degrees.
See also position.
from : real
This property holds the starting value for the range. The default value is 0.0.
handle : Item
This property holds the handle of the dial.
The handle acts as a visual indicator of the position of the dial.
See also Controls Styling.
inputMode : enumeration
This property holds the input mode.
Dial supports three input modes: Dial.Circular, Dial.Horizontal and Dial.Vertical. The circular input mode operates on an absolute input system, where the position of the cursor within the dial directly reflects its value. The horizontal and vertical input modes use a relative input system, where changes in the cursor's position are "added" to the value of the dial.
The following image illustrates the directions in which the various input modes track movement:
The default value is Dial.Circular.
live : bool
This property holds whether the dial provides live updates for the value property while the handle is dragged.
The default value is true.
See also value.
position : real [read-only]
This property holds the logical position of the handle.
The position is expressed as a fraction of the control's angle range (the range within which the handle can be moved), which is 0.0 - 1.0.
snapMode : enumeration
This property holds the snap mode.
The snap mode works with the stepSize to allow the handle to snap to certain points along the dial.
Possible values:
| Constant | Description |
|---|---|
Dial.NoSnap | The dial does not snap (default). |
Dial.SnapAlways | The dial snaps while the handle is dragged. |
Dial.SnapOnRelease | The dial does not snap while being dragged, but only after the handle is released. |
See also stepSize.
stepSize : real
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 0.2, results in the dial's value increasing and decreasing in increments of 0.2.
The step size is only respected for touch and mouse interaction when snapMode is set to a value other than Dial.NoSnap.
The default value is 0.0, which results in an effective step size of 0.1 for keyboard interaction.
See also snapMode.
to : real
This property holds the end value for the range. The default value is 1.0.
value : real
This property holds a value within the from - to range. The default value is 0.0.
wrap : bool
This property holds whether the dial wraps when dragged.
For example, when this property is set to true, dragging the dial past the to position, moves the handle to the from position, and vice versa:
When this property is false, it's not possible to drag the dial across the from and to values.
The default value is false.
Signal Documentation
moved()
This signal is emitted when the dial has been interactively moved by the user by either touch, mouse, or keys.
Note: The corresponding handler is onMoved.
Available under certain Qt licenses.
Find out more.
