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

#include <qwt_dial.h>

Inheritance diagram for QwtDial:

[legend]

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 QWT_OVERRIDE

double	minScaleArc () const

Mode	mode () const

QwtDialNeedle *	needle ()

const QwtDialNeedle *	needle () const

double	origin () const

	QwtDial (QWidget *parent=NULL)
	Constructor. More...

QwtRoundScaleDraw *	scaleDraw ()

const QwtRoundScaleDraw *	scaleDraw () const

virtual QRect	scaleInnerRect () const

void	setFrameShadow (Shadow)

void	setLineWidth (int)

void	setMaxScaleArc (double)

void	setMinScaleArc (double)

void	setMode (Mode)
	Change the mode of the dial. More...

void	setNeedle (QwtDialNeedle *)

virtual void	setOrigin (double)
	Change the origin. More...

void	setScaleArc (double minArc, double maxArc)

void	setScaleDraw (QwtRoundScaleDraw *)

virtual QSize	sizeHint () const QWT_OVERRIDE

virtual	~QwtDial ()
	Destructor. More...

Public Member Functions inherited from QwtAbstractSlider
bool	invertedControls () const

bool	isReadOnly () const

bool	isTracking () const

bool	isValid () const

uint	pageSteps () const

	QwtAbstractSlider (QWidget *parent=NULL)
	Constructor. More...

void	setInvertedControls (bool)

void	setPageSteps (uint)
	Set the number of steps for a page increment. More...

void	setReadOnly (bool)

void	setSingleSteps (uint)
	Set the number of steps for a single increment. More...

void	setStepAlignment (bool)
	Enable step alignment. More...

void	setTotalSteps (uint)
	Set the number of steps. More...

void	setTracking (bool)
	Enables or disables tracking. More...

void	setValid (bool)

void	setWrapping (bool)

uint	singleSteps () const

bool	stepAlignment () const

uint	totalSteps () const

double	value () const

bool	wrapping () const

virtual	~QwtAbstractSlider ()
	Destructor. More...

Public Member Functions inherited from QwtAbstractScale
double	invTransform (int) const

bool	isInverted () const

double	lowerBound () const

double	maximum () const

double	minimum () const

	QwtAbstractScale (QWidget *parent=NULL)

const QwtScaleDiv &	scaleDiv () const

QwtScaleEngine *	scaleEngine ()

const QwtScaleEngine *	scaleEngine () const

const QwtScaleMap &	scaleMap () const

int	scaleMaxMajor () const

int	scaleMaxMinor () const

double	scaleStepSize () const

void	setLowerBound (double value)

void	setScale (const QwtInterval &)
	Specify a scale. More...

void	setScale (const QwtScaleDiv &)
	Specify a scale. More...

void	setScale (double lowerBound, double upperBound)
	Specify a scale. More...

void	setScaleEngine (QwtScaleEngine *)
	Set a scale engine. More...

void	setScaleMaxMajor (int ticks)
	Set the maximum number of major tick intervals. More...

void	setScaleMaxMinor (int ticks)
	Set the maximum number of minor tick intervals. More...

void	setScaleStepSize (double stepSize)
	Set the step size used for calculating a scale division. More...

void	setUpperBound (double value)

int	transform (double) const

double	upperBound () const

virtual	~QwtAbstractScale ()
	Destructor. More...

Protected Member Functions
virtual void	changeEvent (QEvent *) QWT_OVERRIDE

virtual void	drawContents (QPainter *) const
	Draw the contents inside the frame. More...

virtual void	drawFocusIndicator (QPainter *) const

virtual void	drawFrame (QPainter *)

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 QWT_OVERRIDE
	Determine what to do when the user presses a mouse button. More...

virtual void	paintEvent (QPaintEvent *) QWT_OVERRIDE

virtual void	scaleChange () QWT_OVERRIDE

virtual double	scrolledTo (const QPoint &) const QWT_OVERRIDE
	Determine the value for a new position of the slider handle. More...

virtual void	sliderChange () QWT_OVERRIDE
	Calling update() More...

virtual void	wheelEvent (QWheelEvent *) QWT_OVERRIDE

Protected Member Functions inherited from QwtAbstractSlider
double	incrementedValue (double value, int stepCount) const

void	incrementValue (int stepCount)

virtual void	keyPressEvent (QKeyEvent *) QWT_OVERRIDE

virtual void	mouseMoveEvent (QMouseEvent *) QWT_OVERRIDE

virtual void	mousePressEvent (QMouseEvent *) QWT_OVERRIDE

virtual void	mouseReleaseEvent (QMouseEvent *) QWT_OVERRIDE

Protected Member Functions inherited from QwtAbstractScale
QwtAbstractScaleDraw *	abstractScaleDraw ()

const QwtAbstractScaleDraw *	abstractScaleDraw () const

void	rescale (double lowerBound, double upperBound, double stepSize)

void	setAbstractScaleDraw (QwtAbstractScaleDraw *)
	Set a scale draw. More...

void	updateScaleDraw ()

Properties
Shadow	frameShadow

int	lineWidth

double	maxScaleArc

double	minScaleArc

Mode	mode

double	origin

Properties inherited from QwtAbstractSlider
bool	invertedControls

uint	pageSteps

bool	readOnly

uint	singleSteps

bool	stepAlignment

uint	totalSteps

bool	tracking

double	value
	Returns the current value. More...

bool	wrapping

Properties inherited from QwtAbstractScale
double	lowerBound

int	scaleMaxMajor

int	scaleMaxMinor

double	scaleStepSize

double	upperBound

Private Member Functions
void	drawNeedle (QPainter *) const

void	setAngleRange (double angle, double span)

Private Attributes
PrivateData *	m_data

Additional Inherited Members
Public Slots inherited from QwtAbstractSlider
void	setValue (double value)

Signals inherited from QwtAbstractSlider
void	sliderMoved (double value)

void	sliderPressed ()

void	sliderReleased ()

void	valueChanged (double value)
	Notify a change of value. More...

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 50 of file qwt_dial.h.

Member Enumeration Documentation

◆ Mode

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 86 of file qwt_dial.h.

◆ Shadow

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 73 of file qwt_dial.h.

Constructor & Destructor Documentation

◆ QwtDial()

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 124 of file qwt_dial.cpp.

◆ ~QwtDial()

QwtDial::~QwtDial ( )

virtual

Destructor.

Definition at line 159 of file qwt_dial.cpp.

Member Function Documentation

◆ boundingRect()

QRect QwtDial::boundingRect ( ) const

Returns: bounding rectangle of the dial including the frame

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

Definition at line 234 of file qwt_dial.cpp.

◆ changeEvent()

void QwtDial::changeEvent ( QEvent * event )

protectedvirtual

Change Event handler

Parameters

event Change event

Invalidates internal paint caches if necessary

Reimplemented from QwtAbstractScale.

Definition at line 804 of file qwt_dial.cpp.

◆ drawContents()

void QwtDial::drawContents ( QPainter * painter ) const

protectedvirtual

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 391 of file qwt_dial.cpp.

◆ drawFocusIndicator()

void QwtDial::drawFocusIndicator ( QPainter * painter ) const

protectedvirtual

Draw the focus indicator

Parameters

painter Painter

Definition at line 362 of file qwt_dial.cpp.

◆ drawFrame()

void QwtDial::drawFrame ( QPainter * painter )

protectedvirtual

Draw the frame around the dial

Parameters

painter Painter

See also: lineWidth(), frameShadow()

Definition at line 373 of file qwt_dial.cpp.

◆ drawNeedle() [1/2]

void QwtDial::drawNeedle ( QPainter * painter ) const

private

Definition at line 448 of file qwt_dial.cpp.

◆ drawNeedle() [2/2]

void QwtDial::drawNeedle	(	QPainter *	painter,
		const QPointF &	center,
		double	radius,
		double	direction,
		QPalette::ColorGroup	colorGroup
	)		const

protectedvirtual

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 438 of file qwt_dial.cpp.

◆ drawScale()

void QwtDial::drawScale	(	QPainter *	painter,
		const QPointF &	center,
		double	radius
	)		const

protectedvirtual

Draw the scale

Parameters

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

Definition at line 475 of file qwt_dial.cpp.

◆ drawScaleContents()

void QwtDial::drawScaleContents	(	QPainter *	painter,
		const QPointF &	center,
		double	radius
	)		const

protectedvirtual

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 506 of file qwt_dial.cpp.

◆ frameShadow()

Shadow QwtDial::frameShadow ( ) const

◆ innerRect()

QRect QwtDial::innerRect ( ) const

Returns: bounding rectangle of the circle inside the frame

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

Definition at line 224 of file qwt_dial.cpp.

◆ invalidateCache()

void QwtDial::invalidateCache ( )

protected

Invalidate the internal caches used to speed up repainting

Definition at line 301 of file qwt_dial.cpp.

◆ isScrollPosition()

bool QwtDial::isScrollPosition ( const QPoint & pos ) const

protectedvirtual

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 721 of file qwt_dial.cpp.

◆ lineWidth()

int QwtDial::lineWidth ( ) const

◆ maxScaleArc()

double QwtDial::maxScaleArc ( ) const

◆ minimumSizeHint()

QSize QwtDial::minimumSizeHint ( ) const

virtual

Returns: Minimum size hint

See also: sizeHint()

Definition at line 702 of file qwt_dial.cpp.

◆ minScaleArc()

double QwtDial::minScaleArc ( ) const

◆ mode()

Mode QwtDial::mode ( ) const

◆ needle() [1/2]

QwtDialNeedle* QwtDial::needle ( )

◆ needle() [2/2]

QwtDialNeedle * QwtDial::needle ( ) const

Returns: needle

See also: setNeedle()

Definition at line 538 of file qwt_dial.cpp.

◆ origin()

double QwtDial::origin ( ) const

◆ paintEvent()

void QwtDial::paintEvent ( QPaintEvent * event )

protectedvirtual

Paint the dial

Parameters

event Paint event

Definition at line 310 of file qwt_dial.cpp.

◆ scaleChange()

void QwtDial::scaleChange ( )

protectedvirtual

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

Reimplemented from QwtAbstractSlider.

Definition at line 855 of file qwt_dial.cpp.

◆ scaleDraw() [1/2]

const QwtRoundScaleDraw * QwtDial::scaleDraw ( )

Returns: the scale draw

Definition at line 553 of file qwt_dial.cpp.

◆ scaleDraw() [2/2]

const QwtRoundScaleDraw* QwtDial::scaleDraw ( ) const

◆ scaleInnerRect()

QRect QwtDial::scaleInnerRect ( ) const

virtual

Returns: rectangle inside the scale

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

Definition at line 250 of file qwt_dial.cpp.

◆ scrolledTo()

double QwtDial::scrolledTo ( const QPoint & pos ) const

protectedvirtual

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 751 of file qwt_dial.cpp.

◆ setAngleRange()

void QwtDial::setAngleRange	(	double	angle,
		double	span
	)

private

Definition at line 842 of file qwt_dial.cpp.

◆ setFrameShadow()

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 170 of file qwt_dial.cpp.

◆ setLineWidth()

void QwtDial::setLineWidth ( int lineWidth )

Sets the line width of the frame

Parameters

lineWidth Line width

See also: setFrameShadow()

Definition at line 197 of file qwt_dial.cpp.

◆ setMaxScaleArc()

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 638 of file qwt_dial.cpp.

◆ setMinScaleArc()

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 618 of file qwt_dial.cpp.

◆ setMode()

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 278 of file qwt_dial.cpp.

◆ setNeedle()

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

Definition at line 522 of file qwt_dial.cpp.

◆ setOrigin()

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 660 of file qwt_dial.cpp.

◆ setScaleArc()

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 588 of file qwt_dial.cpp.

◆ setScaleDraw()

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 574 of file qwt_dial.cpp.

◆ sizeHint()

QSize QwtDial::sizeHint ( ) const

virtual

Returns: Size hint

See also: minimumSizeHint()

Definition at line 683 of file qwt_dial.cpp.

◆ sliderChange()

void QwtDial::sliderChange ( )

protectedvirtual

Calling update()

Reimplemented from QwtAbstractSlider.

Definition at line 861 of file qwt_dial.cpp.

◆ wheelEvent()

void QwtDial::wheelEvent ( QWheelEvent * event )

protectedvirtual

Wheel Event handler

Parameters

event Wheel event

Reimplemented from QwtAbstractSlider.

Definition at line 829 of file qwt_dial.cpp.

Member Data Documentation

◆ m_data

PrivateData* QwtDial::m_data

private

Definition at line 165 of file qwt_dial.h.

Property Documentation

◆ frameShadow

QwtDial::Shadow QwtDial::frameShadow

readwrite

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

Definition at line 57 of file qwt_dial.h.

◆ lineWidth

int QwtDial::lineWidth

readwrite

Returns: Line width of the frame

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

Definition at line 56 of file qwt_dial.h.

◆ maxScaleArc

double QwtDial::maxScaleArc

readwrite

Returns: Upper limit of the scale arc

See also: setScaleArc()

Definition at line 61 of file qwt_dial.h.

◆ minScaleArc

double QwtDial::minScaleArc

readwrite

Returns: Lower limit of the scale arc

See also: setScaleArc()

Definition at line 60 of file qwt_dial.h.

◆ mode

QwtDial::Mode QwtDial::mode

readwrite

Returns: Mode of the dial.

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

Definition at line 58 of file qwt_dial.h.

◆ origin

double QwtDial::origin

readwrite

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

Returns: Origin of the dial

See also: setOrigin()

Definition at line 59 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

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mode

◆ Shadow

Constructor & Destructor Documentation

◆ QwtDial()

◆ ~QwtDial()

Member Function Documentation

◆ boundingRect()

◆ changeEvent()

◆ drawContents()

◆ drawFocusIndicator()

◆ drawFrame()

◆ drawNeedle() [1/2]

◆ drawNeedle() [2/2]

◆ drawScale()

◆ drawScaleContents()

◆ frameShadow()

◆ innerRect()

◆ invalidateCache()

◆ isScrollPosition()

◆ lineWidth()

◆ maxScaleArc()

◆ minimumSizeHint()

◆ minScaleArc()

◆ mode()

◆ needle() [1/2]

◆ needle() [2/2]

◆ origin()

◆ paintEvent()

◆ scaleChange()

◆ scaleDraw() [1/2]

◆ scaleDraw() [2/2]

◆ scaleInnerRect()

◆ scrolledTo()

◆ setAngleRange()

◆ setFrameShadow()

◆ setLineWidth()

◆ setMaxScaleArc()

◆ setMinScaleArc()

◆ setMode()

◆ setNeedle()

◆ setOrigin()

◆ setScaleArc()

◆ setScaleDraw()

◆ sizeHint()

◆ sliderChange()

◆ wheelEvent()

Member Data Documentation

◆ m_data

Property Documentation

◆ frameShadow

◆ lineWidth

◆ maxScaleArc

◆ minScaleArc

◆ mode

◆ origin