QStyleOptionSlider Class

The QStyleOptionSlider class is used to describe the parameters needed for drawing a slider. More...

Header: #include <QStyleOptionSlider>
qmake: QT += widgets
Inherits: QStyleOptionComplex

Public Types

enum StyleOptionType { Type }
enum StyleOptionVersion { Version }

Public Functions

QStyleOptionSlider()
QStyleOptionSlider(const QStyleOptionSlider &other)

Public Variables

bool dialWrapping
int maximum
int minimum
qreal notchTarget
Qt::Orientation orientation
int pageStep
int singleStep
int sliderPosition
int sliderValue
int tickInterval
QSlider::TickPosition tickPosition
bool upsideDown

Detailed Description

The QStyleOptionSlider class is used to describe the parameters needed for drawing a slider.

QStyleOptionSlider contains all the information that QStyle functions need to draw QSlider and QScrollBar.

For performance reasons, the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

For an example demonstrating how style options can be used, see the Styles example.

See also QStyleOptionComplex, QSlider, and QScrollBar.

Member Type Documentation

enum QStyleOptionSlider::StyleOptionType

This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass.

Constant Value Description
QStyleOptionSlider::Type SO_Slider The type of style option provided (SO_Slider for this class).

The type is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

See also StyleOptionVersion.

enum QStyleOptionSlider::StyleOptionVersion

This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass.

Constant Value Description
QStyleOptionSlider::Version 1 1

The version is used by QStyleOption subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast(), you normally do not need to check it.

See also StyleOptionType.

Member Function Documentation

QStyleOptionSlider::QStyleOptionSlider()

Constructs a QStyleOptionSlider, initializing the members variables to their default values.

QStyleOptionSlider::QStyleOptionSlider(const QStyleOptionSlider &other)

Constructs a copy of the other style option.

Member Variable Documentation

bool QStyleOptionSlider::dialWrapping

This variable holds whether the dial should wrap or not

The default value is false, i.e. the dial is not wrapped.

See also QDial::wrapping().

int QStyleOptionSlider::maximum

This variable holds the maximum value for the slider

The default value is 0.

int QStyleOptionSlider::minimum

This variable holds the minimum value for the slider

The default value is 0.

qreal QStyleOptionSlider::notchTarget

This variable holds the number of pixel between notches

The default value is 0.0.

See also QDial::notchTarget().

Qt::Orientation QStyleOptionSlider::orientation

This variable holds the slider's orientation (horizontal or vertical)

The default orientation is Qt::Horizontal.

See also Qt::Orientation.

int QStyleOptionSlider::pageStep

This variable holds the size of the page step of the slider

The default value is 0.

See also QAbstractSlider::pageStep.

int QStyleOptionSlider::singleStep

This variable holds the size of the single step of the slider

The default value is 0.

See also QAbstractSlider::singleStep.

int QStyleOptionSlider::sliderPosition

This variable holds the position of the slider handle

If the slider has active feedback (i.e., QAbstractSlider::tracking is true), this value will be the same as sliderValue. Otherwise, it will have the current position of the handle. The default value is 0.

See also QAbstractSlider::tracking and sliderValue.

int QStyleOptionSlider::sliderValue

This variable holds the value of the slider

If the slider has active feedback (i.e., QAbstractSlider::tracking is true), this value will be the same as sliderPosition. Otherwise, it will have the value the slider had before the mouse was pressed.

The default value is 0.

See also QAbstractSlider::tracking and sliderPosition.

int QStyleOptionSlider::tickInterval

This variable holds the interval that should be drawn between tick marks

The default value is 0.

QSlider::TickPosition QStyleOptionSlider::tickPosition

This variable holds the position of the slider's tick marks, if any

The default value is QSlider::NoTicks.

See also QSlider::TickPosition.

bool QStyleOptionSlider::upsideDown

This variable holds the slider control orientation

Normally a slider increases as it moves up or to the right; upsideDown indicates that it should do the opposite (increase as it moves down or to the left). The default value is false, i.e. the slider increases as it moves up or to the right.

See also QStyle::sliderPositionFromValue(), QStyle::sliderValueFromPosition(), and QAbstractSlider::invertedAppearance.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qstyleoptionslider.html