An abstract base class for widgets having a scale. More...

#include <qwt_abstract_scale.h>

Inheritance diagram for QwtAbstractScale:

Classes
class	PrivateData
Public Member Functions
double	invTransform (int) const
bool	isInverted () const
double	lowerBound () const
double	maximum () const
double	minimum () const
	QwtAbstractScale (QWidget *parent=NULL)
const QwtScaleDiv &	scaleDiv () const
const QwtScaleEngine *	scaleEngine () const
QwtScaleEngine *	scaleEngine ()
const QwtScaleMap &	scaleMap () const
int	scaleMaxMajor () const
int	scaleMaxMinor () const
double	scaleStepSize () const
void	setLowerBound (double value)
void	setScale (double lowerBound, double upperBound)
	Specify a scale.
void	setScale (const QwtInterval &)
	Specify a scale.
void	setScale (const QwtScaleDiv &)
	Specify a scale.
void	setScaleEngine (QwtScaleEngine *)
	Set a scale engine.
void	setScaleMaxMajor (int ticks)
	Set the maximum number of major tick intervals.
void	setScaleMaxMinor (int ticks)
	Set the maximum number of minor tick intervals.
void	setScaleStepSize (double stepSize)
	Set the step size used for calculating a scale division.
void	setUpperBound (double value)
int	transform (double) const
double	upperBound () const
virtual	~QwtAbstractScale ()
	Destructor.
Protected Member Functions
const QwtAbstractScaleDraw *	abstractScaleDraw () const
QwtAbstractScaleDraw *	abstractScaleDraw ()
virtual void	changeEvent (QEvent *)
void	rescale (double lowerBound, double upperBound, double stepSize)
virtual void	scaleChange ()
	Notify changed scale.
void	setAbstractScaleDraw (QwtAbstractScaleDraw *)
	Set a scale draw.
void	updateScaleDraw ()
Properties
double	lowerBound
int	scaleMaxMajor
int	scaleMaxMinor
double	scaleStepSize
double	upperBound
Private Attributes
PrivateData *	d_data

Detailed Description

An abstract base class for widgets having a scale.

The scale of an QwtAbstractScale is determined by a QwtScaleDiv definition, that contains the boundaries and the ticks of the scale. The scale is painted using a QwtScaleDraw object.

The scale division might be assigned explicitly - but usually it is calculated from the boundaries using a QwtScaleEngine.

The scale engine also decides the type of transformation of the scale ( linear, logarithmic ... ).

Definition at line 36 of file qwt_abstract_scale.h.

Constructor & Destructor Documentation

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

Constructor

Parameters:

parent Parent widget

Creates a default QwtScaleDraw and a QwtLinearScaleEngine. The initial scale boundaries are set to [ 0.0, 100.0 ]

The scaleStepSize() is initialized to 0.0, scaleMaxMajor() to 5 and scaleMaxMajor to 3.

Definition at line 56 of file qwt_abstract_scale.cpp.

QwtAbstractScale::~QwtAbstractScale ( ) [virtual]

Destructor.

Definition at line 64 of file qwt_abstract_scale.cpp.

Member Function Documentation

const QwtAbstractScaleDraw * QwtAbstractScale::abstractScaleDraw ( ) const [protected]

Returns:: Scale draw

See also:: setAbstractScaleDraw()

Definition at line 301 of file qwt_abstract_scale.cpp.

QwtAbstractScaleDraw * QwtAbstractScale::abstractScaleDraw ( ) [protected]

Returns:: Scale draw

See also:: setAbstractScaleDraw()

Definition at line 292 of file qwt_abstract_scale.cpp.

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

Change Event handler

Parameters:

event Change event

Invalidates internal caches if necessary

Reimplemented in QwtThermo, QwtKnob, QwtDial, and QwtSlider.

Definition at line 452 of file qwt_abstract_scale.cpp.

double QwtAbstractScale::invTransform ( int value ) const

Translate a widget coordinate into a scale value

Parameters:

value Widget coordinate

Returns:: Corresponding scale coordinate for value

See also:: scaleMap(), transform()

Definition at line 380 of file qwt_abstract_scale.cpp.

bool QwtAbstractScale::isInverted ( ) const

Returns:: True, when the scale is increasing in opposite direction to the widget coordinates

Definition at line 389 of file qwt_abstract_scale.cpp.

double QwtAbstractScale::lowerBound ( ) const

double QwtAbstractScale::maximum ( ) const

Returns:: The boundary with the larger value

See also:: minimum(), lowerBound(), upperBound()

Definition at line 408 of file qwt_abstract_scale.cpp.

double QwtAbstractScale::minimum ( ) const

Returns:: The boundary with the smaller value

See also:: maximum(), lowerBound(), upperBound()

Definition at line 398 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::rescale	(	double	lowerBound,
		double	upperBound,
		double	stepSize
	)		`[protected]`

Recalculate the scale division and update the scale.

Parameters:

lowerBound	Lower limit of the scale interval
upperBound	Upper limit of the scale interval
stepSize	Major step size

See also:: scaleChange()

Definition at line 428 of file qwt_abstract_scale.cpp.

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

Notify changed scale.

Reimplemented in QwtThermo, QwtDial, QwtAbstractSlider, and QwtSlider.

Definition at line 415 of file qwt_abstract_scale.cpp.

const QwtScaleDiv & QwtAbstractScale::scaleDiv ( ) const

Returns:: Scale boundaries and positions of the ticks

The scale division might have been assigned explicitly or calculated implicitly by rescale().

Definition at line 348 of file qwt_abstract_scale.cpp.

const QwtScaleEngine * QwtAbstractScale::scaleEngine ( ) const

Returns:: Scale engine

See also:: setScaleEngine()

Definition at line 328 of file qwt_abstract_scale.cpp.

QwtScaleEngine * QwtAbstractScale::scaleEngine ( )

Returns:: Scale engine

See also:: setScaleEngine()

Definition at line 337 of file qwt_abstract_scale.cpp.

const QwtScaleMap & QwtAbstractScale::scaleMap ( ) const

Returns:: Map to translate between scale and widget coordinates

Definition at line 356 of file qwt_abstract_scale.cpp.

int QwtAbstractScale::scaleMaxMajor ( ) const

int QwtAbstractScale::scaleMaxMinor ( ) const

double QwtAbstractScale::scaleStepSize ( ) const

void QwtAbstractScale::setAbstractScaleDraw ( QwtAbstractScaleDraw * scaleDraw ) [protected]

Set a scale draw.

scaleDraw has to be created with new and will be deleted in the destructor or the next call of setAbstractScaleDraw().

See also:: abstractScaleDraw()

Definition at line 276 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setLowerBound ( double value )

Set the lower bound of the scale

Parameters:

value Lower bound

See also:: lowerBound(), setScale(), setUpperBound()

Note:: For inverted scales the lower bound is greater than the upper bound

Definition at line 78 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScale	(	double	lowerBound,
		double	upperBound
	)

Specify a scale.

Define a scale by an interval

The ticks are calculated using scaleMaxMinor(), scaleMaxMajor() and scaleStepSize().

Parameters:

lowerBound	lower limit of the scale interval
upperBound	upper limit of the scale interval

Note:: For inverted scales the lower bound is greater than the upper bound

Definition at line 129 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScale ( const QwtInterval & interval )

Specify a scale.

Define a scale by an interval

The ticks are calculated using scaleMaxMinor(), scaleMaxMajor() and scaleStepSize().

Parameters:

interval Interval

Definition at line 144 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScale ( const QwtScaleDiv & scaleDiv )

Specify a scale.

scaleMaxMinor(), scaleMaxMajor() and scaleStepSize() and have no effect.

Parameters:

scaleDiv Scale division

See also:: setAutoScale()

Definition at line 157 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScaleEngine ( QwtScaleEngine * scaleEngine )

Set a scale engine.

The scale engine is responsible for calculating the scale division and provides a transformation between scale and widget coordinates.

scaleEngine has to be created with new and will be deleted in the destructor or the next call of setScaleEngine.

Definition at line 315 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScaleMaxMajor ( int ticks )

Set the maximum number of major tick intervals.

The scale's major ticks are calculated automatically such that the number of major intervals does not exceed ticks.

The default value is 5.

Parameters:

ticks Maximal number of major ticks.

See also:: scaleMaxMajor(), setScaleMaxMinor(), setScaleStepSize(), QwtScaleEngine::divideInterval()

Definition at line 188 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScaleMaxMinor ( int ticks )

Set the maximum number of minor tick intervals.

The scale's minor ticks are calculated automatically such that the number of minor intervals does not exceed ticks. The default value is 3.

Parameters:

ticks Maximal number of minor ticks.

See also:: scaleMaxMajor(), setScaleMaxMinor(), setScaleStepSize(), QwtScaleEngine::divideInterval()

Definition at line 218 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setScaleStepSize ( double stepSize )

Set the step size used for calculating a scale division.

The step size is hint for calculating the intervals for the major ticks of the scale. A value of 0.0 is interpreted as no hint.

Parameters:

stepSize Hint for the step size of the scale

See also:: scaleStepSize(), QwtScaleEngine::divideScale()

Note:: Position and distance between the major ticks also depends on scaleMaxMajor().

Definition at line 250 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::setUpperBound ( double value )

Set the upper bound of the scale

Parameters:

value Upper bound

See also:: upperBound(), setScale(), setLowerBound()

Note:: For inverted scales the lower bound is greater than the upper bound

Definition at line 101 of file qwt_abstract_scale.cpp.

int QwtAbstractScale::transform ( double value ) const

Translate a scale value into a widget coordinate

Parameters:

value Scale value

Returns:: Corresponding widget coordinate for value

See also:: scaleMap(), invTransform()

Definition at line 368 of file qwt_abstract_scale.cpp.

void QwtAbstractScale::updateScaleDraw ( ) [protected]

Recalculate ticks and scale boundaries.

Definition at line 465 of file qwt_abstract_scale.cpp.

double QwtAbstractScale::upperBound ( ) const

Member Data Documentation

PrivateData* QwtAbstractScale::d_data [private]

Reimplemented in QwtKnob, QwtThermo, QwtDial, QwtAbstractSlider, QwtSlider, and QwtCompass.

Definition at line 102 of file qwt_abstract_scale.h.

Property Documentation

double QwtAbstractScale::lowerBound [read, write]

Returns:: Lower bound of the scale

See also:: setLowerBound(), setScale(), upperBound()

Definition at line 40 of file qwt_abstract_scale.h.

int QwtAbstractScale::scaleMaxMajor [read, write]

Returns:: Maximal number of major tick intervals

See also:: setScaleMaxMajor(), scaleMaxMinor()

Definition at line 43 of file qwt_abstract_scale.h.

int QwtAbstractScale::scaleMaxMinor [read, write]

Returns:: Maximal number of minor tick intervals

See also:: setScaleMaxMinor(), scaleMaxMajor()

Definition at line 44 of file qwt_abstract_scale.h.

double QwtAbstractScale::scaleStepSize [read, write]

Returns:: Hint for the step size of the scale

See also:: setScaleStepSize(), QwtScaleEngine::divideScale()

Definition at line 46 of file qwt_abstract_scale.h.

double QwtAbstractScale::upperBound [read, write]

Returns:: Upper bound of the scale

See also:: setUpperBound(), setScale(), lowerBound()

Definition at line 41 of file qwt_abstract_scale.h.

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

Classes

Public Member Functions

Protected Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation