QwtDial class provides a rounded range control. More...

#include <qwt_dial.h>

Inheritance diagram for QwtDial:

Classes
class	PrivateData
Public Types
enum	Mode { RotateNeedle, RotateScale }
	Mode controlling whether the needle or the scale is rotating. More...
enum	Shadow { Plain = QFrame::Plain, Raised = QFrame::Raised, Sunken = QFrame::Sunken }
	Frame shadow. More...
Public Member Functions
QRect	boundingRect () const
Shadow	frameShadow () const
QRect	innerRect () const
int	lineWidth () const
double	maxScaleArc () const
virtual QSize	minimumSizeHint () const
double	minScaleArc () const
Mode	mode () const
const QwtDialNeedle *	needle () const
QwtDialNeedle *	needle ()
double	origin () const
	QwtDial (QWidget *parent=NULL)
	Constructor.
QwtRoundScaleDraw *	scaleDraw ()
const QwtRoundScaleDraw *	scaleDraw () const
virtual QRect	scaleInnerRect () const
void	setFrameShadow (Shadow)
void	setLineWidth (int)
void	setMaxScaleArc (double min)
void	setMinScaleArc (double min)
void	setMode (Mode)
	Change the mode of the dial.
void	setNeedle (QwtDialNeedle *)
virtual void	setOrigin (double)
	Change the origin.
void	setScaleArc (double min, double max)
void	setScaleDraw (QwtRoundScaleDraw *)
virtual QSize	sizeHint () const
virtual	~QwtDial ()
	Destructor.
Protected Member Functions
virtual void	changeEvent (QEvent *)
virtual void	drawContents (QPainter *) const
	Draw the contents inside the frame.
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) const
virtual void	drawScaleContents (QPainter *painter, const QPointF &center, double radius) const
void	invalidateCache ()
virtual bool	isScrollPosition (const QPoint &) const
	Determine what to do when the user presses a mouse button.
virtual void	paintEvent (QPaintEvent *)
virtual void	scaleChange ()
virtual double	scrolledTo (const QPoint &) const
	Determine the value for a new position of the slider handle.
virtual void	sliderChange ()
	Calling update()
virtual void	wheelEvent (QWheelEvent *)
Properties
Shadow	frameShadow
int	lineWidth
double	maxScaleArc
double	minScaleArc
Mode	mode
double	origin
Private Member Functions
void	drawNeedle (QPainter *) const
void	setAngleRange (double angle, double span)
Private Attributes
PrivateData *	d_data

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 QwtAbstractSlider::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.

Often dials have to be updated very often according to values from external devices. For these high refresh rates QwtDial caches as much as possible. For derived classes it might be necessary to clear these caches manually according to attribute changes using invalidateCache().

See also:: QwtCompass, QwtAnalogClock, QwtDialNeedle

Note:: The controls and dials examples shows different types of dials.; QDial is more similar to QwtKnob than to QwtDial

Definition at line 49 of file qwt_dial.h.

Member Enumeration Documentation

enum QwtDial::Mode

Mode controlling whether the needle or the scale is rotating.

Enumerator:

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

Definition at line 85 of file qwt_dial.h.

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.

Definition at line 72 of file qwt_dial.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters:

parent Parent widget

Create a dial widget with no needle. The scale is initialized to [ 0.0, 360.0 ] and 360 steps ( QwtAbstractSlider::setTotalSteps() ). The origin of the scale is at 90°,

The value is set to 0.0.

The default mode is QwtDial::RotateNeedle.

Definition at line 126 of file qwt_dial.cpp.

QwtDial::~QwtDial ( ) [virtual]

Destructor.

Definition at line 161 of file qwt_dial.cpp.

Member Function Documentation

QRect QwtDial::boundingRect ( ) const

Returns:: bounding rectangle of the dial including the frame

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

Definition at line 236 of file qwt_dial.cpp.

void QwtDial::changeEvent ( QEvent * event ) [protected, virtual]

Change Event handler

Parameters:

event Change event

Invalidates internal paint caches if necessary

Reimplemented from QwtAbstractScale.

Definition at line 806 of file qwt_dial.cpp.

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

Definition at line 393 of file qwt_dial.cpp.

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

Draw the focus indicator

Parameters:

painter Painter

Definition at line 364 of file qwt_dial.cpp.

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

Draw the frame around the dial

Parameters:

painter Painter

See also:: lineWidth(), frameShadow()

Definition at line 375 of file qwt_dial.cpp.

void QwtDial::drawNeedle	(	QPainter *	painter,
		const QPointF &	center,
		double	radius,
		double	direction,
		QPalette::ColorGroup	colorGroup
	)		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
colorGroup	ColorGroup

Reimplemented in QwtAnalogClock.

Definition at line 440 of file qwt_dial.cpp.

void QwtDial::drawNeedle ( QPainter * painter ) const [private]

Definition at line 450 of file qwt_dial.cpp.

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

Draw the scale

Parameters:

painter	Painter
center	Center of the dial
radius	Radius of the scale

Definition at line 477 of file qwt_dial.cpp.

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.

Definition at line 508 of file qwt_dial.cpp.

Shadow QwtDial::frameShadow ( ) const

QRect QwtDial::innerRect ( ) const

Returns:: bounding rectangle of the circle inside the frame

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

Definition at line 226 of file qwt_dial.cpp.

void QwtDial::invalidateCache ( ) [protected]

Invalidate the internal caches used to speed up repainting

Definition at line 303 of file qwt_dial.cpp.

bool QwtDial::isScrollPosition ( const QPoint & pos ) const [protected, virtual]

Determine what to do when the user presses a mouse button.

Parameters:

pos	Mouse position

Return values:

True,when the inner circle contains pos

See also:: scrolledTo()

Implements QwtAbstractSlider.

Definition at line 723 of file qwt_dial.cpp.

int QwtDial::lineWidth ( ) const

double QwtDial::maxScaleArc ( ) const

QSize QwtDial::minimumSizeHint ( ) const [virtual]

Returns:: Minimum size hint

See also:: sizeHint()

Definition at line 704 of file qwt_dial.cpp.

double QwtDial::minScaleArc ( ) const

Mode QwtDial::mode ( ) const

const QwtDialNeedle * QwtDial::needle ( ) const

Returns:: needle

See also:: setNeedle()

Definition at line 540 of file qwt_dial.cpp.

QwtDialNeedle * QwtDial::needle ( )

Returns:: needle

See also:: setNeedle()

Definition at line 549 of file qwt_dial.cpp.

double QwtDial::origin ( ) const

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

Paint the dial

Parameters:

event Paint event

Definition at line 312 of file qwt_dial.cpp.

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

Invalidate the internal caches and call QwtAbstractSlider::scaleChange()

Reimplemented from QwtAbstractSlider.

Definition at line 852 of file qwt_dial.cpp.

QwtRoundScaleDraw * QwtDial::scaleDraw ( )

Returns:: the scale draw

Definition at line 555 of file qwt_dial.cpp.

const QwtRoundScaleDraw * QwtDial::scaleDraw ( ) const

Returns:: the scale draw

Definition at line 561 of file qwt_dial.cpp.

QRect QwtDial::scaleInnerRect ( ) const [virtual]

Returns:: rectangle inside the scale

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

Definition at line 252 of file qwt_dial.cpp.

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

Determine the value for a new position of the slider handle.

Parameters:

pos	Mouse position

Returns:: Value for the mouse position

See also:: isScrollPosition()

Implements QwtAbstractSlider.

Definition at line 753 of file qwt_dial.cpp.

void QwtDial::setAngleRange	(	double	angle,
		double	span
	)		`[private]`

Definition at line 838 of file qwt_dial.cpp.

void QwtDial::setFrameShadow ( Shadow shadow )

Sets the frame shadow value from the frame style.

Parameters:

shadow Frame shadow

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

Definition at line 172 of file qwt_dial.cpp.

void QwtDial::setLineWidth ( int lineWidth )

Sets the line width of the frame

Parameters:

lineWidth Line width

See also:: setFrameShadow()

Definition at line 199 of file qwt_dial.cpp.

void QwtDial::setMaxScaleArc ( double max )

Set the upper limit for the scale arc

Parameters:

max	Upper limit of the scale arc

See also:: setScaleArc(), setMinScaleArc()

Definition at line 640 of file qwt_dial.cpp.

void QwtDial::setMinScaleArc ( double min )

Set the lower limit for the scale arc

Parameters:

min	Lower limit of the scale arc

See also:: setScaleArc(), setMaxScaleArc()

Definition at line 620 of file qwt_dial.cpp.

void QwtDial::setMode ( Mode mode )

Change the mode of the dial.

Parameters:

mode New mode

In case of QwtDial::RotateNeedle 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()

Definition at line 280 of file qwt_dial.cpp.

void QwtDial::setNeedle ( QwtDialNeedle * needle )

Set a needle for the dial

Parameters:

needle Needle

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

Reimplemented in QwtAnalogClock.

Definition at line 524 of file qwt_dial.cpp.

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

Definition at line 662 of file qwt_dial.cpp.

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

Change the arc of the scale

Parameters:

minArc	Lower limit
maxArc	Upper limit

See also:: minScaleArc(), maxScaleArc()

Definition at line 590 of file qwt_dial.cpp.

void QwtDial::setScaleDraw ( QwtRoundScaleDraw * scaleDraw )

Set an individual scale draw

The motivation for setting a scale draw is often to overload QwtRoundScaleDraw::label() to return individual tick labels.

Parameters:

scaleDraw Scale draw

Warning:: The previous scale draw is deleted

Definition at line 576 of file qwt_dial.cpp.

QSize QwtDial::sizeHint ( ) const [virtual]

Returns:: Size hint

See also:: minimumSizeHint()

Definition at line 685 of file qwt_dial.cpp.

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

Calling update()

Reimplemented from QwtAbstractSlider.

Definition at line 858 of file qwt_dial.cpp.

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

Wheel Event handler

Parameters:

event Wheel event

Reimplemented from QwtAbstractSlider.

Definition at line 831 of file qwt_dial.cpp.

Member Data Documentation

PrivateData* QwtDial::d_data [private]

Reimplemented from QwtAbstractSlider.

Reimplemented in QwtCompass.

Definition at line 164 of file qwt_dial.h.

Property Documentation

QwtDial::Shadow QwtDial::frameShadow [read, write]

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

Definition at line 56 of file qwt_dial.h.

int QwtDial::lineWidth [read, write]

Returns:: Line width of the frame

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

Definition at line 55 of file qwt_dial.h.

double QwtDial::maxScaleArc [read, write]

Returns:: Upper limit of the scale arc

See also:: setScaleArc()

Definition at line 60 of file qwt_dial.h.

double QwtDial::minScaleArc [read, write]

Returns:: Lower limit of the scale arc

See also:: setScaleArc()

Definition at line 59 of file qwt_dial.h.

QwtDial::Mode QwtDial::mode [read, write]

Returns:: Mode of the dial.

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

Definition at line 57 of file qwt_dial.h.

double QwtDial::origin [read, write]

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

Returns:: Origin of the dial

See also:: setOrigin()

Definition at line 58 of file qwt_dial.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation