CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Properties | List of all members
ctkRangeSlider Class Reference

#include <Libs/Widgets/ctkRangeSlider.h>

Inheritance diagram for ctkRangeSlider:
Inheritance graph
[legend]
Collaboration diagram for ctkRangeSlider:
Collaboration graph
[legend]

Public Types

typedef QSlider Superclass
 

Public Slots

void setMaximumValue (int max)
 
void setMinimumValue (int min)
 
void setValues (int min, int max)
 

Signals

void maximumPositionChanged (int max)
 
void maximumValueChanged (int max)
 
void minimumPositionChanged (int min)
 
void minimumValueChanged (int min)
 
void positionsChanged (int min, int max)
 
void valuesChanged (int min, int max)
 Utility signal that is fired when minimum or maximum values have changed. More...
 

Public Member Functions

 ctkRangeSlider (Qt::Orientation o, QWidget *par=0)
 
 ctkRangeSlider (QWidget *par=0)
 
QString handleToolTip () const
 
bool isMaximumSliderDown () const
 
bool isMinimumSliderDown () const
 
int maximumPosition () const
 
int maximumValue () const
 
int minimumPosition () const
 
int minimumValue () const
 
void setHandleToolTip (const QString &toolTip)
 
void setMaximumPosition (int max)
 
void setMinimumPosition (int min)
 
void setPositions (int min, int max)
 
void setSymmetricMoves (bool symmetry)
 
bool symmetricMoves () const
 
virtual ~ctkRangeSlider ()
 

Protected Slots

void onRangeChanged (int minimum, int maximum)
 

Protected Member Functions

 ctkRangeSlider (ctkRangeSliderPrivate *impl, Qt::Orientation o, QWidget *par=0)
 
 ctkRangeSlider (ctkRangeSliderPrivate *impl, QWidget *par=0)
 
virtual bool event (QEvent *event)
 
virtual void initMaximumSliderStyleOption (QStyleOptionSlider *option) const
 
virtual void initMinimumSliderStyleOption (QStyleOptionSlider *option) const
 
virtual void mouseMoveEvent (QMouseEvent *ev)
 
virtual void mousePressEvent (QMouseEvent *ev)
 
virtual void mouseReleaseEvent (QMouseEvent *ev)
 
virtual void paintEvent (QPaintEvent *ev)
 

Protected Attributes

QScopedPointer< ctkRangeSliderPrivate > d_ptr
 

Properties

QString handleToolTip
 
int maximumPosition
 
int maximumValue
 
int minimumPosition
 
int minimumValue
 
bool symmetricMoves
 

Detailed Description

A ctkRangeSlider is a slider that lets you input 2 values instead of one (see QSlider). These values are typically a lower and upper bound. Values are comprised between the range of the slider. See setRange(), minimum() and maximum(). The upper bound can't be smaller than the lower bound and vice-versa. When setting new values (setMinimumValue(), setMaximumValue() or setValues()), make sure they lie between the range (minimum(), maximum()) of the slider, they would be forced otherwised. If it is not the behavior you desire, you can set the range first (setRange(), setMinimum(), setMaximum()) TODO: support triggerAction(QAbstractSlider::SliderSingleStepSub) that moves both values at a time.

See also
ctkDoubleRangeSlider, ctkDoubleSlider, ctkRangeWidget

Definition at line 50 of file ctkRangeSlider.h.

Member Typedef Documentation

◆ Superclass

typedef QSlider ctkRangeSlider::Superclass

Definition at line 62 of file ctkRangeSlider.h.

Constructor & Destructor Documentation

◆ ctkRangeSlider() [1/4]

ctkRangeSlider::ctkRangeSlider ( Qt::Orientation  o,
QWidget *  par = 0 
)
explicit

Constructor, builds a ctkRangeSlider that ranges from 0 to 100 and has a lower and upper values of 0 and 100 respectively, other properties are set the QSlider default properties.

◆ ctkRangeSlider() [2/4]

ctkRangeSlider::ctkRangeSlider ( QWidget *  par = 0)
explicit

◆ ~ctkRangeSlider()

virtual ctkRangeSlider::~ctkRangeSlider ( )
virtual

◆ ctkRangeSlider() [3/4]

ctkRangeSlider::ctkRangeSlider ( ctkRangeSliderPrivate *  impl,
Qt::Orientation  o,
QWidget *  par = 0 
)
protected

◆ ctkRangeSlider() [4/4]

ctkRangeSlider::ctkRangeSlider ( ctkRangeSliderPrivate *  impl,
QWidget *  par = 0 
)
protected

Member Function Documentation

◆ event()

virtual bool ctkRangeSlider::event ( QEvent *  event)
protectedvirtual

◆ handleToolTip()

QString ctkRangeSlider::handleToolTip ( ) const

Controls the text to display for the handle tooltip. It is in addition to the widget tooltip. "%1" is replaced by the current value of the slider. Empty string (by default) means no tooltip.

◆ initMaximumSliderStyleOption()

virtual void ctkRangeSlider::initMaximumSliderStyleOption ( QStyleOptionSlider *  option) const
protectedvirtual

◆ initMinimumSliderStyleOption()

virtual void ctkRangeSlider::initMinimumSliderStyleOption ( QStyleOptionSlider *  option) const
protectedvirtual

◆ isMaximumSliderDown()

bool ctkRangeSlider::isMaximumSliderDown ( ) const

Returns true if the maximum value handle is down, false if it is up.

See also
isMinimumSliderDown()

◆ isMinimumSliderDown()

bool ctkRangeSlider::isMinimumSliderDown ( ) const

Returns true if the minimum value handle is down, false if it is up.

See also
isMaximumSliderDown()

◆ maximumPosition()

int ctkRangeSlider::maximumPosition ( ) const

This property holds the current slider maximum position. If tracking is enabled (the default), this is identical to maximumValue.

◆ maximumPositionChanged

void ctkRangeSlider::maximumPositionChanged ( int  max)
signal

This signal is emitted when sliderDown is true and the slider moves. This usually happens when the user is dragging the maximum slider. The value is the new slider maximum position. This signal is emitted even when tracking is turned off.

◆ maximumValue()

int ctkRangeSlider::maximumValue ( ) const

This property holds the slider's current maximum value. The slider forces the maximum value to be within the legal range: The slider silently forces maximumValue to be within the legal range: Changing the maximumValue also changes the maximumPosition.

◆ maximumValueChanged

void ctkRangeSlider::maximumValueChanged ( int  max)
signal

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

◆ minimumPosition()

int ctkRangeSlider::minimumPosition ( ) const

This property holds the current slider minimum position. If tracking is enabled (the default), this is identical to minimumValue.

◆ minimumPositionChanged

void ctkRangeSlider::minimumPositionChanged ( int  min)
signal

This signal is emitted when sliderDown is true and the slider moves. This usually happens when the user is dragging the minimum slider. The value is the new slider minimum position. This signal is emitted even when tracking is turned off.

◆ minimumValue()

int ctkRangeSlider::minimumValue ( ) const

This property holds the slider's current minimum value. The slider silently forces minimumValue to be within the legal range: minimum() <= minimumValue() <= maximumValue() <= maximum(). Changing the minimumValue also changes the minimumPosition.

◆ minimumValueChanged

void ctkRangeSlider::minimumValueChanged ( int  min)
signal

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

◆ mouseMoveEvent()

virtual void ctkRangeSlider::mouseMoveEvent ( QMouseEvent *  ev)
protectedvirtual

◆ mousePressEvent()

virtual void ctkRangeSlider::mousePressEvent ( QMouseEvent *  ev)
protectedvirtual

◆ mouseReleaseEvent()

virtual void ctkRangeSlider::mouseReleaseEvent ( QMouseEvent *  ev)
protectedvirtual

◆ onRangeChanged

void ctkRangeSlider::onRangeChanged ( int  minimum,
int  maximum 
)
protectedslot

◆ paintEvent()

virtual void ctkRangeSlider::paintEvent ( QPaintEvent *  ev)
protectedvirtual

◆ positionsChanged

void ctkRangeSlider::positionsChanged ( int  min,
int  max 
)
signal

Utility signal that is fired when minimum or maximum positions have changed.

◆ setHandleToolTip()

void ctkRangeSlider::setHandleToolTip ( const QString &  toolTip)

◆ setMaximumPosition()

void ctkRangeSlider::setMaximumPosition ( int  max)

◆ setMaximumValue

void ctkRangeSlider::setMaximumValue ( int  max)
slot

This property holds the slider's current maximum value. The slider silently forces max to be within the legal range: minimum() <= minimumValue() <= max <= maximum(). Note: Changing the maximumValue also changes the maximumPosition.

See also
stMinimumValue, setValues, setMinimum, setMaximum, setRange

◆ setMinimumPosition()

void ctkRangeSlider::setMinimumPosition ( int  min)

◆ setMinimumValue

void ctkRangeSlider::setMinimumValue ( int  min)
slot

This property holds the slider's current minimum value. The slider silently forces min to be within the legal range: minimum() <= min <= maximumValue() <= maximum(). Note: Changing the minimumValue also changes the minimumPosition.

See also
stMaximumValue, setValues, setMinimum, setMaximum, setRange

◆ setPositions()

void ctkRangeSlider::setPositions ( int  min,
int  max 
)

Utility function that set the minimum position and maximum position at once.

◆ setSymmetricMoves()

void ctkRangeSlider::setSymmetricMoves ( bool  symmetry)

◆ setValues

void ctkRangeSlider::setValues ( int  min,
int  max 
)
slot

Utility function that set the minimum value and maximum value at once. The slider silently forces min and max to be within the legal range: minimum() <= min <= max <= maximum(). Note: Changing the minimumValue and maximumValue also changes the minimumPosition and maximumPosition.

See also
setMinimumValue, setMaximumValue, setMinimum, setMaximum, setRange

◆ symmetricMoves()

bool ctkRangeSlider::symmetricMoves ( ) const

When symmetricMoves is true, moving a handle will move the other handle symmetrically, otherwise the handles are independent. False by default

◆ valuesChanged

void ctkRangeSlider::valuesChanged ( int  min,
int  max 
)
signal

Utility signal that is fired when minimum or maximum values have changed.

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkRangeSliderPrivate> ctkRangeSlider::d_ptr
protected

Definition at line 204 of file ctkRangeSlider.h.

Property Documentation

◆ handleToolTip

QString ctkRangeSlider::handleToolTip
readwrite

Definition at line 1 of file ctkRangeSlider.h.

◆ maximumPosition

int ctkRangeSlider::maximumPosition
readwrite

Definition at line 1 of file ctkRangeSlider.h.

◆ maximumValue

int ctkRangeSlider::maximumValue
readwrite

Definition at line 1 of file ctkRangeSlider.h.

◆ minimumPosition

int ctkRangeSlider::minimumPosition
readwrite

Definition at line 1 of file ctkRangeSlider.h.

◆ minimumValue

int ctkRangeSlider::minimumValue
readwrite

Definition at line 1 of file ctkRangeSlider.h.

◆ symmetricMoves

bool ctkRangeSlider::symmetricMoves
readwrite

Definition at line 1 of file ctkRangeSlider.h.


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