#include <qwt_dial.h>

Inherited by QwtAnalogClock, and QwtCompass.

Public Types
enum	Direction { Clockwise, CounterClockwise }
enum	Mode { RotateNeedle, RotateScale }
enum	ScrollMode { ScrNone, ScrMouse, ScrTimer, ScrDirect, ScrPage }
enum	Shadow { Plain = QFrame::Plain, Raised = QFrame::Raised, Sunken = QFrame::Sunken }
Public Slots
virtual void	fitValue (double val)
virtual void	incValue (int steps)
virtual void	setReadOnly (bool)
virtual void	setValue (double val)
Signals
void	sliderMoved (double value)
void	sliderPressed ()
void	sliderReleased ()
void	valueChanged (double value)
Public Member Functions
QRectF	boundingRect () const
Direction	direction () const
Shadow	frameShadow () const
virtual void	incPages (int)
QRectF	innerRect () const
bool	isReadOnly () const
bool	isValid () const
int	lineWidth () const
virtual double	mass () const
double	maxScaleArc () const
double	maxValue () const
virtual QSize	minimumSizeHint () const
double	minScaleArc () const
double	minValue () const
Mode	mode () const
const QwtDialNeedle *	needle () const
QwtDialNeedle *	needle ()
Qt::Orientation	orientation () const
double	origin () const
int	pageSize () const
bool	periodic () const
	QwtDial (QWidget *parent=NULL)
QwtDialScaleDraw *	scaleDraw ()
const QwtDialScaleDraw *	scaleDraw () const
virtual QRectF	scaleInnerRect () const
void	setDirection (Direction)
void	setFrameShadow (Shadow)
void	setLineWidth (int)
virtual void	setMass (double val)
void	setMode (Mode)
virtual void	setNeedle (QwtDialNeedle *)
virtual void	setOrientation (Qt::Orientation o)
virtual void	setOrigin (double)
void	setPeriodic (bool tf)
void	setRange (double vmin, double vmax, double vstep=0.0, int pagesize=1)
virtual void	setScale (int maxMajIntv, int maxMinIntv, double step=0.0)
void	setScaleArc (double min, double max)
void	setScaleComponents (QwtAbstractScaleDraw::ScaleComponents)
virtual void	setScaleDraw (QwtDialScaleDraw *)
void	setScaleTicks (int minLen, int medLen, int majLen, int penWidth=1)
void	setStep (double)
void	setTracking (bool enable)
void	setUpdateTime (int t)
void	setValid (bool valid)
virtual void	setWrapping (bool)
virtual QSize	sizeHint () const
double	step () const
void	stopMoving ()
double	value () const
bool	wrapping () const
virtual	~QwtDial ()
Protected Member Functions
virtual void	drawContents (QPainter *) const
virtual void	drawFocusIndicator (QPainter *) const
virtual void	drawFrame (QPainter *p)
virtual void	drawNeedle (QPainter *, const QPointF &, double radius, double direction, QPalette::ColorGroup) const
virtual void	drawScale (QPainter *, const QPointF &center, double radius, double origin, double arcMin, double arcMax) const
virtual void	drawScaleContents (QPainter *painter, const QPointF &center, double radius) const
double	exactPrevValue () const
double	exactValue () const
virtual void	getScrollMode (const QPoint &, QwtAbstractSlider::ScrollMode &, int &direction) const
virtual double	getValue (const QPoint &)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	mouseMoveEvent (QMouseEvent *e)
double	mouseOffset () const
virtual void	mousePressEvent (QMouseEvent *e)
virtual void	mouseReleaseEvent (QMouseEvent *e)
virtual void	paintEvent (QPaintEvent *)
double	prevValue () const
virtual void	rangeChange ()
virtual QwtText	scaleLabel (double) const
int	scrollMode () const
void	setMouseOffset (double)
virtual void	setPosition (const QPoint &)
virtual void	stepChange ()
virtual void	timerEvent (QTimerEvent *e)
void	updateScale ()
virtual void	valueChange ()
virtual void	wheelEvent (QWheelEvent *e)
Friends
class	QwtDialScaleDraw

Detailed Description

QwtDial class provides a rounded range control.

QwtDial is intended as base class for dial widgets like speedometers, compass widgets, clocks ...

A dial contains a scale and a needle indicating the current value of the dial. Depending on Mode one of them is fixed and the other is rotating. If not isReadOnly() the dial can be rotated by dragging the mouse or using keyboard inputs (see keyPressEvent()). A dial might be wrapping, what means a rotation below/above one limit continues on the other limit (f.e compass). The scale might cover any arc of the dial, its values are related to the origin() of the dial.

Qwt is missing a set of good looking needles (QwtDialNeedle). Contributions are very welcome.

See also:: QwtCompass, QwtAnalogClock, QwtDialNeedle

Note:: The examples/dials example shows different types of dials.

Member Enumeration Documentation

enum QwtDial::Direction

Direction of the dial.

Enumerator:

Clockwise	Clockwise.
CounterClockwise	Counter clockwise.

enum QwtDial::Mode

Mode controlling wether the needle or the scale is rotating.

Enumerator:

RotateNeedle	The needle is rotating.
RotateScale	The needle is fixed, the scales are rotating.

enum QwtAbstractSlider::ScrollMode [inherited]

Scroll mode

See also:: getScrollMode()

Enumerator:

ScrNone	Scrolling switched off. Don't change the value.
ScrMouse	Change the value while the user keeps the button pressed and moves the mouse.
ScrTimer	Automatic scrolling. Increment the value in the specified direction as long as the user keeps the button pressed.
ScrPage	Automatic scrolling. Same as ScrTimer, but increment by page size.

enum QwtDial::Shadow

Frame shadow.

Unfortunately it is not possible to use QFrame::Shadow as a property of a widget that is not derived from QFrame. The following enum is made for the designer only. It is safe to use QFrame::Shadow instead.

Enumerator:

Plain	QFrame::Plain.
Raised	QFrame::Raised.
Sunken	QFrame::Sunken.

Constructor & Destructor Documentation

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

Constructor.

Parameters:

parent Parent widget

Create a dial widget with no scale and no needle. The default origin is 90.0 with no valid value. It accepts mouse and keyboard inputs and has no step size. The default mode is QwtDial::RotateNeedle.

QwtDial::~QwtDial ( ) [virtual]

Destructor.

Member Function Documentation

QRectF QwtDial::boundingRect ( ) const

Returns:: bounding rect of the dial including the frame

See also:: setLineWidth(), scaleInnerRect(), innerRect()

QwtDial::Direction QwtDial::direction ( ) const

Returns:: Direction of the dial

The default direction of a dial is QwtDial::Clockwise

See also:: setDirection()

void QwtDial::drawContents ( QPainter * painter ) const [protected, virtual]

Draw the contents inside the frame.

QPalette::Window is the background color outside of the frame. QPalette::Base is the background color inside the frame. QPalette::WindowText is the background color inside the scale.

Parameters:

painter Painter

See also:: boundingRect(), innerRect(), scaleInnerRect(), QWidget::setPalette()

void QwtDial::drawFocusIndicator ( QPainter * painter ) const [protected, virtual]

Draw a dotted round circle, if !isReadOnly()

Parameters:

painter Painter

void QwtDial::drawFrame ( QPainter * painter ) [protected, virtual]

Draw the frame around the dial

Parameters:

painter Painter

See also:: lineWidth(), frameShadow()

void QwtDial::drawNeedle	(	QPainter *	painter,
		const QPointF &	center,
		double	radius,
		double	direction,
		QPalette::ColorGroup	cg
	)		const `[protected, virtual]`

Draw the needle

Parameters:

painter	Painter
center	Center of the dial
radius	Length for the needle
direction	Direction of the needle in degrees, counter clockwise
cg	ColorGroup

Reimplemented in QwtAnalogClock.

void QwtDial::drawScale	(	QPainter *	painter,
		const QPointF &	center,
		double	radius,
		double	origin,
		double	minArc,
		double	maxArc
	)		const `[protected, virtual]`

Draw the scale

Parameters:

painter	Painter
center	Center of the dial
radius	Radius of the scale
origin	Origin of the scale
minArc	Minimum of the arc
maxArc	Minimum of the arc

See also:: QwtRoundScaleDraw::setAngleRange()

void QwtDial::drawScaleContents	(	QPainter *	painter,
		const QPointF &	center,
		double	radius
	)		const `[protected, virtual]`

Draw the contents inside the scale

Paints nothing.

Parameters:

painter	Painter
center	Center of the contents circle
radius	Radius of the contents circle

Reimplemented in QwtCompass.

double QwtDoubleRange::exactPrevValue ( ) const [protected, inherited]

Returns the exact previous value.

double QwtDoubleRange::exactValue ( ) const [protected, inherited]

Returns the exact value.

The exact value is the value which QwtDoubleRange::value would return if the value were not adjusted to the step raster. It differs from the current value only if fitValue() or incValue() have been used before. This function is intended for internal use in derived classes.

void QwtAbstractSlider::fitValue ( double value ) [virtual, slot, inherited]

Set the slider's value to the nearest integer multiple of the step size.

Parameters:

value Value

See also:: setValue(), incValue()

Reimplemented from QwtDoubleRange.

QwtDial::Shadow QwtDial::frameShadow ( ) const

Returns:: Frame shadow /sa setFrameShadow(), lineWidth(), QFrame::frameShadow

void QwtDial::getScrollMode	(	const QPoint &	pos,
		QwtAbstractSlider::ScrollMode &	scrollMode,
		int &	direction
	)		const `[protected, virtual]`

See QwtAbstractSlider::getScrollMode()

Parameters:

pos	point where the mouse was pressed

Return values:

scrollMode	The scrolling mode
direction	direction: 1, 0, or -1.

See also:: QwtAbstractSlider::getScrollMode()

Implements QwtAbstractSlider.

double QwtDial::getValue ( const QPoint & pos ) [protected, virtual]

Find the value for a given position

Parameters:

pos Position

Returns:: Value

Implements QwtAbstractSlider.

void QwtDoubleRange::incPages ( int nPages ) [virtual, inherited]

Increment the value by a specified number of pages.

Parameters:

nPages Number of pages to increment. A negative number decrements the value.

Warning:: The Page size is specified in the constructor.

void QwtAbstractSlider::incValue ( int steps ) [virtual, slot, inherited]

Increment the value by a specified number of steps.

Parameters:

steps number of steps

See also:: setValue()

Reimplemented from QwtDoubleRange.

QRectF QwtDial::innerRect ( ) const

Returns:: bounding rect of the circle inside the frame

See also:: setLineWidth(), scaleInnerRect(), boundingRect()

bool QwtAbstractSlider::isReadOnly ( ) const [inherited]

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

Returns:: true if read only

See also:: setReadOnly()

bool QwtAbstractSlider::isValid ( ) const [inline, inherited]

See also:: QwtDblRange::isValid()

Reimplemented from QwtDoubleRange.

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

Handles key events

Key_Down, KeyLeft
Decrement by 1
Key_Prior
Decrement by pageSize()
Key_Home
Set the value to minValue()

Key_Up, KeyRight
Increment by 1
Key_Next
Increment by pageSize()
Key_End
Set the value to maxValue()

Parameters:

event Key event

See also:: isReadOnly()

Reimplemented from QwtAbstractSlider.

Reimplemented in QwtCompass.

int QwtDial::lineWidth ( ) const

Returns:: Line width of the frame

See also:: setLineWidth(), frameShadow(), lineWidth()

double QwtAbstractSlider::mass ( ) const [virtual, inherited]

Returns:: mass

See also:: setMass()

Reimplemented in QwtWheel.

double QwtDial::maxScaleArc ( ) const

Returns:: Upper limit of the scale arc

double QwtDoubleRange::maxValue ( ) const [inherited]

Returns the value of the second border of the range.

maxValue returns the value which has been specified as the second parameter in QwtDoubleRange::setRange.

See also:: setRange()

Reimplemented in QwtCounter.

QSize QwtDial::minimumSizeHint ( ) const [virtual]

Return a minimum size hint.

Warning:: The return value of QwtDial::minimumSizeHint() depends on the font and the scale.

double QwtDial::minScaleArc ( ) const

Returns:: Lower limit of the scale arc

double QwtDoubleRange::minValue ( ) const [inherited]

Returns the value at the first border of the range.

minValue returns the value which has been specified as the first parameter in setRange().

See also:: setRange()

Reimplemented in QwtCounter.

QwtDial::Mode QwtDial::mode ( ) const

Returns:: mode of the dial.

The value of the dial is indicated by the difference between the origin and the direction of the needle. In case of QwtDial::RotateNeedle the scale arc is fixed to the origin() and the needle is rotating, in case of QwtDial::RotateScale, the needle points to origin() and the scale is rotating.

The default mode is QwtDial::RotateNeedle.

See also:: setMode(), origin(), setScaleArc(), value()

void QwtAbstractSlider::mouseMoveEvent ( QMouseEvent * e ) [protected, virtual, inherited]

Mouse Move Event handler

Parameters:

e	Mouse event

double QwtAbstractSlider::mouseOffset ( ) const [protected, inherited]

See also:: setMouseOffset()

void QwtAbstractSlider::mousePressEvent ( QMouseEvent * e ) [protected, virtual, inherited]

Mouse press event handler

Parameters:

e	Mouse event

void QwtAbstractSlider::mouseReleaseEvent ( QMouseEvent * e ) [protected, virtual, inherited]

Mouse Release Event handler

Parameters:

e	Mouse event

const QwtDialNeedle * QwtDial::needle ( ) const

Returns:: needle

See also:: setNeedle()

QwtDialNeedle * QwtDial::needle ( )

Returns:: needle

See also:: setNeedle()

Qt::Orientation QwtAbstractSlider::orientation ( ) const [inherited]

Returns:: Orientation

See also:: setOrientation()

double QwtDial::origin ( ) const

The origin is the angle where scale and needle is relative to.

Returns:: Origin of the dial

See also:: setOrigin()

int QwtDoubleRange::pageSize ( ) const [inherited]

Returns the page size in steps.

void QwtDial::paintEvent ( QPaintEvent * event ) [protected, virtual]

Paint the dial

Parameters:

event Paint event

bool QwtDoubleRange::periodic ( ) const [inherited]

Returns true if the range is periodic.

See also:: setPeriodic()

double QwtDoubleRange::prevValue ( ) const [protected, inherited]

Returns the previous value.

void QwtDial::rangeChange ( ) [protected, virtual]

QwtDoubleRange update hook.

Reimplemented from QwtDoubleRange.

QwtDialScaleDraw * QwtDial::scaleDraw ( )

Return the scale draw.

const QwtDialScaleDraw * QwtDial::scaleDraw ( ) const

Return the scale draw.

QRectF QwtDial::scaleInnerRect ( ) const [virtual]

Returns:: rect inside the scale

See also:: setLineWidth(), boundingRect(), innerRect()

QwtText QwtDial::scaleLabel ( double value ) const [protected, virtual]

Find the label for a value

Parameters:

value Value

Returns:: label

Reimplemented in QwtAnalogClock, and QwtCompass.

int QwtAbstractSlider::scrollMode ( ) const [protected, inherited]

sa ScrollMode

void QwtDial::setDirection ( Direction direction )

Set the direction of the dial (clockwise/counterclockwise)

Parameters:

direction Direction

See also:: direction()

void QwtDial::setFrameShadow ( Shadow shadow )

Sets the frame shadow value from the frame style.

Parameters:

shadow Frame shadow

See also:: setLineWidth(), QFrame::setFrameShadow()

void QwtDial::setLineWidth ( int lineWidth )

Sets the line width

Parameters:

lineWidth Line width

See also:: setFrameShadow()

void QwtAbstractSlider::setMass ( double val ) [virtual, inherited]

Set the slider's mass for flywheel effect.

If the slider's mass is greater then 0, it will continue to move after the mouse button has been released. Its speed decreases with time at a rate depending on the slider's mass. A large mass means that it will continue to move for a long time.

Derived widgets may overload this function to make it public.

Parameters:

val	New mass in kg

See also:: mass()

Reimplemented in QwtWheel.

void QwtDial::setMode ( Mode mode )

Change the mode of the meter.

Parameters:

mode New mode

The value of the meter is indicated by the difference between north of the scale and the direction of the needle. In case of QwtDial::RotateNeedle north is pointing to the origin() and the needle is rotating, in case of QwtDial::RotateScale, the needle points to origin() and the scale is rotating.

The default mode is QwtDial::RotateNeedle.

See also:: mode(), setValue(), setOrigin()

void QwtAbstractSlider::setMouseOffset ( double offset ) [protected, inherited]

See also:: mouseOffset()

void QwtDial::setNeedle ( QwtDialNeedle * needle ) [virtual]

Set a needle for the dial

Qwt is missing a set of good looking needles. Contributions are very welcome.

Parameters:

needle Needle

Warning:: The needle will be deleted, when a different needle is set or in ~QwtDial()

void QwtAbstractSlider::setOrientation ( Qt::Orientation o ) [virtual, inherited]

Set the orientation.

Parameters:

o	Orientation. Allowed values are Qt::Horizontal and Qt::Vertical.

Reimplemented in QwtSlider, and QwtWheel.

void QwtDial::setOrigin ( double origin ) [virtual]

Change the origin.

The origin is the angle where scale and needle is relative to.

Parameters:

origin New origin

See also:: origin()

void QwtDoubleRange::setPeriodic ( bool tf ) [inherited]

Make the range periodic.

When the range is periodic, the value will be set to a point inside the interval such that

point = value + n * width

if the user tries to set a new value which is outside the range. If the range is nonperiodic (the default), values outside the range will be clipped.

Parameters:

tf	true for a periodic range

void QwtAbstractSlider::setPosition ( const QPoint & p ) [protected, virtual, inherited]

Move the slider to a specified point, adjust the value and emit signals if necessary.

void QwtDoubleRange::setRange	(	double	vmin,
		double	vmax,
		double	vstep = `0.0`,
		int	pageSize = `1`
	)		`[inherited]`

Specify range and step size.

Parameters:

vmin	lower boundary of the interval
vmax	higher boundary of the interval
vstep	step width
pageSize	page size in steps

Warning:

A change of the range changes the value if it lies outside the new range. The current value will *not* be adjusted to the new step raster.
vmax < vmin is allowed.
If the step size is left out or set to zero, it will be set to 1/100 of the interval length.
If the step size has an absurd value, it will be corrected to a better one.

void QwtAbstractSlider::setReadOnly ( bool readOnly ) [virtual, slot, inherited]

En/Disable read only mode

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

Parameters:

readOnly Enables in case of true

See also:: isReadOnly()

void QwtDial::setScale	(	int	maxMajIntv,
		int	maxMinIntv,
		double	step = `0.0`
	)		`[virtual]`

Change the intervals of the scale

Parameters:

maxMajIntv	Maximum for the number of major steps
maxMinIntv	Maximum number of minor steps
step	Step size

See also:: QwtScaleEngine::divideScale()

void QwtDial::setScaleArc	(	double	minArc,
		double	maxArc
	)

Change the arc of the scale

Parameters:

minArc	Lower limit
maxArc	Upper limit

void QwtDial::setScaleComponents ( QwtAbstractScaleDraw::ScaleComponents components )

A wrapper method for accessing the scale draw.

Parameters:

components Scale components

See also:: QwtAbstractScaleDraw::enableComponent()

void QwtDial::setScaleDraw ( QwtDialScaleDraw * scaleDraw ) [virtual]

Set an individual scale draw

Parameters:

scaleDraw Scale draw

Warning:: The previous scale draw is deleted

void QwtDial::setScaleTicks	(	int	minLen,
		int	medLen,
		int	majLen,
		int	penWidth = `1`
	)

Assign length and width of the ticks

Parameters:

minLen	Length of the minor ticks
medLen	Length of the medium ticks
majLen	Length of the major ticks
penWidth	Width of the pen for all ticks

See also:: QwtAbstractScaleDraw::setTickLength(), QwtDialScaleDraw::setPenWidth()

void QwtDoubleRange::setStep ( double vstep ) [inherited]

Change the step raster.

Parameters:

vstep new step width

Warning:: The value will not be adjusted to the new step raster.

Reimplemented in QwtCounter.

void QwtAbstractSlider::setTracking ( bool enable ) [inherited]

Enables or disables tracking.

If tracking is enabled, the slider emits a valueChanged() signal whenever its value changes (the default behaviour). If tracking is disabled, the value changed() signal will only be emitted if:

the user releases the mouse button and the value has changed or
at the end of automatic scrolling.

Tracking is enabled by default.

Parameters:

enable true (enable) or false (disable) tracking.

void QwtAbstractSlider::setUpdateTime ( int t ) [inherited]

Specify the update interval for automatic scrolling.

Parameters:

t	update interval in milliseconds

See also:: getScrollMode()

void QwtAbstractSlider::setValid ( bool valid ) [inline, inherited]

Parameters:

valid true/false

See also:: QwtDblRange::isValid()

Reimplemented from QwtDoubleRange.

void QwtAbstractSlider::setValue ( double val ) [virtual, slot, inherited]

Move the slider to a specified value.

This function can be used to move the slider to a value which is not an integer multiple of the step size.

Parameters:

val new value

See also:: fitValue()

Reimplemented from QwtDoubleRange.

void QwtDial::setWrapping ( bool wrapping ) [virtual]

Sets whether it is possible to step the value from the highest value to the lowest value and vice versa to on.

Parameters:

wrapping en/disables wrapping

See also:: wrapping(), QwtDoubleRange::periodic()

Note:: The meaning of wrapping is like the wrapping property of QSpinBox, but not like it is used in QDial.

QSize QwtDial::sizeHint ( ) const [virtual]

Returns:: Size hint

void QwtAbstractSlider::sliderMoved ( double value ) [signal, inherited]

This signal is emitted when the user moves the slider with the mouse.

Parameters:

value new value

void QwtAbstractSlider::sliderPressed ( ) [signal, inherited]

This signal is emitted when the user presses the movable part of the slider (start ScrMouse Mode).

void QwtAbstractSlider::sliderReleased ( ) [signal, inherited]

This signal is emitted when the user releases the movable part of the slider.

double QwtDoubleRange::step ( ) const [inherited]

Returns:: the step size

See also:: setStep(), setRange()

Reimplemented in QwtCounter.

void QwtDoubleRange::stepChange ( ) [protected, virtual, inherited]

Notify a change of the step size.

This virtual function is called whenever the step size changes. The default implementation does nothing.

void QwtAbstractSlider::stopMoving ( ) [inherited]

Stop updating if automatic scrolling is active.

void QwtAbstractSlider::timerEvent ( QTimerEvent * e ) [protected, virtual, inherited]

Qt timer event

Parameters:

e	Timer event

void QwtDial::updateScale ( ) [protected]

Update the scale with the current attributes

See also:: setScale()

double QwtDoubleRange::value ( ) const [inherited]

Returns the current value.

Reimplemented in QwtCounter.

void QwtDial::valueChange ( ) [protected, virtual]

QwtDoubleRange update hook.

Reimplemented from QwtAbstractSlider.

void QwtAbstractSlider::valueChanged ( double value ) [signal, inherited]

Notify a change of value.

In the default setting (tracking enabled), this signal will be emitted every time the value changes ( see setTracking() ).

Parameters:

value new value

void QwtAbstractSlider::wheelEvent ( QWheelEvent * e ) [protected, virtual, inherited]

Wheel Event handler

Parameters:

e	Whell event

bool QwtDial::wrapping ( ) const

wrapping() holds whether it is possible to step the value from the highest value to the lowest value and vice versa.

See also:: setWrapping(), QwtDoubleRange::setPeriodic()

Note:: The meaning of wrapping is like the wrapping property of QSpinBox, but not like it is used in QDial.

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation