The Counter Widget. More...

#include <qwt_counter.h>

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)
void	valueChanged (double value)
Public Member Functions
int	incSteps (QwtCounter::Button btn) const
bool	isReadOnly () const
bool	isValid () const
double	maximum () const
double	minimum () const
int	numButtons () const
	QwtCounter (QWidget *parent=NULL)
void	setIncSteps (QwtCounter::Button btn, int nSteps)
void	setMaximum (double max)
void	setMinimum (double min)
void	setNumButtons (int n)
void	setRange (double min, double max)
	Set the minimum and maximum values.
void	setReadOnly (bool)
	Allow/disallow the user to manually edit the value.
void	setSingleStep (double s)
	Set the step size of the counter.
void	setStepButton1 (int nSteps)
void	setStepButton2 (int nSteps)
void	setStepButton3 (int nSteps)
void	setValid (bool)
void	setWrapping (bool)
	En/Disable wrapping.
double	singleStep () const
virtual QSize	sizeHint () const
	A size hint.
int	stepButton1 () const
int	stepButton2 () const
int	stepButton3 () const
double	value () const
bool	wrapping () const
virtual	~QwtCounter ()
	Destructor.
Protected Member Functions
virtual bool	event (QEvent *)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	wheelEvent (QWheelEvent *)
Properties
double	maximum
double	minimum
int	numButtons
bool	readOnly
double	singleStep
int	stepButton1
	returns the number of increment steps for button 1
int	stepButton2
	returns the number of increment steps for button 2
int	stepButton3
	returns the number of increment steps for button 3
double	value
bool	wrapping
Private Slots
void	btnClicked ()
	Button clicked.
void	btnReleased ()
	Button released.
void	textChanged ()
	Set from lineedit.
Private Member Functions
void	incrementValue (int numSteps)
void	initCounter ()
void	showNumber (double)
void	updateButtons ()
	Update buttons according to the current value.
Private Attributes
PrivateData *	d_data

Detailed Description

The Counter Widget.

A Counter consists of a label displaying a number and one ore 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)));

Definition at line 48 of file qwt_counter.h.

Member Enumeration Documentation

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.

Definition at line 67 of file qwt_counter.h.

Constructor & Destructor Documentation

QwtCounter::QwtCounter ( QWidget * parent = NULL ) [explicit]

The counter is initialized with a range is 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

Definition at line 63 of file qwt_counter.cpp.

QwtCounter::~QwtCounter ( ) [virtual]

Destructor.

Definition at line 126 of file qwt_counter.cpp.

Member Function Documentation

void QwtCounter::btnClicked ( ) [private, slot]

Button clicked.

Definition at line 734 of file qwt_counter.cpp.

void QwtCounter::btnReleased ( ) [private, slot]

Button released.

Definition at line 747 of file qwt_counter.cpp.

void QwtCounter::buttonReleased ( double value ) [signal]

This signal is emitted when a button has been released

Parameters:

value The new value

bool QwtCounter::event ( QEvent * event ) [protected, virtual]

Handle QEvent::PolishRequest events

Parameters:

event Event

Returns:: see QWidget::event()

Definition at line 484 of file qwt_counter.cpp.

void QwtCounter::incrementValue ( int numSteps ) [private]

Definition at line 627 of file qwt_counter.cpp.

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

Returns:: The number of steps by which a specified button increments the value or 0 if the button is invalid.

Parameters:

button Button index

See also:: setIncSteps()

Definition at line 415 of file qwt_counter.cpp.

void QwtCounter::initCounter ( ) [private]

Definition at line 69 of file qwt_counter.cpp.

bool QwtCounter::isReadOnly ( ) const

Returns:: True, when the line line edit is read only. (default is no)

See also:: setReadOnly()

Definition at line 185 of file qwt_counter.cpp.

bool QwtCounter::isValid ( ) const

Returns:: True, if the value is valid

See also:: setValid(), setValue()

Definition at line 165 of file qwt_counter.cpp.

void QwtCounter::keyPressEvent ( QKeyEvent * event ) [protected, virtual]

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

Definition at line 521 of file qwt_counter.cpp.

double QwtCounter::maximum ( ) const

double QwtCounter::minimum ( ) const

int QwtCounter::numButtons ( ) const

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

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

Parameters:

button	Button index
numSteps	Number of steps

See also:: incSteps()

Definition at line 402 of file qwt_counter.cpp.

void QwtCounter::setMaximum ( double value )

Set the maximum value of the range

Parameters:

value Maximum value

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

Definition at line 296 of file qwt_counter.cpp.

void QwtCounter::setMinimum ( double 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.

Definition at line 276 of file qwt_counter.cpp.

void QwtCounter::setNumButtons ( int numButtons )

Specify the number of buttons on each side of the label

Parameters:

numButtons Number of buttons

See also:: numButtons()

Definition at line 361 of file qwt_counter.cpp.

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

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:

min	Minimum value
max	Maximum value

See also:: minimum(), maximum()

Definition at line 240 of file qwt_counter.cpp.

void QwtCounter::setReadOnly ( bool on )

Allow/disallow the user to manually edit the value.

Parameters:

on	True disable editing

See also:: isReadOnly()

Definition at line 176 of file qwt_counter.cpp.

void QwtCounter::setSingleStep ( double stepSize )

Set the step size of the counter.

A value <= 0.0 disables stepping

Parameters:

stepSize Single step size

See also:: singleStep()

Definition at line 318 of file qwt_counter.cpp.

void QwtCounter::setStepButton1 ( int nSteps )

Set the number of increment steps for button 1

Parameters:

nSteps Number of steps

Definition at line 428 of file qwt_counter.cpp.

void QwtCounter::setStepButton2 ( int nSteps )

Set the number of increment steps for button 2

Parameters:

nSteps Number of steps

Definition at line 443 of file qwt_counter.cpp.

void QwtCounter::setStepButton3 ( int nSteps )

Set the number of increment steps for button 3

Parameters:

nSteps Number of steps

Definition at line 458 of file qwt_counter.cpp.

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()

Definition at line 141 of file qwt_counter.cpp.

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.

Definition at line 201 of file qwt_counter.cpp.

void QwtCounter::setWrapping ( bool on )

En/Disable wrapping.

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

Parameters:

on	En/Disable wrapping

See also:: wrapping()

Definition at line 341 of file qwt_counter.cpp.

void QwtCounter::showNumber ( double number ) [private]

Display number string

Parameters:

number Number

Definition at line 723 of file qwt_counter.cpp.

double QwtCounter::singleStep ( ) const

QSize QwtCounter::sizeHint ( ) const [virtual]

A size hint.

Definition at line 753 of file qwt_counter.cpp.

int QwtCounter::stepButton1 ( ) const

int QwtCounter::stepButton2 ( ) const

int QwtCounter::stepButton3 ( ) const

void QwtCounter::textChanged ( ) [private, slot]

Set from lineedit.

Definition at line 470 of file qwt_counter.cpp.

void QwtCounter::updateButtons ( ) [private]

Update buttons according to the current value.

When the QwtCounter under- or over-flows, the focus is set to the smallest up- or down-button and counting is disabled.

Counting is re-enabled on a button release event (mouse or space bar).

Definition at line 696 of file qwt_counter.cpp.

double QwtCounter::value ( ) const

void QwtCounter::valueChanged ( double value ) [signal]

This signal is emitted when the counter's value has changed

Parameters:

value The new value

void QwtCounter::wheelEvent ( QWheelEvent * event ) [protected, virtual]

Handle wheel events

Parameters:

event Wheel event

Definition at line 588 of file qwt_counter.cpp.

bool QwtCounter::wrapping ( ) const

Member Data Documentation

PrivateData* QwtCounter::d_data [private]

Definition at line 157 of file qwt_counter.h.

Property Documentation

double QwtCounter::maximum [read, write]

Returns:: The maximum of the range

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

Definition at line 54 of file qwt_counter.h.

double QwtCounter::minimum [read, write]

Returns:: The minimum of the range

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

Definition at line 53 of file qwt_counter.h.

int QwtCounter::numButtons [read, write]

Returns:: The number of buttons on each side of the widget.

See also:: setNumButtons()

Definition at line 57 of file qwt_counter.h.

bool QwtCounter::readOnly [read, write]

Definition at line 62 of file qwt_counter.h.

double QwtCounter::singleStep [read, write]

Returns:: Single step size

See also:: setSingleStep()

Definition at line 55 of file qwt_counter.h.

int QwtCounter::stepButton1 [read, write]

returns the number of increment steps for button 1

Definition at line 58 of file qwt_counter.h.

int QwtCounter::stepButton2 [read, write]

returns the number of increment steps for button 2

Definition at line 59 of file qwt_counter.h.

int QwtCounter::stepButton3 [read, write]

returns the number of increment steps for button 3

Definition at line 60 of file qwt_counter.h.

double QwtCounter::value [read, write]

Returns:: Current value of the counter

See also:: setValue(), valueChanged()

Definition at line 52 of file qwt_counter.h.

bool QwtCounter::wrapping [read, write]

Returns:: True, when wrapping is set

See also:: setWrapping()

Definition at line 63 of file qwt_counter.h.

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

Classes

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation