QSlider

Section: Misc. Reference Manual Pages (3qt)
Updated: 2 February 2007
Index Return to Main Contents

NAME

QSlider - Vertical or horizontal slider

SYNOPSIS

#include <qslider.h>

Inherits QWidget and QRangeControl.

Public Members

enum TickSetting { NoMarks = 0, Above = 1, Left = Above, Below = 2, Right = Below, Both = 3 }

QSlider ( QWidget * parent, const char * name = 0 )

QSlider ( Orientation orientation, QWidget * parent, const char * name = 0 )

QSlider ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )

~QSlider ()

virtual void setOrientation ( Orientation )

Orientation orientation () const

virtual void setTracking ( bool enable )

bool tracking () const

virtual void setPalette ( const QPalette & p )

int sliderStart () const

QRect sliderRect () const

virtual void setTickmarks ( TickSetting )

TickSetting tickmarks () const

virtual void setTickInterval ( int )

int tickInterval () const

int minValue () const

int maxValue () const

void setMinValue ( int )

void setMaxValue ( int )

int lineStep () const

int pageStep () const

void setLineStep ( int )

void setPageStep ( int )

int value () const

Public Slots

virtual void setValue ( int )

void addStep ()

void subtractStep ()

Signals

void valueChanged ( int value )

void sliderPressed ()

void sliderMoved ( int value )

void sliderReleased ()

Important Inherited Members

void setRange ( int minValue, int maxValue )

Properties

int lineStep - the current line step

int maxValue - the current maximum value of the slider

int minValue - the current minimum value of the slider

Orientation orientation - the slider's orientation

int pageStep - the current page step

int tickInterval - the interval between tickmarks

TickSetting tickmarks - the tickmark settings for this slider

bool tracking - whether slider tracking is enabled

int value - the current slider value

Protected Members

virtual void valueChange ()

virtual void rangeChange ()

DESCRIPTION

The QSlider widget provides a vertical or horizontal slider.

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

QSlider inherits QRangeControl, which provides the "integer" side of the slider. setRange() and value() are likely to be used by practically all slider users; see the QRangeControl documentation for information about the many other functions that class provides.

The main functions offered by the slider itself are tickmark and orientation control; you can use setTickmarks() to indicate where you want the tickmarks to be, setTickInterval() to indicate how many of them you want and setOrientation() to indicate whether the slider is to be horizontal or vertical.

A slider accepts focus on Tab and uses the mouse wheel and a suitable keyboard interface.

[Image Omitted]

See also QScrollBar, QSpinBox, GUI Design Handbook: Slider, and Basic Widgets.

Member Type Documentation

QSlider::TickSetting

This enum specifies where the tickmarks are to be drawn relative to the slider's groove and the handle the user moves.

QSlider::NoMarks - do not draw any tickmarks.
QSlider::Both - draw tickmarks on both sides of the groove.
QSlider::Above - draw tickmarks above the (horizontal) slider
QSlider::Below - draw tickmarks below the (horizontal) slider
QSlider::Left - draw tickmarks to the left of the (vertical) slider
QSlider::Right - draw tickmarks to the right of the (vertical) slider

MEMBER FUNCTION DOCUMENTATION

QSlider::QSlider ( QWidget * parent, const char * name = 0 )

Constructs a vertical slider.

The parent and name arguments are sent on to the QWidget constructor.

QSlider::QSlider ( Orientation orientation, QWidget * parent, const char * name = 0 )

Constructs a slider.

The orientation must be Qt::Vertical or Qt::Horizontal.

The parent and name arguments are sent on to the QWidget constructor.

QSlider::QSlider ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )

Constructs a slider whose value can never be smaller than minValue or greater than maxValue, whose page step size is pageStep and whose value is initially value (which is guaranteed to be in range using bound()).

If orientation is Qt::Vertical the slider is vertical and if it is Qt::Horizontal the slider is horizontal.

The parent and name arguments are sent on to the QWidget constructor.

QSlider::~QSlider ()

Destructor.

void QSlider::addStep () [slot]

Moves the slider one pageStep() up or right.

int QSlider::lineStep () const

Returns the current line step. See the "lineStep" property for details.

int QSlider::maxValue () const

Returns the current maximum value of the slider. See the "maxValue" property for details.

int QSlider::minValue () const

Returns the current minimum value of the slider. See the "minValue" property for details.

Orientation QSlider::orientation () const

Returns the slider's orientation. See the "orientation" property for details.

int QSlider::pageStep () const

Returns the current page step. See the "pageStep" property for details.

void QSlider::rangeChange () [virtual protected]

Implements the virtual QRangeControl function.

Reimplemented from QRangeControl.

void QSlider::setLineStep ( int )

Sets the current line step. See the "lineStep" property for details.

void QSlider::setMaxValue ( int )

Sets the current maximum value of the slider. See the "maxValue" property for details.

void QSlider::setMinValue ( int )

Sets the current minimum value of the slider. See the "minValue" property for details.

void QSlider::setOrientation ( Orientation ) [virtual]

Sets the slider's orientation. See the "orientation" property for details.

void QSlider::setPageStep ( int )

Sets the current page step. See the "pageStep" property for details.

void QSlider::setPalette ( const QPalette & p ) [virtual]

Reimplements the virtual function QWidget::setPalette().

Sets the background color to the mid color for Motif style sliders using palette p.

Reimplemented from QWidget.

void QRangeControl::setRange ( int minValue, int maxValue )

Sets the range control's minimum value to minValue and its maximum value to maxValue.

Calls the virtual rangeChange() function if one or both of the new minimum and maximum values are different from the previous setting. Calls the virtual valueChange() function if the current value is adjusted because it was outside the new range.

If maxValue is smaller than minValue, minValue becomes the only legal value.

void QSlider::setTickInterval ( int ) [virtual]

Sets the interval between tickmarks. See the "tickInterval" property for details.

void QSlider::setTickmarks ( TickSetting ) [virtual]

Sets the tickmark settings for this slider. See the "tickmarks" property for details.

void QSlider::setTracking ( bool enable ) [virtual]

Sets whether slider tracking is enabled to enable. See the "tracking" property for details.

void QSlider::setValue ( int ) [virtual slot]

Sets the current slider value. See the "value" property for details.

void QSlider::sliderMoved ( int value ) [signal]

This signal is emitted when the slider is dragged, with the new slider value as its argument.

void QSlider::sliderPressed () [signal]

This signal is emitted when the user presses the slider with the mouse.

QRect QSlider::sliderRect () const

Returns the slider handle rectangle. (This is the visual marker that the user can move.)

void QSlider::sliderReleased () [signal]

This signal is emitted when the user releases the slider with the mouse.

int QSlider::sliderStart () const

Returns the start position of the slider.

void QSlider::subtractStep () [slot]

Moves the slider one pageStep() down or left.

int QSlider::tickInterval () const

Returns the interval between tickmarks. See the "tickInterval" property for details.

TickSetting QSlider::tickmarks () const

Returns the tickmark settings for this slider. See the "tickmarks" property for details.

bool QSlider::tracking () const

Returns TRUE if slider tracking is enabled; otherwise returns FALSE. See the "tracking" property for details.

int QSlider::value () const

Returns the current slider value. See the "value" property for details.

void QSlider::valueChange () [virtual protected]

Implements the virtual QRangeControl function.

Reimplemented from QRangeControl.

void QSlider::valueChanged ( int value ) [signal]

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

Examples:

Property Documentation

int lineStep

This property holds the current line step.

When setting lineStep, the virtual stepChange() function will be called if the new line step is different from the previous setting.

See also setSteps(), QRangeControl::pageStep(), and setRange().

Set this property's value with setLineStep() and get this property's value with lineStep().

int maxValue

This property holds the current maximum value of the slider.

When setting this property, the QSlider::minValue is adjusted, if necessary, to ensure that the range remains valid.

int minValue

This property holds the current minimum value of the slider.

When setting this property, the QSlider::maxValue is adjusted, if necessary, to ensure that the range remains valid.

Orientation orientation

This property holds the slider's orientation.

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

Set this property's value with setOrientation() and get this property's value with orientation().

int pageStep

This property holds the current page step.

When setting pageStep, the virtual stepChange() function will be called if the new page step is different from the previous setting.

See also QRangeControl::setSteps(), lineStep, and setRange().

Set this property's value with setPageStep() and get this property's value with pageStep().

int tickInterval

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 lineStep() and pageStep(). The initial value of tickInterval is 0.

See also QRangeControl::lineStep() and QRangeControl::pageStep().

Set this property's value with setTickInterval() and get this property's value with tickInterval().

TickSetting tickmarks

This property holds the tickmark settings for this slider.

The valid values are in QSlider::TickSetting. The default is NoMarks.

bool tracking

This property holds whether slider tracking is enabled.

If tracking is enabled (the default), the slider emits the valueChanged() signal whenever the slider is being dragged. If tracking is disabled, the slider emits the valueChanged() signal when the user releases the mouse button (unless the value happens to be the same as before).

Set this property's value with setTracking() and get this property's value with tracking().

int value

This property holds the current slider value.

Set this property's value with setValue() and get this property's value with value().

See also QRangeControl::value() and prevValue().

COPYRIGHT

AUTHOR

Generated automatically from the source code.

BUGS

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qslider.3qt) and the Qt version (3.3.8).

QSlider

NAME

SYNOPSIS

Public Members

Public Slots

Signals

Important Inherited Members

Properties

Protected Members

DESCRIPTION

Member Type Documentation

QSlider::TickSetting

MEMBER FUNCTION DOCUMENTATION

QSlider::QSlider ( QWidget * parent, const char * name = 0 )

QSlider::QSlider ( Orientation orientation, QWidget * parent, const char * name = 0 )

QSlider::QSlider ( int minValue, int maxValue, int pageStep, int value, Orientation orientation, QWidget * parent, const char * name = 0 )

QSlider::~QSlider ()

void QSlider::addStep () [slot]

int QSlider::lineStep () const

int QSlider::maxValue () const

int QSlider::minValue () const

Orientation QSlider::orientation () const

int QSlider::pageStep () const

void QSlider::rangeChange () [virtual protected]

void QSlider::setLineStep ( int )

void QSlider::setMaxValue ( int )

void QSlider::setMinValue ( int )

void QSlider::setOrientation ( Orientation ) [virtual]

void QSlider::setPageStep ( int )

void QSlider::setPalette ( const QPalette & p ) [virtual]

void QRangeControl::setRange ( int minValue, int maxValue )

void QSlider::setTickInterval ( int ) [virtual]

void QSlider::setTickmarks ( TickSetting ) [virtual]

void QSlider::setTracking ( bool enable ) [virtual]

void QSlider::setValue ( int ) [virtual slot]

void QSlider::sliderMoved ( int value ) [signal]

void QSlider::sliderPressed () [signal]

QRect QSlider::sliderRect () const

void QSlider::sliderReleased () [signal]

int QSlider::sliderStart () const

void QSlider::subtractStep () [slot]

int QSlider::tickInterval () const

TickSetting QSlider::tickmarks () const

bool QSlider::tracking () const

int QSlider::value () const

void QSlider::valueChange () [virtual protected]

void QSlider::valueChanged ( int value ) [signal]

Property Documentation

int lineStep

int maxValue

int minValue

Orientation orientation

int pageStep

int tickInterval

TickSetting tickmarks

bool tracking

int value

SEE ALSO

COPYRIGHT

AUTHOR

BUGS