A class for drawing scales. More...

#include <qwt_scale_draw.h>

Inheritance diagram for QwtScaleDraw:

Classes
class	PrivateData

Public Types
enum	Alignment { BottomScale, TopScale, LeftScale, RightScale }

Public Types inherited from QwtAbstractScaleDraw
enum	ScaleComponent { Backbone = 0x01, Ticks = 0x02, Labels = 0x04 }

typedef QFlags< ScaleComponent >	ScaleComponents
	Scale components. More...

Public Member Functions
Alignment	alignment () const

QRect	boundingLabelRect (const QFont &, double val) const
	Find the bounding rectangle for the label. More...

virtual double	extent (const QFont &) const

void	getBorderDistHint (const QFont &, int &start, int &end) const
	Determine the minimum border distance. More...

Qt::Alignment	labelAlignment () const

QPointF	labelPosition (double val) const

QRectF	labelRect (const QFont &, double val) const

double	labelRotation () const

QSizeF	labelSize (const QFont &, double val) const

double	length () const

int	maxLabelHeight (const QFont &) const

int	maxLabelWidth (const QFont &) const

int	minLabelDist (const QFont &) const

int	minLength (const QFont &) const

void	move (double x, double y)

void	move (const QPointF &)
	Move the position of the scale. More...

Qt::Orientation	orientation () const

QPointF	pos () const

	QwtScaleDraw ()
	Constructor. More...

void	setAlignment (Alignment)

void	setLabelAlignment (Qt::Alignment)
	Change the label flags. More...

void	setLabelRotation (double rotation)

void	setLength (double length)

virtual	~QwtScaleDraw ()
	Destructor. More...

Public Member Functions inherited from QwtAbstractScaleDraw
virtual void	draw (QPainter *, const QPalette &) const
	Draw the scale. More...

void	enableComponent (ScaleComponent, bool enable=true)

bool	hasComponent (ScaleComponent) const

void	invalidateCache ()

virtual QwtText	label (double) const
	Convert a value into its representing label. More...

double	maxTickLength () const

double	minimumExtent () const

int	penWidth () const

	QwtAbstractScaleDraw ()
	Constructor. More...

const QwtScaleDiv &	scaleDiv () const

const QwtScaleMap &	scaleMap () const

QwtScaleMap &	scaleMap ()

void	setMinimumExtent (double)
	Set a minimum for the extent. More...

void	setPenWidth (int width)
	Specify the width of the scale pen. More...

void	setScaleDiv (const QwtScaleDiv &s)

void	setSpacing (double margin)
	Set the spacing between tick and labels. More...

void	setTickLength (QwtScaleDiv::TickType, double length)

void	setTransformation (QwtTransform *)

double	spacing () const
	Get the spacing. More...

double	tickLength (QwtScaleDiv::TickType) const

virtual	~QwtAbstractScaleDraw ()
	Destructor. More...

Protected Member Functions
virtual void	drawBackbone (QPainter *) const

virtual void	drawLabel (QPainter *, double val) const

virtual void	drawTick (QPainter *, double val, double len) const

QTransform	labelTransformation (const QPointF &, const QSizeF &) const

Protected Member Functions inherited from QwtAbstractScaleDraw
const QwtText &	tickLabel (const QFont &, double value) const
	Convert a value into its representing label and cache it. More...

Private Member Functions
void	updateMap ()

Private Attributes
PrivateData *	d_data

Detailed Description

A class for drawing scales.

QwtScaleDraw can be used to draw linear or logarithmic scales. A scale has a position, an alignment and a length, which can be specified . The labels can be rotated and aligned to the ticks using setLabelRotation() and setLabelAlignment().

After a scale division has been specified as a QwtScaleDiv object using QwtAbstractScaleDraw::setScaleDiv(const QwtScaleDiv &s), the scale can be drawn with the QwtAbstractScaleDraw::draw() member.

Definition at line 31 of file qwt_scale_draw.h.

Member Enumeration Documentation

enum QwtScaleDraw::Alignment

Alignment of the scale draw

See also: setAlignment(), alignment()

Enumerator
BottomScale	The scale is below.
TopScale	The scale is above.
LeftScale	The scale is left.
RightScale	The scale is right.

Definition at line 38 of file qwt_scale_draw.h.

Constructor & Destructor Documentation

QwtScaleDraw::QwtScaleDraw ( )

Constructor.

The range of the scale is initialized to [0, 100], The position is at (0, 0) with a length of 100. The orientation is QwtAbstractScaleDraw::Bottom.

Definition at line 51 of file qwt_scale_draw.cpp.

QwtScaleDraw::~QwtScaleDraw ( )

virtual

Destructor.

Definition at line 58 of file qwt_scale_draw.cpp.

Member Function Documentation

QwtScaleDraw::Alignment QwtScaleDraw::alignment ( ) const

Return alignment of the scale

See also: setAlignment()

Returns: Alignment of the scale

Definition at line 68 of file qwt_scale_draw.cpp.

QRect QwtScaleDraw::boundingLabelRect	(	const QFont &	font,
		double	value
	)		const

Find the bounding rectangle for the label.

The coordinates of the rectangle are absolute ( calculated from pos() ). in direction of the tick.

Parameters

font	Font used for painting
value	Value

Returns: Bounding rectangle

See also: labelRect()

Definition at line 681 of file qwt_scale_draw.cpp.

void QwtScaleDraw::drawBackbone ( QPainter * painter ) const

protectedvirtual

Draws the baseline of the scale

Parameters

painter Painter

See also: drawTick(), drawLabel()

Implements QwtAbstractScaleDraw.

Definition at line 493 of file qwt_scale_draw.cpp.

void QwtScaleDraw::drawLabel	(	QPainter *	painter,
		double	value
	)		const

protectedvirtual

Draws the label for a major scale tick

Parameters

painter	Painter
value	Value

See also: drawTick(), drawBackbone(), boundingLabelRect()

Implements QwtAbstractScaleDraw.

Definition at line 649 of file qwt_scale_draw.cpp.

void QwtScaleDraw::drawTick	(	QPainter *	painter,
		double	value,
		double	len
	)		const

protectedvirtual

Draw a tick

Parameters

painter	Painter
value	Value of the tick
len	Length of the tick

See also: drawBackbone(), drawLabel()

Implements QwtAbstractScaleDraw.

Definition at line 409 of file qwt_scale_draw.cpp.

double QwtScaleDraw::extent ( const QFont & font ) const

virtual

Calculate the width/height that is needed for a vertical/horizontal scale.

The extent is calculated from the pen width of the backbone, the major tick length, the spacing and the maximum width/height of the labels.

Parameters

font	Font used for painting the labels

Returns: Extent

See also: minLength()

Implements QwtAbstractScaleDraw.

Definition at line 282 of file qwt_scale_draw.cpp.

void QwtScaleDraw::getBorderDistHint	(	const QFont &	font,
		int &	start,
		int &	end
	)		const

Determine the minimum border distance.

This member function returns the minimum space needed to draw the mark labels at the scale's endpoints.

Parameters

font	Font
start	Start border distance
end	End border distance

Definition at line 120 of file qwt_scale_draw.cpp.

Qt::Alignment QwtScaleDraw::labelAlignment ( ) const

Returns: the label flags

See also: setLabelAlignment(), labelRotation()

Definition at line 865 of file qwt_scale_draw.cpp.

QPointF QwtScaleDraw::labelPosition ( double value ) const

Find the position, where to paint a label

The position has a distance that depends on the length of the ticks in direction of the alignment().

Parameters

value Value

Returns: Position, where to paint a label

Definition at line 356 of file qwt_scale_draw.cpp.

QRectF QwtScaleDraw::labelRect	(	const QFont &	font,
		double	value
	)		const

Find the bounding rectangle for the label. The coordinates of the rectangle are relative to spacing + tick length from the backbone in direction of the tick.

Parameters

font	Font used for painting
value	Value

Returns: Bounding rectangle that is needed to draw a label

Definition at line 774 of file qwt_scale_draw.cpp.

double QwtScaleDraw::labelRotation ( ) const

Returns: the label rotation

See also: setLabelRotation(), labelAlignment()

Definition at line 826 of file qwt_scale_draw.cpp.

QSizeF QwtScaleDraw::labelSize	(	const QFont &	font,
		double	value
	)		const

Calculate the size that is needed to draw a label

Parameters

font	Label font
value	Value

Returns: Size that is needed to draw a label

Definition at line 799 of file qwt_scale_draw.cpp.

QTransform QwtScaleDraw::labelTransformation	(	const QPointF &	pos,
		const QSizeF &	size
	)		const

protected

Calculate the transformation that is needed to paint a label depending on its alignment and rotation.

Parameters

pos	Position where to paint the label
size	Size of the label

Returns: Transformation matrix

See also: setLabelAlignment(), setLabelRotation()

Definition at line 704 of file qwt_scale_draw.cpp.

double QwtScaleDraw::length ( ) const

Returns: the length of the backbone

See also: setLength(), pos()

Definition at line 636 of file qwt_scale_draw.cpp.

int QwtScaleDraw::maxLabelHeight ( const QFont & font ) const

Parameters

font Font

Returns: the maximum height of a label

Definition at line 897 of file qwt_scale_draw.cpp.

int QwtScaleDraw::maxLabelWidth ( const QFont & font ) const

Parameters

font Font

Returns: the maximum width of a label

Definition at line 874 of file qwt_scale_draw.cpp.

int QwtScaleDraw::minLabelDist ( const QFont & font ) const

Determine the minimum distance between two labels, that is necessary that the texts don't overlap.

Parameters

font Font

Returns: The maximum width of a label

See also: getBorderDistHint()

Definition at line 195 of file qwt_scale_draw.cpp.

int QwtScaleDraw::minLength ( const QFont & font ) const

Calculate the minimum length that is needed to draw the scale

Parameters

font	Font used for painting the labels

Returns: Minimum length that is needed to draw the scale

See also: extent()

Definition at line 320 of file qwt_scale_draw.cpp.

void QwtScaleDraw::move	(	double	x,
		double	y
	)

inline

Move the position of the scale

Parameters

x	X coordinate
y	Y coordinate

See also: move(const QPointF &)

Definition at line 112 of file qwt_scale_draw.h.

void QwtScaleDraw::move ( const QPointF & pos )

Move the position of the scale.

The meaning of the parameter pos depends on the alignment:

QwtScaleDraw::LeftScale: The origin is the topmost point of the backbone. The backbone is a vertical line. Scale marks and labels are drawn at the left of the backbone.
QwtScaleDraw::RightScale: The origin is the topmost point of the backbone. The backbone is a vertical line. Scale marks and labels are drawn at the right of the backbone.
QwtScaleDraw::TopScale: The origin is the leftmost point of the backbone. The backbone is a horizontal line. Scale marks and labels are drawn above the backbone.
QwtScaleDraw::BottomScale: The origin is the leftmost point of the backbone. The backbone is a horizontal line Scale marks and labels are drawn below the backbone.

Parameters

pos	Origin of the scale

See also: pos(), setLength()

Definition at line 590 of file qwt_scale_draw.cpp.

Qt::Orientation QwtScaleDraw::orientation ( ) const

Return the orientation

TopScale, BottomScale are horizontal (Qt::Horizontal) scales, LeftScale, RightScale are vertical (Qt::Vertical) scales.

Returns: Orientation of the scale

See also: alignment()

Definition at line 96 of file qwt_scale_draw.cpp.

QPointF QwtScaleDraw::pos ( ) const

Returns: Origin of the scale

See also: move(), length()

Definition at line 600 of file qwt_scale_draw.cpp.

void QwtScaleDraw::setAlignment ( Alignment align )

Set the alignment of the scale

Parameters

align Alignment of the scale

The default alignment is QwtScaleDraw::BottomScale

See also: alignment()

Definition at line 81 of file qwt_scale_draw.cpp.

void QwtScaleDraw::setLabelAlignment ( Qt::Alignment alignment )

Change the label flags.

Labels are aligned to the point tick length + spacing away from the backbone.

The alignment is relative to the orientation of the label text. In case of an flags of 0 the label will be aligned depending on the orientation of the scale:

QwtScaleDraw::TopScale: Qt::AlignHCenter | Qt::AlignTop\n
QwtScaleDraw::BottomScale: Qt::AlignHCenter | Qt::AlignBottom\n
QwtScaleDraw::LeftScale: Qt::AlignLeft | Qt::AlignVCenter\n
QwtScaleDraw::RightScale: Qt::AlignRight | Qt::AlignVCenter\n

Changing the alignment is often necessary for rotated labels.

Parameters

alignment Or'd Qt::AlignmentFlags see <qnamespace.h>

See also: setLabelRotation(), labelRotation(), labelAlignment()

Warning: The various alignments might be confusing. The alignment of the label is not the alignment of the scale and is not the alignment of the flags ( QwtText::flags() ) returned from QwtAbstractScaleDraw::label().

Definition at line 856 of file qwt_scale_draw.cpp.

void QwtScaleDraw::setLabelRotation ( double rotation )

Rotate all labels.

When changing the rotation, it might be necessary to adjust the label flags too. Finding a useful combination is often the result of try and error.

Parameters

rotation Angle in degrees. When changing the label rotation, the label flags often needs to be adjusted too.

See also: setLabelAlignment(), labelRotation(), labelAlignment().

Definition at line 817 of file qwt_scale_draw.cpp.

void QwtScaleDraw::setLength ( double length )

Set the length of the backbone.

The length doesn't include the space needed for overlapping labels.

Parameters

length Length of the backbone

See also: move(), minLabelDist()

Definition at line 615 of file qwt_scale_draw.cpp.

void QwtScaleDraw::updateMap ( )

private

Definition at line 916 of file qwt_scale_draw.cpp.

Member Data Documentation

PrivateData* QwtScaleDraw::d_data

private

Definition at line 100 of file qwt_scale_draw.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation