The Counter Widget. More...

#include <qwt_counter.h>

Inheritance diagram for QwtCounter:

Classes
class	PrivateData

Public Types
enum	Button { Button1 , Button2 , Button3 , ButtonCnt }
	Button index. More...

Public Slots
void	setValue (double)
	Set a new value without adjusting to the step raster.

Signals
void	buttonReleased (double value)
	Signal emitted when a button has been released.

void	valueChanged (double value)
	Signal emitted when the counter's value has changed.

Public Member Functions
	QwtCounter (QWidget *parent=nullptr)
	Constructor.

	~QwtCounter () override
	Destructor.

void	setValid (bool)
	Set the counter to be in valid/invalid state.

bool	isValid () const
	Return true if the value is valid.

void	setWrapping (bool)
	Enable or disable wrapping.

bool	wrapping () const
	Return true if wrapping is enabled.

bool	isReadOnly () const
	Return true if the counter is read only.

void	setReadOnly (bool)
	Set the counter to read only mode.

void	setNumButtons (int)
	Set the number of buttons on each side.

int	numButtons () const
	Return the number of buttons.

void	setIncSteps (QwtCounter::Button, int numSteps)
	Set the number of increment steps for a button.

int	incSteps (QwtCounter::Button) const
	Return the number of increment steps for a button.

virtual QSize	sizeHint () const override
	Return a size hint.

double	singleStep () const
	Return the single step size.

void	setSingleStep (double stepSize)
	Set the single step size.

void	setRange (double min, double max)
	Set the range of the counter.

double	minimum () const
	Return the minimum value.

void	setMinimum (double)
	Set the minimum value.

double	maximum () const
	Return the maximum value.

void	setMaximum (double)
	Set the maximum value.

void	setStepButton1 (int nSteps)
	Set the number of increment steps for button 1.

int	stepButton1 () const
	Return the number of increment steps for button 1.

void	setStepButton2 (int nSteps)
	Set the number of increment steps for button 2.

int	stepButton2 () const
	Return the number of increment steps for button 2.

void	setStepButton3 (int nSteps)
	Set the number of increment steps for button 3.

int	stepButton3 () const
	Return the number of increment steps for button 3.

double	value () const
	Return the current value.

Protected Member Functions
virtual bool	event (QEvent *) override
	Handle QEvent::PolishRequest events.

virtual void	wheelEvent (QWheelEvent *) override
	Handle wheel events.

virtual void	keyPressEvent (QKeyEvent *) override
	Handle key events.

Properties
double	value

double	minimum

double	maximum

double	singleStep

int	numButtons

int	stepButton1

int	stepButton2

int	stepButton3

bool	readOnly

bool	wrapping

Detailed Description

The Counter Widget.

A Counter consists of a label displaying a number and one or more (up to three) push buttons on each side of the label which can be used to increment or decrement the counter's value. A counter has a range from a minimum value to a maximum value and a step size. When the wrapping property is set the counter is circular. The number of steps by which a button increments or decrements the value can be specified using setIncSteps(). The number of buttons can be changed with setNumButtons(). Example:

#include <qwt_counter.h>
QwtCounter *counter = new QwtCounter(parent);
counter->setRange(0.0, 100.0);                  // From 0.0 to 100
counter->setSingleStep( 1.0 );                  // Step size 1.0
counter->setNumButtons(2);                      // Two buttons each side
counter->setIncSteps(QwtCounter::Button1, 1);   // Button 1 increments 1 step
counter->setIncSteps(QwtCounter::Button2, 20);  // Button 2 increments 20 steps
connect(counter, SIGNAL(valueChanged(double)), myClass, SLOT(newValue(double)));

Member Enumeration Documentation

◆ Button

enum QwtCounter::Button

Button index.

Enumerator
Button1	Button intended for minor steps.
Button2	Button intended for medium steps.
Button3	Button intended for large steps.
ButtonCnt	Number of buttons.

Constructor & Destructor Documentation

◆ QwtCounter()

QwtCounter::QwtCounter ( QWidget * parent = nullptr )

explicit

Constructor.

The counter is initialized with a range set to [0.0, 1.0] with 0.01 as single step size. The value is invalid. The default number of buttons is set to 2. The default increments are:

Button 1: 1 step
Button 2: 10 steps
Button 3: 100 steps
Parameters

parent Parent widget

Member Function Documentation

◆ buttonReleased

void QwtCounter::buttonReleased ( double value )

signal

Signal emitted when a button has been released.

Parameters

value The new value

◆ event()

bool QwtCounter::event ( QEvent * event )

overrideprotectedvirtual

Handle QEvent::PolishRequest events.

Parameters

event Event

Returns: see QWidget::event()

◆ incSteps()

int QwtCounter::incSteps ( QwtCounter::Button button ) const

Return the number of increment steps for a button.

Return the number of steps by which a specified button increments the value, or 0 if the button is invalid.

Parameters

button Button index

Returns: Number of increment steps

See also: setIncSteps()

◆ isReadOnly()

bool QwtCounter::isReadOnly ( ) const

Return true if the counter is read only.

Return true when the line edit is read only.

See also: setReadOnly()

◆ isValid()

bool QwtCounter::isValid ( ) const

Return true if the value is valid.

See also: setValid(), setValue()

◆ keyPressEvent()

void QwtCounter::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Handle key events.

Ctrl + Qt::Key_Home
Step to minimum()
Ctrl + Qt::Key_End
Step to maximum()
Qt::Key_Up
Increment by incSteps(QwtCounter::Button1)
Qt::Key_Down
Decrement by incSteps(QwtCounter::Button1)
Qt::Key_PageUp
Increment by incSteps(QwtCounter::Button2)
Qt::Key_PageDown
Decrement by incSteps(QwtCounter::Button2)
Shift + Qt::Key_PageUp
Increment by incSteps(QwtCounter::Button3)
Shift + Qt::Key_PageDown
Decrement by incSteps(QwtCounter::Button3)

Parameters

event Key event

◆ maximum()

double QwtCounter::maximum ( ) const

Return the maximum value.

Return the maximum of the range.

See also: setRange(), setMaximum(), minimum()

◆ minimum()

double QwtCounter::minimum ( ) const

Return the minimum value.

Return the minimum of the range.

See also: setRange(), setMinimum(), maximum()

◆ numButtons()

int QwtCounter::numButtons ( ) const

Return the number of buttons.

Return the number of buttons on each side of the widget.

See also: setNumButtons()

◆ setIncSteps()

void QwtCounter::setIncSteps	(	QwtCounter::Button	button,
		int	numSteps
	)

Set the number of increment steps for a button.

Specify the number of steps by which the value is incremented or decremented when a specified button is pushed.

Parameters

[in]	button	Button index
[in]	numSteps	Number of steps

See also: incSteps()

◆ setMaximum()

void QwtCounter::setMaximum ( double value )

Set the maximum value.

Set the maximum value of the range.

Parameters

value Maximum value

See also: setRange(), setMinimum(), maximum()

◆ setMinimum()

void QwtCounter::setMinimum ( double value )

Set the minimum value.

Set the minimum value of the range.

Parameters

value Minimum value

See also: setRange(), setMaximum(), minimum()

Note: The maximum is adjusted if necessary to ensure that the range remains valid.

◆ setNumButtons()

void QwtCounter::setNumButtons ( int numButtons )

Set the number of buttons on each side.

Specify the number of buttons on each side of the label.

Parameters

numButtons Number of buttons

See also: numButtons()

◆ setRange()

void QwtCounter::setRange	(	double	min,
		double	max
	)

Set the range of the counter.

Set the minimum and maximum values.

The maximum is adjusted if necessary to ensure that the range remains valid. The value might be modified to be inside of the range.

Parameters

[in]	min	Minimum value
[in]	max	Maximum value

See also: minimum(), maximum()

◆ setReadOnly()

void QwtCounter::setReadOnly ( bool on )

Set the counter to read only mode.

Allow/disallow the user to manually edit the value.

Parameters

on	True disable editing

See also: isReadOnly()

◆ setSingleStep()

void QwtCounter::setSingleStep ( double stepSize )

Set the single step size.

Set the step size of the counter.

A value <= 0.0 disables stepping

Parameters

stepSize Single step size

See also: singleStep()

◆ setStepButton1()

void QwtCounter::setStepButton1 ( int nSteps )

Set the number of increment steps for button 1.

Parameters

nSteps Number of steps

See also: stepButton1()

◆ setStepButton2()

void QwtCounter::setStepButton2 ( int nSteps )

Set the number of increment steps for button 2.

Parameters

nSteps Number of steps

See also: stepButton2()

◆ setStepButton3()

void QwtCounter::setStepButton3 ( int nSteps )

Set the number of increment steps for button 3.

Parameters

nSteps Number of steps

See also: stepButton3()

◆ setValid()

void QwtCounter::setValid ( bool on )

Set the counter to be in valid/invalid state.

When the counter is set to invalid, no numbers are displayed and the buttons are disabled.

Parameters

on	If true the counter will be set as valid

See also: setValue(), isValid()

◆ setValue

void QwtCounter::setValue ( double value )

slot

Set a new value without adjusting to the step raster.

The state of the counter is set to be valid.

Parameters

value New value

See also: isValid(), value(), valueChanged()

Warning: The value is clipped when it lies outside the range.

◆ setWrapping()

void QwtCounter::setWrapping ( bool on )

Enable or disable wrapping.

Enable/disable wrapping.

If wrapping is true stepping up from maximum() value will take you to the minimum() value and vice versa.

Parameters

on	Enable/disable wrapping

See also: wrapping()

◆ singleStep()

double QwtCounter::singleStep ( ) const

Return the single step size.

Return single step size.

See also: setSingleStep()

◆ stepButton1()

int QwtCounter::stepButton1 ( ) const

Return the number of increment steps for button 1.

See also: setStepButton1()

◆ stepButton2()

int QwtCounter::stepButton2 ( ) const

Return the number of increment steps for button 2.

See also: setStepButton2()

◆ stepButton3()

int QwtCounter::stepButton3 ( ) const

Return the number of increment steps for button 3.

See also: setStepButton3()

◆ value()

double QwtCounter::value ( ) const

Return the current value.

Return current value of the counter.

See also: setValue(), valueChanged()

◆ valueChanged

void QwtCounter::valueChanged ( double value )

signal

Signal emitted when the counter's value has changed.

Parameters

value The new value

◆ wheelEvent()

void QwtCounter::wheelEvent ( QWheelEvent * event )

overrideprotectedvirtual

Handle wheel events.

Parameters

event Wheel event

◆ wrapping()

bool QwtCounter::wrapping ( ) const

Return true if wrapping is enabled.

Return true when wrapping is set.

See also: setWrapping()

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

/home/runner/work/QWT/QWT/src/plot/qwt_counter.h
/home/runner/work/QWT/QWT/src/plot/qwt_counter.cpp

Classes

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ Button

Constructor & Destructor Documentation

◆ QwtCounter()

Member Function Documentation

◆ buttonReleased

◆ event()

◆ incSteps()

◆ isReadOnly()

◆ isValid()

◆ keyPressEvent()

◆ maximum()

◆ minimum()

◆ numButtons()

◆ setIncSteps()

◆ setMaximum()

◆ setMinimum()

◆ setNumButtons()

◆ setRange()

◆ setReadOnly()

◆ setSingleStep()

◆ setStepButton1()

◆ setStepButton2()

◆ setStepButton3()

◆ setValid()

◆ setValue

◆ setWrapping()

◆ singleStep()

◆ stepButton1()

◆ stepButton2()

◆ stepButton3()

◆ value()

◆ valueChanged

◆ wheelEvent()

◆ wrapping()