Table Of Contents

Previous topic


Next topic





Detailed Description

The PySide.QtGui.QScrollBar widget provides a vertical or horizontal scroll bar.

A scroll bar is a control that enables the user to access parts of a document that is larger than the widget used to display it. It provides a visual indication of the user’s current position within the document and the amount of the document that is visible. Scroll bars are usually equipped with other controls that enable more accurate navigation. Qt displays scroll bars in a way that is appropriate for each platform.

If you need to provide a scrolling view onto another widget, it may be more convenient to use the PySide.QtGui.QScrollArea class because this provides a viewport widget and scroll bars. PySide.QtGui.QScrollBar is useful if you need to implement similar functionality for specialized widgets using PySide.QtGui.QAbstractScrollArea ; for example, if you decide to subclass PySide.QtGui.QAbstractItemView . For most other situations where a slider control is used to obtain a value within a given range, the PySide.QtGui.QSlider class may be more appropriate for your needs.

Each scroll bar has a value that indicates how far the slider is from the start of the scroll bar; this is obtained with PySide.QtGui.QAbstractSlider.value() and set with PySide.QtGui.QAbstractSlider.setValue() . This value always lies within the range of values defined for the scroll bar, from PySide.QtGui.QAbstractSlider.minimum() to maximum() inclusive. The range of acceptable values can be set with PySide.QtGui.QAbstractSlider.setMinimum() and PySide.QtGui.QAbstractSlider.setMaximum() . At the minimum value, the top edge of the slider (for a vertical scroll bar) or left edge (for a horizontal scroll bar) will be at the top (or left) end of the scroll bar. At the maximum value, the bottom (or right) edge of the slider will be at the bottom (or right) end of the scroll bar.

The length of the slider is usually related to the value of the page step, and typically represents the proportion of the document area shown in a scrolling view. The page step is the amount that the value changes by when the user presses the Page Up and Page Down keys, and is set with PySide.QtGui.QAbstractSlider.setPageStep() . Smaller changes to the value defined by the line step are made using the cursor keys, and this quantity is set with PySide.QtGui.QAbstractSlider.setSingleStep() .

Note that the range of values used is independent of the actual size of the scroll bar widget. You do not need to take this into account when you choose values for the range and the page step.

The range of values specified for the scroll bar are often determined differently to those for a PySide.QtGui.QSlider because the length of the slider needs to be taken into account. If we have a document with 100 lines, and we can only show 20 lines in a widget, we may wish to construct a scroll bar with a page step of 20, a minimum value of 0, and a maximum value of 80. This would give us a scroll bar with five “pages”.

../../_images/qscrollbar-values.png The relationship between a document length, the range of values used in a scroll bar, and the page step is simple in many common situations. The scroll bar’s range of values is determined by subtracting a chosen page step from some value representing the length of the document. In such cases, the following equation is useful: document length = PySide.QtGui.QAbstractSlider.maximum() - PySide.QtGui.QAbstractSlider.minimum() + PySide.QtGui.QAbstractSlider.pageStep() .

PySide.QtGui.QScrollBar only provides integer ranges. Note that although PySide.QtGui.QScrollBar handles very large numbers, scroll bars on current screens cannot usefully represent ranges above about 100,000 pixels. Beyond that, it becomes difficult for the user to control the slider using either the keyboard or the mouse, and the scroll arrows will have limited use.

ScrollBar inherits a comprehensive set of signals from PySide.QtGui.QAbstractSlider :

A scroll bar can be controlled by the keyboard, but it has a default PySide.QtGui.QWidget.focusPolicy() of Qt.NoFocus . Use PySide.QtGui.QWidget.setFocusPolicy() to enable keyboard interaction with the scroll bar:

  • Left/Right move a horizontal scroll bar by one single step.
  • Up/Down move a vertical scroll bar by one single step.
  • PageUp moves up one page.
  • PageDown moves down one page.
  • Home moves to the start (mininum).
  • End moves to the end (maximum).

The slider itself can be controlled by using the PySide.QtGui.QAbstractSlider.triggerAction() function to simulate user interaction with the scroll bar controls. This is useful if you have many different widgets that use a common range of values.

Most GUI styles use the PySide.QtGui.QAbstractSlider.pageStep() value to calculate the size of the slider.

../../_images/macintosh-horizontalscrollbar.png A scroll bar shown in the Macintosh widget style .
../../_images/windowsxp-horizontalscrollbar.png A scroll bar shown in the Windows XP widget style .
../../_images/plastique-horizontalscrollbar.png A scroll bar shown in the Plastique widget style .

See also

PySide.QtGui.QScrollArea PySide.QtGui.QSlider PySide.QtGui.QDial PySide.QtGui.QSpinBox GUI Design Handbook: Scroll Bar Sliders Example

class PySide.QtGui.QScrollBar([parent=None])
class PySide.QtGui.QScrollBar(arg__1[, parent=None])

Constructs a vertical scroll bar.

The parent argument is sent to the PySide.QtGui.QWidget constructor.

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


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