QAbstractSlider

The QAbstractSlider class provides an integer value within a range. More…

Inherited by: QDial, QScrollBar, QSlider

Synopsis

Functions

• def hasTracking ()

• def invertedAppearance ()

• def invertedControls ()

• def isSliderDown ()

• def maximum ()

• def minimum ()

• def orientation ()

• def pageStep ()

• def repeatAction ()

• def setInvertedAppearance (arg__1)

• def setInvertedControls (arg__1)

• def setMaximum (arg__1)

• def setMinimum (arg__1)

• def setPageStep (arg__1)

• def setRepeatAction (action[, thresholdTime=500[, repeatTime=50]])

• def setSingleStep (arg__1)

• def setSliderDown (arg__1)

• def setSliderPosition (arg__1)

• def setTracking (enable)

• def singleStep ()

• def sliderPosition ()

• def triggerAction (action)

• def value ()

Virtual functions

• def sliderChange (change)

Slots

• def setOrientation (arg__1)

• def setRange (min, max)

• def setValue (arg__1)

Signals

• def actionTriggered (action)

• def rangeChanged (min, max)

• def sliderMoved (position)

• def sliderPressed ()

• def sliderReleased ()

• def valueChanged (value)

Detailed Description

The class is designed as a common super class for widgets like QScrollBar , QSlider and QDial .

Here are the main properties of the class:

1. value : The bounded integer that QAbstractSlider maintains.

2. minimum : The lowest possible value.

3. maximum : The highest possible value.

4. singleStep : The smaller of two natural steps that an abstract sliders provides and typically corresponds to the user pressing an arrow key.

5. pageStep : The larger of two natural steps that an abstract slider provides and typically corresponds to the user pressing PageUp or PageDown.

6. tracking : Whether slider tracking is enabled.

7. sliderPosition : The current position of the slider. If tracking is enabled (the default), this is identical to value .

Unity (1) may be viewed as a third step size. setValue() lets you set the current value to any integer in the allowed range, not just minimum() + n * singleStep() for integer values of n . Some widgets may allow the user to set any value at all; others may just provide multiples of singleStep() or pageStep() .

QAbstractSlider emits a comprehensive set of signals:

Signal	Emitted when
valueChanged()	the value has changed. The tracking determines whether this signal is emitted during user interaction.
sliderPressed()	the user starts to drag the slider.
sliderMoved()	the user drags the slider.
sliderReleased()	the user releases the slider.
actionTriggered()	a slider action was triggered.
rangeChanged()	a the range has changed.

QAbstractSlider provides a virtual sliderChange() function that is well suited for updating the on-screen representation of sliders. By calling triggerAction() , subclasses trigger slider actions. Two helper functions sliderPositionFromValue() and sliderValueFromPosition() help subclasses and styles to map screen coordinates to logical range values.

See also

QAbstractSpinBox QSlider QDial QScrollBar Sliders Example

class PySide2.QtWidgets.QAbstractSlider([parent=None])

param parent:

PySide2.QtWidgets.QWidget

Constructs an abstract slider.

The parent argument is sent to the QWidget constructor.

The minimum defaults to 0, the maximum to 99, with a singleStep size of 1 and a pageStep size of 10, and an initial value of 0.

PySide2.QtWidgets.QAbstractSlider.SliderAction

Constant	Description
QAbstractSlider.SliderNoAction
QAbstractSlider.SliderSingleStepAdd
QAbstractSlider.SliderSingleStepSub
QAbstractSlider.SliderPageStepAdd
QAbstractSlider.SliderPageStepSub
QAbstractSlider.SliderToMinimum
QAbstractSlider.SliderToMaximum
QAbstractSlider.SliderMove

PySide2.QtWidgets.QAbstractSlider.SliderChange

Constant	Description
QAbstractSlider.SliderRangeChange
QAbstractSlider.SliderOrientationChange
QAbstractSlider.SliderStepsChange
QAbstractSlider.SliderValueChange

PySide2.QtWidgets.QAbstractSlider.actionTriggered(action)

Parameters:

action – int

PySide2.QtWidgets.QAbstractSlider.hasTracking()

Return type:

bool

This property holds whether slider tracking is enabled.

If tracking is enabled (the default), the slider emits the valueChanged() signal while the slider is being dragged. If tracking is disabled, the slider emits the valueChanged() signal only when the user releases the slider.

See also

sliderDown

PySide2.QtWidgets.QAbstractSlider.invertedAppearance()

Return type:

bool

This property holds whether or not a slider shows its values inverted..

If this property is false (the default), the minimum and maximum will be shown in its classic position for the inherited widget. If the value is true, the minimum and maximum appear at their opposite location.

Note: This property makes most sense for sliders and dials. For scroll bars, the visual effect of the scroll bar subcontrols depends on whether or not the styles understand inverted appearance; most styles ignore this property for scroll bars.

PySide2.QtWidgets.QAbstractSlider.invertedControls()

Return type:

bool

This property holds whether or not the slider inverts its wheel and key events..

If this property is false , scrolling the mouse wheel “up” and using keys like page up will increase the slider’s value towards its maximum. Otherwise pressing page up will move value towards the slider’s minimum.

PySide2.QtWidgets.QAbstractSlider.isSliderDown()

Return type:

bool

This property holds whether the slider is pressed down..

The property is set by subclasses in order to let the abstract slider know whether or not tracking has any effect.

Changing the slider down property emits the sliderPressed() and sliderReleased() signals.

PySide2.QtWidgets.QAbstractSlider.maximum()

Return type:

int

This property holds the slider’s maximum value.

When setting this property, the minimum is adjusted if necessary to ensure that the range remains valid. Also the slider’s current value is adjusted to be within the new range.

PySide2.QtWidgets.QAbstractSlider.minimum()

Return type:

int

This property holds the sliders’s minimum value.

When setting this property, the maximum is adjusted if necessary to ensure that the range remains valid. Also the slider’s current value is adjusted to be within the new range.

PySide2.QtWidgets.QAbstractSlider.orientation()

Return type:

Orientation

This property holds the orientation of the slider.

The orientation must be Vertical (the default) or Horizontal .

PySide2.QtWidgets.QAbstractSlider.pageStep()

Return type:

int

This property holds the page step..

The larger of two natural steps that an abstract slider provides and typically corresponds to the user pressing PageUp or PageDown.

See also

singleStep

PySide2.QtWidgets.QAbstractSlider.rangeChanged(min, max)

Parameters:

• min – int

• max – int

PySide2.QtWidgets.QAbstractSlider.repeatAction()

Return type:

SliderAction

Returns the current repeat action.

See also

setRepeatAction()

PySide2.QtWidgets.QAbstractSlider.setInvertedAppearance(arg__1)

Parameters:

arg__1 – bool

This property holds whether or not a slider shows its values inverted..

If this property is false (the default), the minimum and maximum will be shown in its classic position for the inherited widget. If the value is true, the minimum and maximum appear at their opposite location.

Note: This property makes most sense for sliders and dials. For scroll bars, the visual effect of the scroll bar subcontrols depends on whether or not the styles understand inverted appearance; most styles ignore this property for scroll bars.

PySide2.QtWidgets.QAbstractSlider.setInvertedControls(arg__1)

Parameters:

arg__1 – bool

This property holds whether or not the slider inverts its wheel and key events..

If this property is false , scrolling the mouse wheel “up” and using keys like page up will increase the slider’s value towards its maximum. Otherwise pressing page up will move value towards the slider’s minimum.

PySide2.QtWidgets.QAbstractSlider.setMaximum(arg__1)

Parameters:

arg__1 – int

This property holds the slider’s maximum value.

When setting this property, the minimum is adjusted if necessary to ensure that the range remains valid. Also the slider’s current value is adjusted to be within the new range.

PySide2.QtWidgets.QAbstractSlider.setMinimum(arg__1)

Parameters:

arg__1 – int

This property holds the sliders’s minimum value.

When setting this property, the maximum is adjusted if necessary to ensure that the range remains valid. Also the slider’s current value is adjusted to be within the new range.

PySide2.QtWidgets.QAbstractSlider.setOrientation(arg__1)

Parameters:

arg__1 – Orientation

This property holds the orientation of the slider.

The orientation must be Vertical (the default) or Horizontal .

PySide2.QtWidgets.QAbstractSlider.setPageStep(arg__1)

Parameters:

arg__1 – int

This property holds the page step..

The larger of two natural steps that an abstract slider provides and typically corresponds to the user pressing PageUp or PageDown.

See also

singleStep

PySide2.QtWidgets.QAbstractSlider.setRange(min, max)

Parameters:

• min – int

• max – int

Sets the slider’s minimum to min and its maximum to max .

If max is smaller than min , min becomes the only legal value.

See also

minimum maximum

PySide2.QtWidgets.QAbstractSlider.setRepeatAction(action[, thresholdTime=500[, repeatTime=50]])

Parameters:

• action – SliderAction

• thresholdTime – int

• repeatTime – int

Sets action action to be triggered repetitively in intervals of repeatTime , after an initial delay of thresholdTime .

See also

triggerAction() repeatAction()

PySide2.QtWidgets.QAbstractSlider.setSingleStep(arg__1)

Parameters:

arg__1 – int

This property holds the single step..

The smaller of two natural steps that an abstract sliders provides and typically corresponds to the user pressing an arrow key.

If the property is modified during an auto repeating key event, behavior is undefined.

See also

pageStep

PySide2.QtWidgets.QAbstractSlider.setSliderDown(arg__1)

Parameters:

arg__1 – bool

This property holds whether the slider is pressed down..

The property is set by subclasses in order to let the abstract slider know whether or not tracking has any effect.

Changing the slider down property emits the sliderPressed() and sliderReleased() signals.

PySide2.QtWidgets.QAbstractSlider.setSliderPosition(arg__1)

Parameters:

arg__1 – int

This property holds the current slider position.

If tracking is enabled (the default), this is identical to value .

PySide2.QtWidgets.QAbstractSlider.setTracking(enable)

Parameters:

enable – bool

This property holds whether slider tracking is enabled.

If tracking is enabled (the default), the slider emits the valueChanged() signal while the slider is being dragged. If tracking is disabled, the slider emits the valueChanged() signal only when the user releases the slider.

See also

sliderDown

PySide2.QtWidgets.QAbstractSlider.setValue(arg__1)

Parameters:

arg__1 – int

This property holds the slider’s current value.

The slider forces the value to be within the legal range: minimum <= value <= maximum .

Changing the value also changes the sliderPosition .

PySide2.QtWidgets.QAbstractSlider.singleStep()

Return type:

int

This property holds the single step..

The smaller of two natural steps that an abstract sliders provides and typically corresponds to the user pressing an arrow key.

If the property is modified during an auto repeating key event, behavior is undefined.

See also

pageStep

PySide2.QtWidgets.QAbstractSlider.sliderChange(change)

Parameters:

change – SliderChange

Reimplement this virtual function to track slider changes such as SliderRangeChange , SliderOrientationChange , SliderStepsChange , or SliderValueChange . The default implementation only updates the display and ignores the change parameter.

PySide2.QtWidgets.QAbstractSlider.sliderMoved(position)

Parameters:

position – int

PySide2.QtWidgets.QAbstractSlider.sliderPosition()

Return type:

int

This property holds the current slider position.

If tracking is enabled (the default), this is identical to value .

PySide2.QtWidgets.QAbstractSlider.sliderPressed()

PySide2.QtWidgets.QAbstractSlider.sliderReleased()

PySide2.QtWidgets.QAbstractSlider.triggerAction(action)

Parameters:

action – SliderAction

Triggers a slider action . Possible actions are SliderSingleStepAdd , SliderSingleStepSub , SliderPageStepAdd , SliderPageStepSub , SliderToMinimum , SliderToMaximum , and SliderMove .

See also

actionTriggered()

PySide2.QtWidgets.QAbstractSlider.value()

Return type:

int

This property holds the slider’s current value.

The slider forces the value to be within the legal range: minimum <= value <= maximum .

Changing the value also changes the sliderPosition .

PySide2.QtWidgets.QAbstractSlider.valueChanged(value)

Parameters:

value – int