A slider control with two interactive endpoints, for interactive selection of a range of values. More...

#include <qgsrangeslider.h>

Inheritance diagram for QgsRangeSlider:

Public Slots
bool	event (QEvent *event) override

void	setLowerValue (int value)
	Sets the lower value for the range currently selected in the widget.

void	setMaximum (int maximum)
	Sets the maximum value allowed in the widget.

void	setMinimum (int minimum)
	Sets the minimum value allowed in the widget.

void	setPageStep (int step)
	Sets the page step value for the widget.

void	setRange (int lower, int upper)
	Sets the current range selected in the widget.

void	setRangeLimits (int minimum, int maximum)
	Sets the minimum and maximum range limits for values allowed in the widget.

void	setSingleStep (int step)
	Sets the single step value for the widget.

void	setUpperValue (int value)
	Sets the upper value for the range currently selected in the widget.

Signals
void	fixedRangeSizeChanged (int size)
	Emitted when the widget's fixed range size is changed.

void	rangeChanged (int minimum, int maximum)
	Emitted when the range selected in the widget is changed.

void	rangeLimitsChanged (int minimum, int maximum)
	Emitted when the limits of values allowed in the widget is changed.

Public Member Functions
	QgsRangeSlider (Qt::Orientation orientation, QWidget *parent=nullptr)
	Constructor for QgsRangeSlider, with the specified parent widget.

	QgsRangeSlider (QWidget *parent=nullptr)
	Constructor for QgsRangeSlider, with the specified parent widget.

int	fixedRangeSize () const
	Returns the slider's fixed range size, or -1 if not set.

bool	flippedDirection () const
	Returns `true` if the slider has its values flipped.

void	keyPressEvent (QKeyEvent *event) override

int	lowerValue () const
	Returns the lower value for the range selected in the widget.

int	maximum () const
	Returns the maximum value allowed by the widget.

int	minimum () const
	Returns the minimum value allowed by the widget.

QSize	minimumSizeHint () const override

void	mouseMoveEvent (QMouseEvent *event) override

void	mousePressEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override

Qt::Orientation	orientation () const
	Returns the orientation of the slider.

int	pageStep () const
	Returns the page step value for the widget.

void	paintEvent (QPaintEvent *event) override

void	setFixedRangeSize (int size)
	Sets the slider's fixed range size.

void	setFlippedDirection (bool flipped)
	Sets whether the slider has its values flipped.

void	setOrientation (Qt::Orientation orientation)
	Sets the orientation of the slider.

void	setTickInterval (int interval)
	Sets the interval for tick marks shown in the widget.

void	setTickPosition (QSlider::TickPosition position)
	Sets the position of the tick marks shown in the widget.

int	singleStep () const
	Returns the single step value for the widget.

QSize	sizeHint () const override

int	tickInterval () const
	Returns the interval for tick marks shown in the widget.

QSlider::TickPosition	tickPosition () const
	Returns the position of the tick marks shown in the widget.

int	upperValue () const
	Returns the upper value for the range selected in the widget.

Detailed Description

A slider control with two interactive endpoints, for interactive selection of a range of values.

Since: QGIS 3.18

Definition at line 31 of file qgsrangeslider.h.

Constructor & Destructor Documentation

◆ QgsRangeSlider() [1/2]

QgsRangeSlider::QgsRangeSlider ( QWidget * parent = nullptr )

Constructor for QgsRangeSlider, with the specified parent widget.

Definition at line 21 of file qgsrangeslider.cpp.

◆ QgsRangeSlider() [2/2]

QgsRangeSlider::QgsRangeSlider	(	Qt::Orientation	orientation,
		QWidget *	parent = `nullptr`
	)

Constructor for QgsRangeSlider, with the specified parent widget.

The orientation parameter determines whether the slider is horizontal or vertical.

Definition at line 26 of file qgsrangeslider.cpp.

Member Function Documentation

◆ event

bool QgsRangeSlider::event ( QEvent * event )

overrideslot

Definition at line 186 of file qgsrangeslider.cpp.

◆ fixedRangeSize()

int QgsRangeSlider::fixedRangeSize ( ) const

Returns the slider's fixed range size, or -1 if not set.

If a fixed range size is set then moving either the lower or upper slider will automatically move the other slider accordingly, in order to keep the selected range at the specified fixed size.

See also: setFixedRangeSize()

Since: QGIS 3.38

Definition at line 330 of file qgsrangeslider.cpp.

◆ fixedRangeSizeChanged

void QgsRangeSlider::fixedRangeSizeChanged ( int size )

signal

Emitted when the widget's fixed range size is changed.

See also: fixedRangeSize(); setFixedRangeSize()

Since: QGIS 3.38

◆ flippedDirection()

bool QgsRangeSlider::flippedDirection ( ) const

Returns true if the slider has its values flipped.

If this property is false (the default), the minimum and maximum will be shown in its classic position for the widget. If the value is true, the minimum and maximum appear at their opposite location.

See also: setFlippedDirection()

Definition at line 501 of file qgsrangeslider.cpp.

◆ keyPressEvent()

void QgsRangeSlider::keyPressEvent ( QKeyEvent * event )

override

Definition at line 806 of file qgsrangeslider.cpp.

◆ lowerValue()

int QgsRangeSlider::lowerValue ( ) const

Returns the lower value for the range selected in the widget.

See also: upperValue(); setLowerValue()

Definition at line 113 of file qgsrangeslider.cpp.

◆ maximum()

int QgsRangeSlider::maximum ( ) const

Returns the maximum value allowed by the widget.

See also: setMaximum(); minimum()

Definition at line 44 of file qgsrangeslider.cpp.

◆ minimum()

int QgsRangeSlider::minimum ( ) const

Returns the minimum value allowed by the widget.

See also: setMinimum(); maximum()

Definition at line 68 of file qgsrangeslider.cpp.

◆ minimumSizeHint()

QSize QgsRangeSlider::minimumSizeHint ( ) const

override

Definition at line 1145 of file qgsrangeslider.cpp.

◆ mouseMoveEvent()

void QgsRangeSlider::mouseMoveEvent ( QMouseEvent * event )

override

Definition at line 636 of file qgsrangeslider.cpp.

◆ mousePressEvent()

void QgsRangeSlider::mousePressEvent ( QMouseEvent * event )

override

Definition at line 578 of file qgsrangeslider.cpp.

◆ mouseReleaseEvent()

void QgsRangeSlider::mouseReleaseEvent ( QMouseEvent * event )

override

Definition at line 793 of file qgsrangeslider.cpp.

◆ orientation()

Qt::Orientation QgsRangeSlider::orientation ( ) const

Returns the orientation of the slider.

See also: setOrientation()

Definition at line 496 of file qgsrangeslider.cpp.

◆ pageStep()

int QgsRangeSlider::pageStep ( ) const

Returns the page step value for the widget.

This corresponds to the larger increment or decrement applied when the user presses the page increment key (usually PageUp or PageDown).

See also: setPageStep(); singleStep()

Definition at line 442 of file qgsrangeslider.cpp.

◆ paintEvent()

void QgsRangeSlider::paintEvent ( QPaintEvent * event )

override

Definition at line 512 of file qgsrangeslider.cpp.

◆ rangeChanged

void QgsRangeSlider::rangeChanged	(	int	minimum,
		int	maximum
	)

signal

Emitted when the range selected in the widget is changed.

◆ rangeLimitsChanged

void QgsRangeSlider::rangeLimitsChanged	(	int	minimum,
		int	maximum
	)

signal

Emitted when the limits of values allowed in the widget is changed.

◆ setFixedRangeSize()

void QgsRangeSlider::setFixedRangeSize ( int size )

Sets the slider's fixed range size.

Set to -1 if no fixed size is desired.

If a fixed range size is set then moving either the lower or upper slider will automatically move the other slider accordingly, in order to keep the selected range at the specified fixed size.

See also: fixedRangeSize()

Since: QGIS 3.38

Definition at line 335 of file qgsrangeslider.cpp.

◆ setFlippedDirection()

void QgsRangeSlider::setFlippedDirection ( bool flipped )

Sets whether the slider has its values flipped.

If this property is false (the default), the minimum and maximum will be shown in its classic position for the widget. If the value is true, the minimum and maximum appear at their opposite location. (i.e. minimum at the bottom of a vertical slider, maximum at the top of a vertical slider).

See also: flippedDirection()

Definition at line 506 of file qgsrangeslider.cpp.

◆ setLowerValue

void QgsRangeSlider::setLowerValue ( int value )

slot

Sets the lower value for the range currently selected in the widget.

See also: lowerValue(); setRange(); setUpperValue()

Definition at line 118 of file qgsrangeslider.cpp.

◆ setMaximum

void QgsRangeSlider::setMaximum ( int maximum )

slot

Sets the maximum value allowed in the widget.

See also: maximum(); setMinimum()

Definition at line 49 of file qgsrangeslider.cpp.

◆ setMinimum

void QgsRangeSlider::setMinimum ( int minimum )

slot

Sets the minimum value allowed in the widget.

See also: minimum(); setMaximum()

Definition at line 73 of file qgsrangeslider.cpp.

◆ setOrientation()

void QgsRangeSlider::setOrientation ( Qt::Orientation orientation )

Sets the orientation of the slider.

See also: orientation()

Definition at line 484 of file qgsrangeslider.cpp.

◆ setPageStep

void QgsRangeSlider::setPageStep ( int step )

slot

Sets the page step value for the widget.

This corresponds to the larger increment or decrement applied when the user presses the page increment key (usually PageUp or PageDown).

See also: pageStep(); setSingleStep()

Definition at line 447 of file qgsrangeslider.cpp.

◆ setRange

void QgsRangeSlider::setRange	(	int	lower,
		int	upper
	)

slot

Sets the current range selected in the widget.

See also: setLowerValue(); setUpperValue()

Definition at line 163 of file qgsrangeslider.cpp.

◆ setRangeLimits

void QgsRangeSlider::setRangeLimits	(	int	minimum,
		int	maximum
	)

slot

Sets the minimum and maximum range limits for values allowed in the widget.

See also: setMinimum(); setMaximum()

Definition at line 91 of file qgsrangeslider.cpp.

◆ setSingleStep

void QgsRangeSlider::setSingleStep ( int step )

slot

Sets the single step value for the widget.

This corresponds to the smaller increment or decrement applied when the user presses an arrow key.

See also: singleStep(); pageStep()

Definition at line 457 of file qgsrangeslider.cpp.

◆ setTickInterval()

void QgsRangeSlider::setTickInterval ( int interval )

Sets the interval for tick marks shown in the widget.

See also: tickInterval()

Definition at line 473 of file qgsrangeslider.cpp.

◆ setTickPosition()

void QgsRangeSlider::setTickPosition ( QSlider::TickPosition position )

Sets the position of the tick marks shown in the widget.

See also: tickPosition()

Definition at line 462 of file qgsrangeslider.cpp.

◆ setUpperValue

void QgsRangeSlider::setUpperValue ( int value )

slot

Sets the upper value for the range currently selected in the widget.

See also: upperValue(); setRange(); setLowerValue()

Definition at line 143 of file qgsrangeslider.cpp.

◆ singleStep()

int QgsRangeSlider::singleStep ( ) const

Returns the single step value for the widget.

This corresponds to the smaller increment or decrement applied when the user presses an arrow key.

See also: setSingleStep(); pageStep()

Definition at line 452 of file qgsrangeslider.cpp.

◆ sizeHint()

QSize QgsRangeSlider::sizeHint ( ) const

override

Definition at line 1124 of file qgsrangeslider.cpp.

◆ tickInterval()

int QgsRangeSlider::tickInterval ( ) const

Returns the interval for tick marks shown in the widget.

See also: setTickInterval()

Definition at line 479 of file qgsrangeslider.cpp.

◆ tickPosition()

QSlider::TickPosition QgsRangeSlider::tickPosition ( ) const

Returns the position of the tick marks shown in the widget.

See also: setTickPosition()

Definition at line 468 of file qgsrangeslider.cpp.

◆ upperValue()

int QgsRangeSlider::upperValue ( ) const

Returns the upper value for the range selected in the widget.

See also: lowerValue(); setUpperValue()

Definition at line 137 of file qgsrangeslider.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgsrangeslider.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgsrangeslider.cpp

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsRangeSlider() [1/2]

◆ QgsRangeSlider() [2/2]

Member Function Documentation

◆ event

◆ fixedRangeSize()

◆ fixedRangeSizeChanged

◆ flippedDirection()

◆ keyPressEvent()

◆ lowerValue()

◆ maximum()

◆ minimum()

◆ minimumSizeHint()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ orientation()

◆ pageStep()

◆ paintEvent()

◆ rangeChanged

◆ rangeLimitsChanged

◆ setFixedRangeSize()

◆ setFlippedDirection()

◆ setLowerValue

◆ setMaximum

◆ setMinimum

◆ setOrientation()

◆ setPageStep

◆ setRange

◆ setRangeLimits

◆ setSingleStep

◆ setTickInterval()

◆ setTickPosition()

◆ setUpperValue

◆ singleStep()

◆ sizeHint()

◆ tickInterval()

◆ tickPosition()

◆ upperValue()