KDChart::RelativePosition Class Reference

Defines relative position information: reference area, position in this area, horizontal / vertical padding, and rotating. More...

#include <KDChartRelativePosition.h>

List of all members.

Public Member Functions
Qt::Alignment	alignment () const
const QPointF	calculatedPoint (const QSizeF &autoSize) const
	Calculate a point, according to the reference area/position and horiz/vert padding.
Measure	horizontalPadding () const
bool	operator!= (const RelativePosition &other) const
RelativePosition &	operator= (const RelativePosition &other)
bool	operator== (const RelativePosition &) const
QObject *	referenceArea () const
const QPointF	referencePoint (qreal *polarDegrees=0) const
	Return the reference point, according to the reference area/position, but ignoring horiz/vert padding.
const PositionPoints	referencePoints () const
Position	referencePosition () const
	RelativePosition (const RelativePosition &)
	RelativePosition ()
void	resetReferencePosition ()
	Resets the position of the anchor point to the built-in default.
qreal	rotation () const
void	setAlignment (Qt::Alignment flags)
	Specifies the location of the content, that is to be positioned by this RelativePosition.
void	setHorizontalPadding (const Measure &padding)
	Specifies the horizontal width of the gap between the anchor point and the content, that is to be positioned by this RelativePosition.
void	setReferenceArea (QObject *area)
	Specifies the reference area to be used to find the anchor point.
void	setReferencePoints (const PositionPoints &points)
	Specifies a set of points from which the anchor point will be selected.
void	setReferencePosition (Position position)
	Specifies the position of the anchor point.
void	setRotation (qreal rot)
void	setVerticalPadding (const Measure &padding)
	Specifies the vertical width of the gap between the anchor point and the content, that is to be positioned by this RelativePosition.
Measure	verticalPadding () const
	~RelativePosition ()

Detailed Description

Defines relative position information: reference area, position in this area, horizontal / vertical padding, and rotating.

Using RelativePosition you can specify the relative parts of some position information, and you can specify the absolute parts: the reference area, and the position in this area.

Note:

To get an absolute position, you have three options:

either you declare both, the relative and the absolute parts, using setReferenceArea for the later,
or you specify a set of points, using setReferencePoints,
or you refrein from using either, but leave it to KD Chart to find a matching reference area for you.

Definition at line 55 of file KDChartRelativePosition.h.

Constructor & Destructor Documentation

RelativePosition::RelativePosition ( )

Definition at line 67 of file KDChartRelativePosition.cpp.

RelativePosition::RelativePosition ( const RelativePosition & r )

Definition at line 73 of file KDChartRelativePosition.cpp.

RelativePosition::~RelativePosition ( )

Definition at line 85 of file KDChartRelativePosition.cpp.

Member Function Documentation

Qt::Alignment RelativePosition::alignment ( ) const

Definition at line 127 of file KDChartRelativePosition.cpp.

References d.

Referenced by operator<<(), and operator==().

const QPointF RelativePosition::calculatedPoint ( const QSizeF & autoSize ) const

Calculate a point, according to the reference area/position and horiz/vert padding.

This method is called at drawing time: The returned point is used as anchor point. Note that calculatedPoint ignores the alignment setting, it just returns the point, so the calling code needs to take alignment into account explicitly.

See also:: referencePoint, setReferenceArea, setReferencePosition, setHorizontalPadding, setVerticalPadding

Definition at line 187 of file KDChartRelativePosition.cpp.

References KDChart::Measure::calculatedValue(), horizontalPadding(), KDChartEnums::MeasureOrientationHorizontal, KDChartEnums::MeasureOrientationVertical, referencePoint(), and verticalPadding().

Measure RelativePosition::horizontalPadding ( ) const

Definition at line 135 of file KDChartRelativePosition.cpp.

References d.

Referenced by calculatedPoint(), operator<<(), and operator==().

bool KDChart::RelativePosition::operator!= ( const RelativePosition & other ) const

Definition at line 203 of file KDChartRelativePosition.h.

References operator==().

RelativePosition & RelativePosition::operator= ( const RelativePosition & other )

Definition at line 79 of file KDChartRelativePosition.cpp.

bool RelativePosition::operator== ( const RelativePosition & r ) const

Definition at line 206 of file KDChartRelativePosition.cpp.

References alignment(), d, horizontalPadding(), referenceArea(), referencePosition(), rotation(), and verticalPadding().

Referenced by operator!=().

QObject * RelativePosition::referenceArea ( ) const

Definition at line 98 of file KDChartRelativePosition.cpp.

References d.

Referenced by operator<<(), and operator==().

const QPointF RelativePosition::referencePoint ( qreal * polarDegrees = 0 ) const

Return the reference point, according to the reference area/position, but ignoring horiz/vert padding.

This method is called at drawing time. The returned point is used to test if the label of a data value is to be printed: labels are printed only, if their reference points are either inside or touching the coordinate plane.

If polarDegrees is set, the degree information will be returned that was stored for the respective point. This is used by the PieDiagram class to determin how vertical/horizontal padding settings should affect the position of the data value texts' reference points.

See also:: calculatedPoint, setReferenceArea, setReferencePosition, setHorizontalPadding, setVerticalPadding

Definition at line 156 of file KDChartRelativePosition.cpp.

References d.

Referenced by calculatedPoint().

const PositionPoints RelativePosition::referencePoints ( ) const

Definition at line 107 of file KDChartRelativePosition.cpp.

References d.

Position RelativePosition::referencePosition ( ) const

Definition at line 119 of file KDChartRelativePosition.cpp.

References d.

Referenced by operator<<(), and operator==().

void RelativePosition::resetReferencePosition ( )

Resets the position of the anchor point to the built-in default.

If the anchor point of a RelativePosition is reset (or never changed from the default setting, resp.) KD Chart will choose an appropriate Position at run-time.

e.g. BarDiagrams will use Position::NorthWest / Position::SouthEast for positive / negative values.

See also:: setReferencePosition, setReferenceArea, setAlignment, setHorizontalPadding, setVerticalPadding, KDChart::Position

Definition at line 115 of file KDChartRelativePosition.cpp.

References d, and KDChart::Position::Unknown.

qreal RelativePosition::rotation ( ) const

Definition at line 151 of file KDChartRelativePosition.cpp.

References d.

Referenced by operator<<(), and operator==().

void RelativePosition::setAlignment ( Qt::Alignment flags )

Specifies the location of the content, that is to be positioned by this RelativePosition.

Aligning is applied, after horiz./vert. padding was retrieved to calculate the real reference point, so aligning is seen as relative to that point.

Note:: When printing data value texts at a centered point you might want to call setAlignment( Qt::AlignCenter ) and also set the horizontal/vertical padding to Zero to have your texts centered more precisely.

See also:: setReferencePosition, setReferenceArea, setHorizontalPadding, setVerticalPadding

Definition at line 123 of file KDChartRelativePosition.cpp.

References d.

void RelativePosition::setHorizontalPadding ( const Measure & padding )

Specifies the horizontal width of the gap between the anchor point and the content, that is to be positioned by this RelativePosition.

Note:: When printing data value texts this Measure is used to find the alignment point to align the text to, then alignment() is looked at to determine the way how the text is to be aligned to that point. The font height is used as reference size for both, horizontal and vertical padding, if the respective padding's Measure is using automatic reference area detection.

See also:: setVerticalPadding, setReferencePosition, setReferenceArea

Definition at line 131 of file KDChartRelativePosition.cpp.

References d.

void RelativePosition::setReferenceArea ( QObject * area )

Specifies the reference area to be used to find the anchor point.

The reference area's type can be either QWidget, or be derived from KDChart::AbstractArea.

Note:: Usage of reference area and reference points works mutually exclusively: Only one setting can be valid, so any former specification of reference points is reset when you call setReferenceArea.

Also note: In a few cases KD Chart will ignore your area (or points, resp.) settings! Relative positioning of data value texts is an example: For these the reference area is the respective data area taking precendence over your settings.

See also:: setReferencePosition, setAlignment, setHorizontalPadding, setVerticalPadding

Definition at line 92 of file KDChartRelativePosition.cpp.

References d, and setReferencePoints().

Referenced by setReferencePoints().

void RelativePosition::setReferencePoints ( const PositionPoints & points )

Specifies a set of points from which the anchor point will be selected.

Note:: Usage of reference area and reference points works mutually exclusively: Only one setting can be valid, so any former specification of reference area is reset when you call setReferencePoints.

Also note: In a few cases KD Chart will ignore your points (or area, resp.) settings! Relative positioning of data value texts is an example: For these the reference area is the respective data area taking precendence over your settings.

See also:: setReferenceArea, setReferencePosition, setAlignment, setHorizontalPadding, setVerticalPadding

Definition at line 102 of file KDChartRelativePosition.cpp.

References d, KDChart::PositionPoints::isNull(), and setReferenceArea().

Referenced by setReferenceArea().

void RelativePosition::setReferencePosition ( Position position )

Specifies the position of the anchor point.

The anchor point of a RelativePosition may be one of the pre-defined points of it's reference area - for details see KDChart::Position.

See also:: resetReferencePosition, setReferenceArea, setAlignment, setHorizontalPadding, setVerticalPadding, KDChart::Position

Definition at line 111 of file KDChartRelativePosition.cpp.

References d.

void RelativePosition::setRotation ( qreal rot )

Definition at line 147 of file KDChartRelativePosition.cpp.

References d.

void RelativePosition::setVerticalPadding ( const Measure & padding )

Specifies the vertical width of the gap between the anchor point and the content, that is to be positioned by this RelativePosition.

Note:: When printing data value texts this Measure is used to find the alignment point to align the text to, then alignment() is looked at to determine the way how the text is to be aligned to that point. The font height is used as reference size for both, horizontal and vertical padding, if the respective padding's Measure is using automatic reference area detection.

See also:: setHorizontalPadding, setReferencePosition, setReferenceArea

Definition at line 139 of file KDChartRelativePosition.cpp.

References d.

Measure RelativePosition::verticalPadding ( ) const

Definition at line 143 of file KDChartRelativePosition.cpp.

References d.

Referenced by calculatedPoint(), operator<<(), and operator==().

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

KDChart::RelativePosition Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation