logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

QwtAbstractSlider - An abstract base class for slider widgets with a scale.

Author

       Generated automatically by Doxygen for Qwt User's Guide from the source code.

Version 6.1.4                                    Wed Jan 2 2019                             QwtAbstractSlider(3)

Constructor & Destructor Documentation

QwtAbstractSlider::QwtAbstractSlider(QWidget*parent=NULL)[explicit]
       Constructor. The scale is initialized to [0.0, 100.0], the number of steps is set to 100 with 1 and 10
       and single an page step sizes. Step alignment is enabled.

       The initial value is invalid.

       Parameters:parent Parent widget

Detailed Description

       An abstract base class for slider widgets with a scale.

       A slider widget displays a value according to a scale. The class is designed as a common super class for
       widgets like QwtKnob, QwtDial and QwtSlider.

       When the slider is nor readOnly() its value can be modified by keyboard, mouse and wheel inputs.

       The range of the slider is divided into a number of steps from which the value increments according to
       user inputs depend. Only for linear scales the number of steps correspond with a fixed step size.

Member Function Documentation

doubleQwtAbstractSlider::incrementedValue(doublevalue,intstepCount)const[protected]
       Increment a value

       Parameters:value Value
           stepCount Number of steps

       Returns:
           Incremented value

   voidQwtAbstractSlider::incrementValue(intstepCount)[protected]
       Increment the slider

       The step size depends on the number of totalSteps()Parameters:stepCount Number of steps

       Seealso:setTotalSteps(), incrementedValue()boolQwtAbstractSlider::invertedControls()constReturns:
           True, when the controls are inverted

       Seealso:setInvertedControls()boolQwtAbstractSlider::isReadOnly()const
       In read only mode the slider can't be controlled by mouse or keyboard.

       Returns:
           true if read only

       Seealso:setReadOnly()virtualboolQwtAbstractSlider::isScrollPosition(constQPoint&pos)const[protected],[purevirtual]
       Determine what to do when the user presses a mouse button.

       Parameters:pos Mouse position

       Returnvalues:True,when pos is a valid scroll position

       Seealso:scrolledTo()

       Implemented in QwtKnob, QwtDial, and QwtSlider.

   boolQwtAbstractSlider::isTracking()constReturns:
           True, when tracking has been enabled

       Seealso:setTracking()boolQwtAbstractSlider::isValid()constReturns:
           True, when the value is invalid

   voidQwtAbstractSlider::keyPressEvent(QKeyEvent*event)[protected],[virtual]
       Handles key events

       QwtAbstractSlider handles the following keys:

       • Qt::Key_Left
          Add/Subtract singleSteps() in direction to lowerBound();

       • Qt::Key_Right
          Add/Subtract singleSteps() in direction to upperBound();

       • Qt::Key_Down
          Subtract singleSteps(), when invertedControls() is false

       • Qt::Key_Up
          Add singleSteps(), when invertedControls() is false

       • Qt::Key_PageDown
          Subtract pageSteps(), when invertedControls() is false

       • Qt::Key_PageUp
          Add pageSteps(), when invertedControls() is false

       • Qt::Key_Home
          Set the value to the minimum()

       • Qt::Key_End
          Set the value to the maximum()Parameters:event Key event

       Seealso:isReadOnly()

       Reimplemented in QwtCompass.

   voidQwtAbstractSlider::mouseMoveEvent(QMouseEvent*event)[protected],[virtual]
       Mouse Move Event handler

       Parameters:event Mouse event

   voidQwtAbstractSlider::mousePressEvent(QMouseEvent*event)[protected],[virtual]
       Mouse press event handler

       Parameters:event Mouse event

       Reimplemented in QwtSlider.

   voidQwtAbstractSlider::mouseReleaseEvent(QMouseEvent*event)[protected],[virtual]
       Mouse Release Event handler

       Parameters:event Mouse event

       Reimplemented in QwtSlider.

   uintQwtAbstractSlider::pageSteps()constReturns:
           Number of steps

       Seealso:setPageSteps(), totalSteps(), singleSteps()voidQwtAbstractSlider::scaleChange()[protected],[virtual]
       Update the slider according to modifications of the scale

       Reimplemented from QwtAbstractScale.

       Reimplemented in QwtDial, and QwtSlider.

   virtualdoubleQwtAbstractSlider::scrolledTo(constQPoint&pos)const[protected],[purevirtual]
       Determine the value for a new position of the movable part of the slider.

       Parameters:pos Mouse position

       Returns:
           Value for the mouse position

       Seealso:isScrollPosition()

       Implemented in QwtKnob, QwtDial, and QwtSlider.

   voidQwtAbstractSlider::setInvertedControls(boolon)
       Invert wheel and key events

       Usually  scrolling  the  mouse  wheel  'up'  and using keys like page up will increase the slider's value
       towards its maximum. When invertedControls() is enabled the value is scrolled towards its minimum.

       Inverting the controls might be f.e. useful for a vertical slider with an  inverted  scale  (  decreasing
       from top to bottom ).

       Parameters:on Invert controls, when true

       Seealso:invertedControls(), keyEvent(), wheelEvent()voidQwtAbstractSlider::setPageSteps(uintstepCount)
       Set  the  number of steps for a page increment. The range of the slider is divided into a number of steps
       from which the value increments according to user inputs depend.

       Parameters:stepCount Number of steps

       Seealso:pageSteps(), setTotalSteps(), setSingleSteps()voidQwtAbstractSlider::setReadOnly(boolon)
       En/Disable read only mode

       In read only mode the slider can't be controlled by mouse or keyboard.

       Parameters:on Enables in case of true

       Seealso:isReadOnly()Warning:
           The focus policy is set to Qt::StrongFocus or Qt::NoFocus

   voidQwtAbstractSlider::setSingleSteps(uintstepCount)
       Set the number of steps for a single increment. The range of the slider is divided into a number of steps
       from which the value increments according to user inputs depend.

       Parameters:stepCount Number of steps

       Seealso:singleSteps(), setTotalSteps(), setPageSteps()voidQwtAbstractSlider::setStepAlignment(boolon)
       Enable step alignment. When step alignment is enabled values resulting from slider movements are  aligned
       to the step size.

       Parameters:on Enable step alignment when true

       Seealso:stepAlignment()voidQwtAbstractSlider::setTotalSteps(uintstepCount)
       Set  the  number of steps. The range of the slider is divided into a number of steps from which the value
       increments according to user inputs depend.

       The default setting is 100.

       Parameters:stepCount Number of steps

       Seealso:totalSteps(), setSingleSteps(), setPageSteps()voidQwtAbstractSlider::setTracking(boolon)
       Enables or disables tracking. If tracking is enabled, the slider emits the  valueChanged()  signal  while
       the  movable  part  of  the  slider  is  being  dragged.  If  tracking  is disabled, the slider emits the
       valueChanged() signal only when the user releases the slider.

       Tracking is enabled by default.

       Parameters:on true (enable) or false (disable) tracking.

       Seealso:isTracking(), sliderMoved()voidQwtAbstractSlider::setValid(boolon)
       Set the value to be valid/invalid

       Parameters:on When true, the value is invalidated

       Seealso:setValue()voidQwtAbstractSlider::setValue(doublevalue)[slot]
       Set the slider to the specified value

       Parameters:value New value

       Seealso:setValid(), sliderChange(), valueChanged()voidQwtAbstractSlider::setWrapping(boolon)
       If wrapping is true stepping up from upperBound() value will take you to the  minimum()  value  and  vice
       versa.

       Parameters:on En/Disable wrapping

       Seealso:wrapping()uintQwtAbstractSlider::singleSteps()constReturns:
           Number of steps

       Seealso:setSingleSteps(), totalSteps(), pageSteps()voidQwtAbstractSlider::sliderMoved(doublevalue)[signal]
       This signal is emitted when the user moves the slider with the mouse.

       Parameters:value New value

       Seealso:valueChanged()voidQwtAbstractSlider::sliderPressed()[signal]
       This signal is emitted when the user presses the movable part of the slider.

   voidQwtAbstractSlider::sliderReleased()[signal]
       This signal is emitted when the user releases the movable part of the slider.

   boolQwtAbstractSlider::stepAlignment()constReturns:
           True, when step alignment is enabled

       Seealso:setStepAlignment()uintQwtAbstractSlider::totalSteps()constReturns:
           Number of steps

       Seealso:setTotalSteps(), singleSteps(), pageSteps()voidQwtAbstractSlider::valueChanged(doublevalue)[signal]
       Notify  a  change of value. When tracking is enabled (default setting), this signal will be emitted every
       time the value changes.

       Parameters:value New value

       Seealso:setTracking(), sliderMoved()voidQwtAbstractSlider::wheelEvent(QWheelEvent*event)[protected],[virtual]
       Wheel Event handler

       In/decreases the value by s number of steps. The direction depends on the invertedControls() property.

       When the control or shift modifier is pressed the wheel delta  (  divided  by  120  )  is  mapped  to  an
       increment according to pageSteps(). Otherwise it is mapped to singleSteps().

       Parameters:event Wheel event

       Reimplemented in QwtDial.

   boolQwtAbstractSlider::wrapping()constReturns:
           True, when wrapping is set

       Seealso:setWrapping()

Name

       QwtAbstractSlider - An abstract base class for slider widgets with a scale.

Synopsis

       #include <qwt_abstract_slider.h>

       Inherits QwtAbstractScale.

       Inherited by QwtDial, QwtKnob, and QwtSlider.

   PublicSlots
       void setValue (double value)

   Signals
       void valueChanged (double value)
           Notify a change of value.
       void sliderPressed ()
       void sliderReleased ()
       void sliderMoved (double value)

   PublicMemberFunctionsQwtAbstractSlider (QWidget *parent=NULL)
           Constructor.
       virtual ~QwtAbstractSlider ()
           Destructor.
       void setValid (bool)
       bool isValid () const
       double value () const
           Returns the current value.
       void setWrapping (bool)
       bool wrapping () const
       void setTotalSteps (uint)
           Set the number of steps.
       uint totalSteps () const
       void setSingleSteps (uint)
           Set the number of steps for a single increment.
       uint singleSteps () const
       void setPageSteps (uint)
           Set the number of steps for a page increment.
       uint pageSteps () const
       void setStepAlignment (bool)
           Enable step alignment.
       bool stepAlignment () const
       void setTracking (bool)
           Enables or disables tracking.
       bool isTracking () const
       void setReadOnly (bool)
       bool isReadOnly () const
       void setInvertedControls (bool)
       bool invertedControls () const

   ProtectedMemberFunctions
       virtual void mousePressEvent (QMouseEvent *)
       virtual void mouseReleaseEvent (QMouseEvent *)
       virtual void mouseMoveEvent (QMouseEvent *)
       virtual void keyPressEvent (QKeyEvent *)
       virtual void wheelEvent (QWheelEvent *)
       virtual bool isScrollPosition (const QPoint &pos) const =0
           Determine what to do when the user presses a mouse button.
       virtual double scrolledTo (const QPoint &pos) const =0
           Determine the value for a new position of the movable part of the slider.
       void incrementValue (int stepCount)
       virtual void scaleChange ()
       virtual void sliderChange ()
           Calling update()
       double incrementedValue (double value, int stepCount) const

See Also