class QSlider#

The QSlider widget provides a vertical or horizontal slider. More

Inheritance diagram of PySide6.QtWidgets.QSlider

Synopsis#

Properties#

Methods#

Virtual methods#

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#

../../_images/windows-slider.png

The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal or vertical groove and translates the handle’s position into an integer value within the legal range.

QSlider has very few of its own functions; most of the functionality is in QAbstractSlider . The most useful functions are setValue() to set the slider directly to some value; triggerAction() to simulate the effects of clicking (useful for shortcut keys); setSingleStep() , setPageStep() to set the steps; and setMinimum() and setMaximum() to define the range of the scroll bar.

QSlider provides methods for controlling tickmarks. You can use setTickPosition() to indicate where you want the tickmarks to be, setTickInterval() to indicate how many of them you want. the currently set tick position and interval can be queried using the tickPosition() and tickInterval() functions, respectively.

QSlider inherits a comprehensive set of signals:

Signal

Description

valueChanged()

Emitted when the slider’s value has changed. The tracking() determines whether this signal is emitted during user interaction.

sliderPressed()

Emitted when the user starts to drag the slider.

sliderMoved()

Emitted when the user drags the slider.

sliderReleased()

Emitted when the user releases the slider.

QSlider only provides integer ranges. Note that although QSlider handles very large numbers, it becomes difficult for users to use a slider accurately for very large ranges.

A slider accepts focus on Tab and provides both a mouse wheel and a keyboard interface. The keyboard interface is the following:

  • Left/Right move a horizontal slider by one single step.

  • Up/Down move a vertical slider by one single step.

  • PageUp moves up one page.

  • PageDown moves down one page.

  • Home moves to the start (minimum).

  • End moves to the end (maximum).

class TickPosition#

This enum specifies where the tick marks are to be drawn relative to the slider’s groove and the handle the user moves.

Constant

Description

QSlider.NoTicks

Do not draw any tick marks.

QSlider.TicksBothSides

Draw tick marks on both sides of the groove.

QSlider.TicksAbove

Draw tick marks above the (horizontal) slider

QSlider.TicksBelow

Draw tick marks below the (horizontal) slider

QSlider.TicksLeft

Draw tick marks to the left of the (vertical) slider

QSlider.TicksRight

Draw tick marks to the right of the (vertical) slider

Note

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

property tickIntervalᅟ: int#

This property holds the interval between tickmarks.

This is a value interval, not a pixel interval. If it is 0, the slider will choose between singleStep and pageStep.

The default value is 0.

Access functions:
property tickPositionᅟ: QSlider.TickPosition#

This property holds the tickmark position for this slider.

The valid values are described by the TickPosition enum.

The default value is NoTicks .

See also

tickInterval

Access functions:
__init__([parent=None])#
Parameters:

parentQWidget

Constructs a vertical slider with the given parent.

__init__(orientation[, parent=None])
Parameters:

Constructs a slider with the given parent. The orientation parameter determines whether the slider is horizontal or vertical; the valid values are Qt::Vertical and Qt::Horizontal.

initStyleOption(option)#
Parameters:

optionQStyleOptionSlider

Initialize option with the values from this QSlider . This method is useful for subclasses when they need a QStyleOptionSlider , but don’t want to fill in all the information themselves.

See also

initFrom()

setTickInterval(ti)#
Parameters:

ti – int

See also

tickInterval()

Setter of property tickIntervalᅟ .

setTickPosition(position)#
Parameters:

positionTickPosition

See also

tickPosition()

Setter of property tickPositionᅟ .

tickInterval()#
Return type:

int

Getter of property tickIntervalᅟ .

tickPosition()#
Return type:

TickPosition

Getter of property tickPositionᅟ .