QAbstractSlider#

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

Inherited by: QSlider, QScrollBar, QDial

Synopsis#

Properties#

invertedAppearance - Whether or not a slider shows its values inverted
invertedControls - Whether or not the slider inverts its wheel and key events
maximum - The slider’s maximum value
minimum - The sliders’s minimum value
orientation - The orientation of the slider
pageStep - The page step
singleStep - The single step
sliderDown - Whether the slider is pressed down
sliderPosition - The current slider position
tracking - Whether slider tracking is enabled
value - The slider’s current value

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)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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:

value : The bounded integer that QAbstractSlider maintains.

minimum : The lowest possible value.

maximum : The highest possible value.

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

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

tracking : Whether slider tracking is enabled.

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.

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 PySide6.QtWidgets.QAbstractSlider([parent=None])#

Parameters:: parent – PySide6.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.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtWidgets.QAbstractSlider.invertedAppearance: 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.

Access functions:

invertedAppearance ()
setInvertedAppearance (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.invertedControls: 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.

Access functions:

invertedControls ()
setInvertedControls (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.maximum: 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.

Access functions:

maximum ()
setMaximum (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.minimum: 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.

Access functions:

minimum ()
setMinimum (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.orientation: Orientation#

This property holds the orientation of the slider.

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

Access functions:

orientation ()
setOrientation (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.pageStep: 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

Access functions:

pageStep ()
setPageStep (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.singleStep: 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

Access functions:

singleStep ()
setSingleStep (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.sliderDown: 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.

Access functions:

isSliderDown ()
setSliderDown (arg__1)

property PᅟySide6.QtWidgets.QAbstractSlider.sliderPosition: int#

This property holds the current slider position.

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

Access functions:

sliderPosition ()
setSliderPosition (arg__1)
Signal sliderMoved (position)

property PᅟySide6.QtWidgets.QAbstractSlider.tracking: 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

Access functions:

hasTracking ()
setTracking (enable)

property PᅟySide6.QtWidgets.QAbstractSlider.value: 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 .

Access functions:

value ()
setValue (arg__1)
Signal valueChanged (value)

PySide6.QtWidgets.QAbstractSlider.SliderAction#

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

PySide6.QtWidgets.QAbstractSlider.SliderChange#

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

PySide6.QtWidgets.QAbstractSlider.actionTriggered(action)#

Parameters:: action – int

This signal is emitted when the slider action action is triggered. Actions are SliderSingleStepAdd , SliderSingleStepSub , SliderPageStepAdd , SliderPageStepSub , SliderToMinimum , SliderToMaximum , and SliderMove .

When the signal is emitted, the sliderPosition has been adjusted according to the action, but the value has not yet been propagated (meaning the valueChanged() signal was not yet emitted), and the visual display has not been updated. In slots connected to this signal you can thus safely adjust any action by calling setSliderPosition() yourself, based on both the action and the slider’s value.

See also

triggerAction()

PySide6.QtWidgets.QAbstractSlider.hasTracking()#

Return type:: bool

Getter of property tracking .

PySide6.QtWidgets.QAbstractSlider.invertedAppearance()#

Return type:: bool

See also

setInvertedAppearance()

Getter of property invertedAppearance .

PySide6.QtWidgets.QAbstractSlider.invertedControls()#

Return type:: bool

See also

setInvertedControls()

Getter of property invertedControls .

PySide6.QtWidgets.QAbstractSlider.isSliderDown()#

Return type:: bool

Getter of property sliderDown .

PySide6.QtWidgets.QAbstractSlider.maximum()#

Return type:: int

See also

setMaximum()

Getter of property maximum .

PySide6.QtWidgets.QAbstractSlider.minimum()#

Return type:: int

See also

setMinimum()

Getter of property minimum .

PySide6.QtWidgets.QAbstractSlider.orientation()#

Return type:: Orientation

See also

setOrientation()

Getter of property orientation .

PySide6.QtWidgets.QAbstractSlider.pageStep()#

Return type:: int

See also

setPageStep()

Getter of property pageStep .

PySide6.QtWidgets.QAbstractSlider.rangeChanged(min, max)#

Parameters:

min – int
max – int

This signal is emitted when the slider range has changed, with min being the new minimum, and max being the new maximum.

See also

minimum maximum

PySide6.QtWidgets.QAbstractSlider.repeatAction()#

Return type:: SliderAction

Returns the current repeat action.

See also

setRepeatAction()

PySide6.QtWidgets.QAbstractSlider.setInvertedAppearance(arg__1)#

Parameters:: arg__1 – bool

See also

invertedAppearance()

Setter of property invertedAppearance .

PySide6.QtWidgets.QAbstractSlider.setInvertedControls(arg__1)#

Parameters:: arg__1 – bool

See also

invertedControls()

Setter of property invertedControls .

PySide6.QtWidgets.QAbstractSlider.setMaximum(arg__1)#

Parameters:: arg__1 – int

See also

maximum()

Setter of property maximum .

PySide6.QtWidgets.QAbstractSlider.setMinimum(arg__1)#

Parameters:: arg__1 – int

See also

minimum()

Setter of property minimum .

PySide6.QtWidgets.QAbstractSlider.setOrientation(arg__1)#

Parameters:: arg__1 – Orientation

See also

orientation()

Setter of property orientation .

PySide6.QtWidgets.QAbstractSlider.setPageStep(arg__1)#

Parameters:: arg__1 – int

See also

pageStep()

Setter of property pageStep .

PySide6.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

PySide6.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()

PySide6.QtWidgets.QAbstractSlider.setSingleStep(arg__1)#

Parameters:: arg__1 – int

See also

singleStep()

Setter of property singleStep .

PySide6.QtWidgets.QAbstractSlider.setSliderDown(arg__1)#

Parameters:: arg__1 – bool

See also

isSliderDown()

Setter of property sliderDown .

PySide6.QtWidgets.QAbstractSlider.setSliderPosition(arg__1)#

Parameters:: arg__1 – int

See also

sliderPosition()

Setter of property sliderPosition .

PySide6.QtWidgets.QAbstractSlider.setTracking(enable)#

Parameters:: enable – bool

See also

hasTracking()

Setter of property tracking .

PySide6.QtWidgets.QAbstractSlider.setValue(arg__1)#

Parameters:: arg__1 – int

See also

value()

Setter of property value .

PySide6.QtWidgets.QAbstractSlider.singleStep()#

Return type:: int

See also

setSingleStep()

Getter of property singleStep .

PySide6.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.

PySide6.QtWidgets.QAbstractSlider.sliderMoved(position)#

Parameters:: position – int

This signal is emitted when sliderDown is true and the slider moves. This usually happens when the user is dragging the slider. The value is the new slider position.

This signal is emitted even when tracking is turned off.

See also

setTracking() valueChanged() isSliderDown() sliderPressed() sliderReleased()

Notification signal of property sliderPosition .

PySide6.QtWidgets.QAbstractSlider.sliderPosition()#

Return type:: int

See also

setSliderPosition()

Getter of property sliderPosition .

PySide6.QtWidgets.QAbstractSlider.sliderPressed()#

This signal is emitted when the user presses the slider with the mouse, or programmatically when setSliderDown (true) is called.

See also

sliderReleased() sliderMoved() isSliderDown()

PySide6.QtWidgets.QAbstractSlider.sliderReleased()#

This signal is emitted when the user releases the slider with the mouse, or programmatically when setSliderDown (false) is called.

See also

sliderPressed() sliderMoved() sliderDown

PySide6.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()

PySide6.QtWidgets.QAbstractSlider.value()#

Return type:: int

See also

setValue()

Getter of property value .

PySide6.QtWidgets.QAbstractSlider.valueChanged(value)#

Parameters:: value – int

This signal is emitted when the slider value has changed, with the new slider value as argument.

Notification signal of property value .