A Compass Widget. More...

#include <qwt_compass.h>

Inheritance diagram for QwtCompass:

Classes
class	PrivateData

Public Member Functions
	QwtCompass (QWidget *parent=NULL)
	Constructor.

virtual	~QwtCompass ()
	Destructor.

void	setRose (QwtCompassRose *rose)
	Set a rose for the compass.

const QwtCompassRose *	rose () const

QwtCompassRose *	rose ()

Public Member Functions inherited from QwtDial
	QwtDial (QWidget *parent=NULL)
	Constructor.

virtual	~QwtDial ()
	Destructor.

void	setFrameShadow (Shadow)
	Sets the frame shadow value from the frame style.

Shadow	frameShadow () const

void	setLineWidth (int)
	Sets the line width of the frame.

int	lineWidth () const

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

Mode	mode () const

void	setScaleArc (double minArc, double maxArc)
	Change the arc of the scale.

void	setMinScaleArc (double)
	Set the lower limit for the scale arc.

double	minScaleArc () const

void	setMaxScaleArc (double)
	Set the upper limit for the scale arc.

double	maxScaleArc () const

virtual void	setOrigin (double)
	Change the origin.

double	origin () const
	The origin is the angle where scale and needle is relative to.

void	setNeedle (QwtDialNeedle *)
	Set a needle for the dial.

const QwtDialNeedle *	needle () const

QwtDialNeedle *	needle ()

QRect	boundingRect () const

QRect	innerRect () const

virtual QRect	scaleInnerRect () const

virtual QSize	sizeHint () const QWT_OVERRIDE

virtual QSize	minimumSizeHint () const QWT_OVERRIDE

void	setScaleDraw (QwtRoundScaleDraw *)
	Set an individual scale draw.

QwtRoundScaleDraw *	scaleDraw ()

const QwtRoundScaleDraw *	scaleDraw () const

Public Member Functions inherited from QwtAbstractSlider
	QwtAbstractSlider (QWidget *parent=NULL)
	Constructor.

virtual	~QwtAbstractSlider ()
	Destructor.

void	setValid (bool)
	Set the value to be valid/invalid.

bool	isValid () const

double	value () const
	Returns the current value.

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

bool	wrapping () const

void	setTotalSteps (uint)
	Set the number of steps.

uint	totalSteps () const

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

uint	singleSteps () const

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

uint	pageSteps () const

void	setStepAlignment (bool)
	Enable step alignment.

bool	stepAlignment () const

void	setTracking (bool)
	Enables or disables tracking.

bool	isTracking () const

void	setReadOnly (bool)
	En/Disable read only mode.

bool	isReadOnly () const
	In read only mode the slider can't be controlled by mouse or keyboard.

void	setInvertedControls (bool)
	Invert wheel and key events.

bool	invertedControls () const

Public Member Functions inherited from QwtAbstractScale
	QwtAbstractScale (QWidget *parent=NULL)
	Constructor.

virtual	~QwtAbstractScale ()
	Destructor.

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

void	setScale (const QwtInterval &)
	Specify a scale.

void	setScale (const QwtScaleDiv &)
	Specify a scale.

const QwtScaleDiv &	scaleDiv () const

void	setLowerBound (double value)
	Set the lower bound of the scale.

double	lowerBound () const

void	setUpperBound (double value)
	Set the upper bound of the scale.

double	upperBound () const

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

double	scaleStepSize () const

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

int	scaleMaxMinor () const

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

int	scaleMaxMajor () const

void	setScaleEngine (QwtScaleEngine *)
	Set a scale engine.

const QwtScaleEngine *	scaleEngine () const

QwtScaleEngine *	scaleEngine ()

int	transform (double) const
	Translate a scale value into a widget coordinate.

double	invTransform (int) const
	Translate a widget coordinate into a scale value.

bool	isInverted () const

double	minimum () const

double	maximum () const

const QwtScaleMap &	scaleMap () const

Protected Member Functions
virtual void	drawRose (QPainter *, const QPointF &center, double radius, double north, QPalette::ColorGroup) const
	Draw the compass rose.

virtual void	drawScaleContents (QPainter *, const QPointF &center, double radius) const QWT_OVERRIDE
	Draw the contents of the scale.

virtual void	keyPressEvent (QKeyEvent *) QWT_OVERRIDE
	Handles key events.

Protected Member Functions inherited from QwtDial
virtual void	wheelEvent (QWheelEvent *) QWT_OVERRIDE
	Wheel Event handler.

virtual void	paintEvent (QPaintEvent *) QWT_OVERRIDE
	Paint the dial.

virtual void	changeEvent (QEvent *) QWT_OVERRIDE
	Change Event handler.

virtual void	drawFrame (QPainter *)
	Draw the frame around the dial.

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

virtual void	drawFocusIndicator (QPainter *) const
	Draw the focus indicator.

void	invalidateCache ()
	Invalidate the internal caches used to speed up repainting.

virtual void	drawScale (QPainter *, const QPointF &center, double radius) const
	Draw the scale.

virtual void	drawNeedle (QPainter *, const QPointF &, double radius, double direction, QPalette::ColorGroup) const
	Draw the needle.

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

virtual bool	isScrollPosition (const QPoint &) const QWT_OVERRIDE
	Determine what to do when the user presses a mouse button.

virtual void	sliderChange () QWT_OVERRIDE
	Calling update()

virtual void	scaleChange () QWT_OVERRIDE
	Invalidate the internal caches and call QwtAbstractSlider::scaleChange()

Protected Member Functions inherited from QwtAbstractSlider
virtual void	mousePressEvent (QMouseEvent *) QWT_OVERRIDE
	Mouse press event handler.

virtual void	mouseReleaseEvent (QMouseEvent *) QWT_OVERRIDE
	Mouse Release Event handler.

virtual void	mouseMoveEvent (QMouseEvent *) QWT_OVERRIDE
	Mouse Move Event handler.

void	incrementValue (int stepCount)
	Increment the slider.

double	incrementedValue (double value, int stepCount) const
	Increment a value.

Protected Member Functions inherited from QwtAbstractScale
void	rescale (double lowerBound, double upperBound, double stepSize)
	Recalculate the scale division and update the scale.

void	setAbstractScaleDraw (QwtAbstractScaleDraw *)
	Set a scale draw.

const QwtAbstractScaleDraw *	abstractScaleDraw () const

QwtAbstractScaleDraw *	abstractScaleDraw ()

void	updateScaleDraw ()
	Recalculate ticks and scale boundaries.

Additional Inherited Members
Public Types inherited from QwtDial
enum	Shadow { Plain = QFrame::Plain , Raised = QFrame::Raised , Sunken = QFrame::Sunken }
	Frame shadow. More...

enum	Mode { RotateNeedle , RotateScale }
	Mode controlling whether the needle or the scale is rotating. More...

Public Slots inherited from QwtAbstractSlider
void	setValue (double value)
	Set the slider to the specified value.

Signals inherited from QwtAbstractSlider
void	valueChanged (double value)
	Notify a change of value.

void	sliderPressed ()
	This signal is emitted when the user presses the movable part of the slider.

void	sliderReleased ()
	This signal is emitted when the user releases the movable part of the slider.

void	sliderMoved (double value)
	This signal is emitted when the user moves the slider with the mouse.

Properties inherited from QwtDial
int	lineWidth

Shadow	frameShadow

Mode	mode

double	origin

double	minScaleArc

double	maxScaleArc

Properties inherited from QwtAbstractSlider
double	value

uint	totalSteps

uint	singleSteps

uint	pageSteps

bool	stepAlignment

bool	readOnly

bool	tracking

bool	wrapping

bool	invertedControls

Properties inherited from QwtAbstractScale
double	lowerBound

double	upperBound

int	scaleMaxMajor

int	scaleMaxMinor

double	scaleStepSize

Detailed Description

A Compass Widget.

QwtCompass is a widget to display and enter directions. It consists of a scale, an optional needle and rose.

Note: The examples/dials example shows how to use QwtCompass.

Constructor & Destructor Documentation

◆ QwtCompass()

QwtCompass::QwtCompass ( QWidget * parent = NULL )

explicit

Constructor.

Parameters

parent Parent widget

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

Member Function Documentation

◆ drawRose()

void QwtCompass::drawRose	(	QPainter *	painter,
		const QPointF &	center,
		double	radius,
		double	north,
		QPalette::ColorGroup	cg
	)		const

protectedvirtual

Draw the compass rose.

Parameters

painter	Painter
center	Center of the compass
radius	of the circle, where to paint the rose
north	Direction pointing north, in degrees counter clockwise
cg	Color group

◆ drawScaleContents()

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

protectedvirtual

Draw the contents of the scale.

Parameters

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

Reimplemented from QwtDial.

◆ keyPressEvent()

void QwtCompass::keyPressEvent ( QKeyEvent * kev )

protectedvirtual

Handles key events.

Beside the keys described in QwtDial::keyPressEvent numbers from 1-9 (without 5) set the direction according to their position on the num pad.

See also: isReadOnly()

Reimplemented from QwtAbstractSlider.

◆ rose() [1/2]

QwtCompassRose * QwtCompass::rose ( )

Returns: rose

See also: setRose()

◆ rose() [2/2]

const QwtCompassRose * QwtCompass::rose ( ) const

Returns: rose

See also: setRose()

◆ setRose()

void QwtCompass::setRose ( QwtCompassRose * rose )

Set a rose for the compass.

Parameters

rose	Compass rose

Warning: The rose will be deleted, when a different rose is set or in ~QwtCompass

See also: rose()

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

/home/runner/work/QWT/QWT/src/qwt_compass.h
/home/runner/work/QWT/QWT/src/qwt_compass.cpp

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwtCompass()

Member Function Documentation

◆ drawRose()

◆ drawScaleContents()

◆ keyPressEvent()

◆ rose() [1/2]

◆ rose() [2/2]

◆ setRose()