QDial¶
Synopsis¶
Functions¶
- def initStyleOption (option)
- def notchSize ()
- def notchTarget ()
- def notchesVisible ()
- def setNotchTarget (target)
- def wrapping ()
Slots¶
- def setNotchesVisible (visible)
- def setWrapping (on)
Detailed Description¶
The PySide.QtGui.QDial class provides a rounded range control (like a speedometer or potentiometer).
PySide.QtGui.QDial is used when the user needs to control a value within a program-definable range, and the range either wraps around (for example, with angles measured from 0 to 359 degrees) or the dialog layout needs a square widget.
Since PySide.QtGui.QDial inherits from PySide.QtGui.QAbstractSlider , the dial behaves in a similar way to a slider . When PySide.QtGui.QDial.wrapping() is false (the default setting) there is no real difference between a slider and a dial. They both share the same signals, slots and member functions. Which one you use depends on the expectations of your users and on the type of application.
The dial initially emits PySide.QtGui.QAbstractSlider.valueChanged() signals continuously while the slider is being moved; you can make it emit the signal less often by disabling the PySide.QtGui.QAbstractSlider.tracking() property. The PySide.QtGui.QAbstractSlider.sliderMoved() signal is emitted continuously even when tracking is disabled.
The dial also emits PySide.QtGui.QAbstractSlider.sliderPressed() and PySide.QtGui.QAbstractSlider.sliderReleased() signals when the mouse button is pressed and released. Note that the dial’s value can change without these signals being emitted since the keyboard and wheel can also be used to change the value.
Unlike the slider, PySide.QtGui.QDial attempts to draw a “nice” number of notches rather than one per line step. If possible, the number of notches drawn is one per line step, but if there aren’t enough pixels to draw every one, PySide.QtGui.QDial will skip notches to try and draw a uniform set (e.g. by drawing every second or third notch).
Like the slider, the dial makes the PySide.QtGui.QAbstractSlider functions PySide.QtGui.QAbstractSlider.setValue() , addLine() , subtractLine() , addPage() and subtractPage() available as slots.
The dial’s keyboard interface is fairly simple: The left /up and right /down arrow keys adjust the dial’s PySide.QtGui.QAbstractSlider.value() by the defined PySide.QtGui.QAbstractSlider.singleStep() , Page Up and Page Down by the defined PySide.QtGui.QAbstractSlider.pageStep() , and the Home and End keys set the value to the defined PySide.QtGui.QAbstractSlider.minimum() and PySide.QtGui.QAbstractSlider.maximum() values.
If you are using the mouse wheel to adjust the dial, the increment value is determined by the lesser value of PySide.QtGui.QApplication.wheelScrollLines() multipled by PySide.QtGui.QAbstractSlider.singleStep() , and PySide.QtGui.QAbstractSlider.pageStep() .
Dials shown in various widget styles (from left to right): Plastique , Windows XP , Macintosh . See also
PySide.QtGui.QScrollBar PySide.QtGui.QSpinBox PySide.QtGui.QSlider GUI Design Handbook: Slider Sliders Example
- class PySide.QtGui.QDial([parent=None])¶
Parameters: parent – PySide.QtGui.QWidget Constructs a dial.
The parent argument is sent to the PySide.QtGui.QAbstractSlider constructor.
- PySide.QtGui.QDial.initStyleOption(option)¶
Parameters: option – PySide.QtGui.QStyleOptionSlider Initialize option with the values from this PySide.QtGui.QDial . This method is useful for subclasses when they need a PySide.QtGui.QStyleOptionSlider , but don’t want to fill in all the information themselves.
See also
- PySide.QtGui.QDial.notchSize()¶
Return type: PySide.QtCore.int This property holds the current notch size.
The notch size is in range control units, not pixels, and if possible it is a multiple of PySide.QtGui.QAbstractSlider.singleStep() that results in an on-screen notch size near PySide.QtGui.QDial.notchTarget() .
By default, this property has a value of 1.
- PySide.QtGui.QDial.notchTarget()¶
Return type: PySide.QtCore.qreal This property holds the target number of pixels between notches.
The notch target is the number of pixels PySide.QtGui.QDial attempts to put between each notch.
The actual size may differ from the target size.
The default notch target is 3.7 pixels.
- PySide.QtGui.QDial.notchesVisible()¶
Return type: PySide.QtCore.bool This property holds whether the notches are shown.
If the property is true, a series of notches are drawn around the dial to indicate the range of values available; otherwise no notches are shown.
By default, this property is disabled.
- PySide.QtGui.QDial.setNotchTarget(target)¶
Parameters: target – PySide.QtCore.double See also
- PySide.QtGui.QDial.setNotchesVisible(visible)¶
Parameters: visible – PySide.QtCore.bool This property holds whether the notches are shown.
If the property is true, a series of notches are drawn around the dial to indicate the range of values available; otherwise no notches are shown.
By default, this property is disabled.
- PySide.QtGui.QDial.setWrapping(on)¶
Parameters: on – PySide.QtCore.bool This property holds whether wrapping is enabled.
If true, wrapping is enabled; otherwise some space is inserted at the bottom of the dial to separate the ends of the range of valid values.
If enabled, the arrow can be oriented at any angle on the dial. If disabled, the arrow will be restricted to the upper part of the dial; if it is rotated into the space at the bottom of the dial, it will be clamped to the closest end of the valid range of values.
By default this property is false.
- PySide.QtGui.QDial.wrapping()¶
Return type: PySide.QtCore.bool This property holds whether wrapping is enabled.
If true, wrapping is enabled; otherwise some space is inserted at the bottom of the dial to separate the ends of the range of valid values.
If enabled, the arrow can be oriented at any angle on the dial. If disabled, the arrow will be restricted to the upper part of the dial; if it is rotated into the space at the bottom of the dial, it will be clamped to the closest end of the valid range of values.
By default this property is false.
