Legend defines the interface for the legend drawing class. More...

#include <KDChartLegend.h>

Inheritance diagram for KDChart::Legend:

Collaboration diagram for KDChart::Legend:

Public Types
enum	LegendStyle { MarkersOnly = 0, LinesOnly = 1, MarkersAndLines = 2 }
Signals
void	destroyedLegend (Legend *)
void	positionChanged (AbstractAreaWidget *)
void	propertiesChanged ()
	Emitted upon change of a property of the Legend or any of its components.
Public Member Functions
void	addDiagram (KDChart::AbstractDiagram *newDiagram)
	Add the given diagram to the legend.
Qt::Alignment	alignment () const
	Returns the alignment of a non-floating legend.
void	alignToReferencePoint (const RelativePosition &position)
BackgroundAttributes	backgroundAttributes () const
QBrush	brush (uint dataset) const
const QMap< uint, QBrush >	brushes () const
virtual Legend *	clone () const
	Creates an exact copy of this legend.
bool	compare (const AbstractAreaBase *other) const
	Returns true if both areas have the same settings.
bool	compare (const Legend *other) const
	Returns true if both legends have the same settings.
ConstDiagramList	constDiagrams () const
uint	datasetCount () const
bool	datasetIsHidden (uint dataset) const
uint	dataSetOffset (KDChart::AbstractDiagram *diagram)
	Returns the offset of the first dataset of `diagram`.
KDChart::AbstractDiagram *	diagram () const
	The first diagram of the legend or 0 if there was none added to the legend.
DiagramList	diagrams () const
	The list of all diagrams associated with the legend.
const RelativePosition	floatingPosition () const
	Returns the position of a floating legend.
virtual void	forceRebuild ()
	Call this to trigger an unconditional re-building of the widget's internals.
FrameAttributes	frameAttributes () const
void	getFrameLeadings (int &left, int &top, int &right, int &bottom) const
const QList< uint >	hiddenDatasets () const
	Legend (KDChart::AbstractDiagram diagram, QWidget parent)
	Legend (QWidget *parent=0)
LegendStyle	legendStyle () const
MarkerAttributes	markerAttributes (uint dataset) const
const QMap< uint, MarkerAttributes >	markerAttributes () const
virtual QSize	minimumSizeHint () const
virtual void	needSizeHint ()
	Call this to trigger an conditional re-building of the widget's internals.
Qt::Orientation	orientation () const
virtual void	paint (QPainter *painter)
	Overwrite this to paint the inner contents of your widget.
void	paintAll (QPainter &painter)
	Call paintAll, if you want the background and the frame to be drawn before the normal paint() is invoked automatically.
virtual void	paintBackground (QPainter &painter, const QRect &rectangle)
virtual void	paintEvent (QPaintEvent *event)
	Draws the background and frame, then calls paint().
virtual void	paintFrame (QPainter &painter, const QRect &rectangle)
virtual void	paintIntoRect (QPainter &painter, const QRect &rect)
	Draws the background and frame, then calls paint().
QPen	pen (uint dataset) const
const QMap< uint, QPen >	pens () const
Position	position () const
	Returns the position of a non-floating legend.
const QWidget *	referenceArea () const
	Returns the reference area, that is used for font size of title text, and for font size of the item texts, IF automatic area detection is set.
void	removeDiagram (KDChart::AbstractDiagram *oldDiagram)
	Removes the diagram from the legend's list of diagrams.
void	removeDiagrams ()
	Removes all of the diagram from the legend's list of diagrams.
void	replaceDiagram (KDChart::AbstractDiagram newDiagram, KDChart::AbstractDiagram oldDiagram=0)
	Replaces the old diagram, or appends the new diagram, it there is none yet.
void	resetTexts ()
	Removes all legend texts that might have been set by setText.
virtual void	resizeEvent (QResizeEvent *event)
virtual void	resizeLayout (const QSize &size)
void	setAlignment (Qt::Alignment)
	Specify the alignment of a non-floating legend.
void	setBackgroundAttributes (const BackgroundAttributes &a)
void	setBrush (uint dataset, const QBrush &brush)
void	setBrushesFromDiagram (KDChart::AbstractDiagram *diagram)
void	setColor (uint dataset, const QColor &color)
	Note: there is no color() getter method, since setColor just sets a QBrush with the respective color, so the brush() getter method is sufficient.
void	setDatasetHidden (uint dataset, bool hidden)
void	setDefaultColors ()
void	setDiagram (KDChart::AbstractDiagram *newDiagram)
	A convenience method doing the same as replaceDiagram( newDiagram, 0 );.
void	setFloatingPosition (const RelativePosition &relativePosition)
	Specify the position and alignment of a floating legend.
void	setFrameAttributes (const FrameAttributes &a)
void	setHiddenDatasets (const QList< uint > hiddenDatasets)
	Sets a list of datasets that are to be hidden in the legend.
void	setLegendStyle (LegendStyle style)
void	setMarkerAttributes (uint dataset, const MarkerAttributes &)
	Note that any sizes specified via setMarkerAttributes are ignored, unless you disable the automatic size calculation, by saying setUseAutomaticMarkerSize( false ).
void	setOrientation (Qt::Orientation orientation)
void	setPen (uint dataset, const QPen &pen)
void	setPosition (Position position)
	Specify the position of a non-floating legend.
void	setRainbowColors ()
void	setReferenceArea (const QWidget *area)
	Specifies the reference area for font size of title text, and for font size of the item texts, IF automatic area detection is set.
void	setShowLines (bool legendShowLines)
void	setSortOrder (Qt::SortOrder order)
void	setSpacing (uint space)
void	setSubduedColors (bool ordered=false)
void	setText (uint dataset, const QString &text)
void	setTextAlignment (Qt::Alignment)
	Specify the alignment of the text elements within the legend.
void	setTextAttributes (const TextAttributes &a)
void	setTitleText (const QString &text)
void	setTitleTextAttributes (const TextAttributes &a)
void	setUseAutomaticMarkerSize (bool useAutomaticMarkerSize)
	This option is on by default, it means that Marker sizes in the Legend will be the same as the font height used for their respective label texts.
virtual void	setVisible (bool visible)
bool	showLines () const
virtual QSize	sizeHint () const
Qt::SortOrder	sortOrder () const
uint	spacing () const
QString	text (uint dataset) const
Qt::Alignment	textAlignment () const
	Returns the alignment used while rendering text elements within the legend.
TextAttributes	textAttributes () const
const QMap< uint, QString >	texts () const
QString	titleText () const
TextAttributes	titleTextAttributes () const
bool	useAutomaticMarkerSize () const
virtual	~Legend ()
Static Public Member Functions
static void	paintBackgroundAttributes (QPainter &painter, const QRect &rectangle, const KDChart::BackgroundAttributes &attributes)
static void	paintFrameAttributes (QPainter &painter, const QRect &rectangle, const KDChart::FrameAttributes &attributes)
Protected Member Functions
virtual QRect	areaGeometry () const
QRect	innerRect () const
virtual void	positionHasChanged ()

Detailed Description

Legend defines the interface for the legend drawing class.

Legend is the class for drawing legends for all kinds of diagrams ("chart types").

Legend is drawn on chart level, not per diagram, but you can have more than one legend per chart, using KDChart::Chart::addLegend().

Note:: Legend is different from all other classes ofd KD Chart, since it can be displayed outside of the Chart's area. If you want to, you can embedd the legend into your own widget, or into another part of a bigger grid, into which you might have inserted the Chart.

On the other hand, please note that you MUST call Chart::addLegend to get your legend positioned into the correct place of your chart - if you want to have the legend shown inside of the chart (that's probably true for most cases).

Definition at line 55 of file KDChartLegend.h.

Member Enumeration Documentation

enum KDChart::Legend::LegendStyle

Enumerator:

MarkersOnly
LinesOnly
MarkersAndLines

Definition at line 68 of file KDChartLegend.h.

Constructor & Destructor Documentation

Legend::Legend ( QWidget * parent = 0 ) [explicit]

Definition at line 84 of file KDChartLegend.cpp.

References d.

Referenced by clone().

Legend::Legend	(	KDChart::AbstractDiagram *	diagram,
		QWidget *	parent
	)			`[explicit]`

Definition at line 91 of file KDChartLegend.cpp.

References d, and setDiagram().

Legend::~Legend ( ) [virtual]

Definition at line 99 of file KDChartLegend.cpp.

References destroyedLegend().

Member Function Documentation

void Legend::addDiagram ( KDChart::AbstractDiagram * newDiagram )

Add the given diagram to the legend.

Parameters:

newDiagram

The diagram to add.

See also:: diagram, diagrams, removeDiagram, removeDiagrams, replaceDiagram, setDiagram

Definition at line 339 of file KDChartLegend.cpp.

References d.

Referenced by replaceDiagram().

Qt::Alignment Legend::alignment ( ) const

Returns the alignment of a non-floating legend.

See also:: setAlignment

Definition at line 491 of file KDChartLegend.cpp.

References d.

Referenced by clone(), and compare().

void AbstractAreaBase::alignToReferencePoint ( const RelativePosition & position ) [inherited]

Definition at line 88 of file KDChartAbstractAreaBase.cpp.

QRect AbstractAreaWidget::areaGeometry ( ) const [protected, virtual, inherited]

Implements KDChart::AbstractAreaBase.

Definition at line 183 of file KDChartAbstractAreaWidget.cpp.

BackgroundAttributes AbstractAreaBase::backgroundAttributes ( ) const [inherited]

Definition at line 118 of file KDChartAbstractAreaBase.cpp.

References d.

Referenced by KDChart::AbstractAreaBase::compare(), and updateCommonBrush().

QBrush Legend::brush ( uint dataset ) const

Definition at line 624 of file KDChartLegend.cpp.

References d.

Referenced by setRainbowColors().

const QMap< uint, QBrush > Legend::brushes ( ) const

Definition at line 632 of file KDChartLegend.cpp.

References d.

Referenced by compare().

Legend * Legend::clone ( ) const [virtual]

Creates an exact copy of this legend.

Definition at line 203 of file KDChartLegend.cpp.

References alignment(), d, KDChart::AbstractAreaBase::frameAttributes(), Legend(), legendStyle(), position(), setAlignment(), KDChart::AbstractAreaBase::setFrameAttributes(), setLegendStyle(), setPosition(), setTextAlignment(), setTextAttributes(), setTitleTextAttributes(), setUseAutomaticMarkerSize(), textAlignment(), textAttributes(), titleTextAttributes(), and useAutomaticMarkerSize().

bool AbstractAreaBase::compare ( const AbstractAreaBase * other ) const [inherited]

Returns true if both areas have the same settings.

Definition at line 73 of file KDChartAbstractAreaBase.cpp.

References KDChart::AbstractAreaBase::backgroundAttributes(), and KDChart::AbstractAreaBase::frameAttributes().

bool Legend::compare ( const Legend * other ) const

Returns true if both legends have the same settings.

Definition at line 218 of file KDChartLegend.cpp.

References alignment(), brushes(), floatingPosition(), legendStyle(), markerAttributes(), orientation(), pens(), position(), showLines(), spacing(), textAlignment(), textAttributes(), texts(), titleText(), titleTextAttributes(), and useAutomaticMarkerSize().

ConstDiagramList Legend::constDiagrams ( ) const

Returns:: The list of diagrams associated with this coordinate plane.

Definition at line 331 of file KDChartLegend.cpp.

References d.

uint Legend::datasetCount ( ) const

Definition at line 288 of file KDChartLegend.cpp.

References d, KDChart::AbstractDiagram::datasetBrushes(), KDChart::AbstractDiagram::datasetLabels(), and KDChart::DiagramObserver::diagram().

bool Legend::datasetIsHidden ( uint dataset ) const

Definition at line 1139 of file KDChartLegend.cpp.

References d.

uint Legend::dataSetOffset ( KDChart::AbstractDiagram * diagram )

Returns the offset of the first dataset of diagram.

Definition at line 418 of file KDChartLegend.cpp.

References d.

void KDChart::Legend::destroyedLegend ( Legend * ) [signal]

Referenced by ~Legend().

AbstractDiagram * Legend::diagram ( ) const

The first diagram of the legend or 0 if there was none added to the legend.

Returns:: The first diagram of the legend or 0.

See also:: diagrams, addDiagram, removeDiagram, removeDiagrams, replaceDiagram, setDiagram

Definition at line 316 of file KDChartLegend.cpp.

References d.

Referenced by paint().

DiagramList Legend::diagrams ( ) const

The list of all diagrams associated with the legend.

Returns:: The list of all diagrams associated with the legend.

See also:: diagram, addDiagram, removeDiagram, removeDiagrams, replaceDiagram, setDiagram

Definition at line 323 of file KDChartLegend.cpp.

References d.

Referenced by removeDiagram().

const RelativePosition Legend::floatingPosition ( ) const

Returns the position of a floating legend.

See also:: setFloatingPosition

Definition at line 518 of file KDChartLegend.cpp.

References d.

Referenced by compare(), and KDChart::Chart::reLayoutFloatingLegends().

void Legend::forceRebuild ( ) [virtual]

Call this to trigger an unconditional re-building of the widget's internals.

Reimplemented from KDChart::AbstractAreaWidget.

Definition at line 736 of file KDChartLegend.cpp.

Referenced by resizeEvent().

FrameAttributes AbstractAreaBase::frameAttributes ( ) const [inherited]

Definition at line 104 of file KDChartAbstractAreaBase.cpp.

References d.

Referenced by clone(), KDChart::AbstractAreaBase::compare(), and updateCommonBrush().

void AbstractAreaBase::getFrameLeadings	(	int &	left,
		int &	top,
		int &	right,
		int &	bottom
	)			const `[inherited]`

Definition at line 210 of file KDChartAbstractAreaBase.cpp.

References d.

Referenced by KDChart::AbstractAreaBase::innerRect(), and KDChart::AbstractAreaWidget::paintAll().

const QList< uint > Legend::hiddenDatasets ( ) const

Definition at line 1126 of file KDChartLegend.cpp.

References d.

QRect AbstractAreaBase::innerRect ( ) const [protected, inherited]

Definition at line 226 of file KDChartAbstractAreaBase.cpp.

References KDChart::AbstractAreaBase::areaGeometry(), and KDChart::AbstractAreaBase::getFrameLeadings().

Referenced by KDChart::TextArea::paintAll(), and KDChart::AbstractArea::paintAll().

Legend::LegendStyle Legend::legendStyle ( ) const

Definition at line 195 of file KDChartLegend.cpp.

References d.

Referenced by clone(), and compare().

MarkerAttributes Legend::markerAttributes ( uint dataset ) const

Definition at line 685 of file KDChartLegend.cpp.

References d.

Referenced by compare().

const QMap< uint, MarkerAttributes > Legend::markerAttributes ( ) const

Definition at line 694 of file KDChartLegend.cpp.

References d.

Referenced by compare().

QSize Legend::minimumSizeHint ( ) const [virtual]

Definition at line 142 of file KDChartLegend.cpp.

References sizeHint().

void Legend::needSizeHint ( ) [virtual]

Call this to trigger an conditional re-building of the widget's internals.

e.g. AbstractAreaWidget call this, before calling layout()->setGeometry()

Reimplemented from KDChart::AbstractAreaWidget.

Definition at line 160 of file KDChartLegend.cpp.

Qt::Orientation Legend::orientation ( ) const

Definition at line 531 of file KDChartLegend.cpp.

References d.

Referenced by compare().

void Legend::paint ( QPainter * painter ) [virtual]

Overwrite this to paint the inner contents of your widget.

Note:: When overriding this method, please let your widget draw itself at the top/left corner of the painter. You should call rect() (or width(), height(), resp.) to find the drawable area's size: While the paint() method is being executed the frame of the widget is outside of its rect(), so you can use all of rect() for your custom drawing!

See also:: paint, paintIntoRect

Implements KDChart::AbstractAreaWidget.

Definition at line 266 of file KDChartLegend.cpp.

References d, diagram(), and KDChart::AbstractLayoutItem::paint().

void AbstractAreaWidget::paintAll ( QPainter & painter ) [inherited]

Call paintAll, if you want the background and the frame to be drawn before the normal paint() is invoked automatically.

Definition at line 142 of file KDChartAbstractAreaWidget.cpp.

References KDChart::AbstractAreaBase::getFrameLeadings(), KDChart::AbstractAreaWidget::paint(), KDChart::AbstractAreaBase::paintBackground(), and KDChart::AbstractAreaBase::paintFrame().

Referenced by KDChart::AbstractAreaWidget::paintEvent(), and KDChart::AbstractAreaWidget::paintIntoRect().

void AbstractAreaBase::paintBackground	(	QPainter &	painter,
		const QRect &	rectangle
	)			`[virtual, inherited]`

Definition at line 194 of file KDChartAbstractAreaBase.cpp.

References d, and KDChart::AbstractAreaBase::paintBackgroundAttributes().

Referenced by KDChart::TextArea::paintAll(), KDChart::AbstractAreaWidget::paintAll(), and KDChart::AbstractArea::paintAll().

void AbstractAreaBase::paintBackgroundAttributes	(	QPainter &	painter,
		const QRect &	rectangle,
		const KDChart::BackgroundAttributes &	attributes
	)			`[static, inherited]`

Definition at line 125 of file KDChartAbstractAreaBase.cpp.

References KDChart::BackgroundAttributes::BackgroundPixmapModeCentered, KDChart::BackgroundAttributes::BackgroundPixmapModeScaled, KDChart::BackgroundAttributes::BackgroundPixmapModeStretched, KDChart::BackgroundAttributes::brush(), KDChart::BackgroundAttributes::isVisible(), KDChart::BackgroundAttributes::pixmap(), and KDChart::BackgroundAttributes::pixmapMode().

Referenced by KDChart::AbstractAreaBase::paintBackground().

void AbstractAreaWidget::paintEvent ( QPaintEvent * event ) [virtual, inherited]

Draws the background and frame, then calls paint().

In most cases there is no need to overwrite this method in a derived class, but you would overwrite paint() instead.

See also:: paint

Definition at line 96 of file KDChartAbstractAreaWidget.cpp.

References d, and KDChart::AbstractAreaWidget::paintAll().

void AbstractAreaBase::paintFrame	(	QPainter &	painter,
		const QRect &	rectangle
	)			`[virtual, inherited]`

Definition at line 202 of file KDChartAbstractAreaBase.cpp.

References d, and KDChart::AbstractAreaBase::paintFrameAttributes().

Referenced by KDChart::TextArea::paintAll(), KDChart::AbstractAreaWidget::paintAll(), and KDChart::AbstractArea::paintAll().

void AbstractAreaBase::paintFrameAttributes	(	QPainter &	painter,
		const QRect &	rectangle,
		const KDChart::FrameAttributes &	attributes
	)			`[static, inherited]`

Definition at line 175 of file KDChartAbstractAreaBase.cpp.

References KDChart::FrameAttributes::isVisible(), KDChart::FrameAttributes::pen(), and KDChart::PrintingParameters::scalePen().

Referenced by KDChart::AbstractAreaBase::paintFrame().

void AbstractAreaWidget::paintIntoRect	(	QPainter &	painter,
		const QRect &	rect
	)			`[virtual, inherited]`

Draws the background and frame, then calls paint().

In most cases there is no need to overwrite this method in a derived class, but you would overwrite paint() instead.

Definition at line 106 of file KDChartAbstractAreaWidget.cpp.

References d, and KDChart::AbstractAreaWidget::paintAll().

Referenced by KDChart::Chart::paint().

QPen Legend::pen ( uint dataset ) const

Definition at line 663 of file KDChartLegend.cpp.

References d.

const QMap< uint, QPen > Legend::pens ( ) const

Definition at line 671 of file KDChartLegend.cpp.

References d.

Referenced by compare().

Position Legend::position ( ) const

Returns the position of a non-floating legend.

See also:: setPosition

Definition at line 478 of file KDChartLegend.cpp.

References d.

Referenced by clone(), compare(), and KDChart::Chart::reLayoutFloatingLegends().

void KDChart::AbstractAreaWidget::positionChanged ( AbstractAreaWidget * ) [signal, inherited]

Referenced by KDChart::AbstractAreaWidget::positionHasChanged().

void AbstractAreaWidget::positionHasChanged ( ) [protected, virtual, inherited]

Reimplemented from KDChart::AbstractAreaBase.

Definition at line 188 of file KDChartAbstractAreaWidget.cpp.

References KDChart::AbstractAreaWidget::positionChanged().

void KDChart::Legend::propertiesChanged ( ) [signal]

Emitted upon change of a property of the Legend or any of its components.

const QWidget * Legend::referenceArea ( ) const

Returns the reference area, that is used for font size of title text, and for font size of the item texts, IF automatic area detection is set.

See also:: setReferenceArea

Definition at line 309 of file KDChartLegend.cpp.

References d.

void Legend::removeDiagram ( KDChart::AbstractDiagram * oldDiagram )

Removes the diagram from the legend's list of diagrams.

See also:: diagram, diagrams, addDiagram, removeDiagrams, replaceDiagram, setDiagram

Definition at line 364 of file KDChartLegend.cpp.

References d, KDChart::AbstractDiagram::datasetBrushes(), KDChart::AbstractDiagram::datasetPens(), and diagrams().

Referenced by removeDiagrams(), and replaceDiagram().

void Legend::removeDiagrams ( )

Removes all of the diagram from the legend's list of diagrams.

See also:: diagram, diagrams, addDiagram, removeDiagram, replaceDiagram, setDiagram

Definition at line 397 of file KDChartLegend.cpp.

References d, and removeDiagram().

void Legend::replaceDiagram	(	KDChart::AbstractDiagram *	newDiagram,
		KDChart::AbstractDiagram *	oldDiagram = `0`
	)

Replaces the old diagram, or appends the new diagram, it there is none yet.

Parameters:

	newDiagram	The diagram to be used instead of the old one. If this parameter is zero, the first diagram will just be removed.
	oldDiagram	The diagram to be removed by the new one. This diagram will be deleted automatically. If the parameter is omitted, the very first diagram will be replaced. In case, there was no diagram yet, the new diagram will just be added.

See also:: diagram, diagrams, addDiagram, removeDiagram, removeDiagrams, setDiagram

Definition at line 403 of file KDChartLegend.cpp.

References addDiagram(), d, and removeDiagram().

Referenced by setDiagram().

void Legend::resetTexts ( )

Removes all legend texts that might have been set by setText.

This resets the Legend to default behaviour: Texts are created automatically.

Definition at line 580 of file KDChartLegend.cpp.

References d.

void Legend::resizeEvent ( QResizeEvent * event ) [virtual]

Definition at line 839 of file KDChartLegend.cpp.

References forceRebuild(), and sizeHint().

void Legend::resizeLayout ( const QSize & size ) [virtual]

Reimplemented from KDChart::AbstractAreaWidget.

Definition at line 167 of file KDChartLegend.cpp.

References d.

void Legend::setAlignment ( Qt::Alignment alignment )

Specify the alignment of a non-floating legend.

Use setFloatingPosition to set position and alignment if your legend is floating.

See also:: alignment, setPosition, setFloatingPosition

Definition at line 483 of file KDChartLegend.cpp.

References d.

Referenced by clone().

void AbstractAreaBase::setBackgroundAttributes ( const BackgroundAttributes & a ) [inherited]

Definition at line 109 of file KDChartAbstractAreaBase.cpp.

References d, and KDChart::AbstractAreaBase::positionHasChanged().

void Legend::setBrush	(	uint	dataset,
		const QBrush &	brush
	)

Definition at line 616 of file KDChartLegend.cpp.

References d.

void Legend::setBrushesFromDiagram ( KDChart::AbstractDiagram * diagram )

Definition at line 638 of file KDChartLegend.cpp.

References d, and KDChart::AbstractDiagram::datasetBrushes().

void Legend::setColor	(	uint	dataset,
		const QColor &	color
	)

Note: there is no color() getter method, since setColor just sets a QBrush with the respective color, so the brush() getter method is sufficient.

Definition at line 608 of file KDChartLegend.cpp.

References d.

Referenced by setDefaultColors(), setRainbowColors(), and setSubduedColors().

void Legend::setDatasetHidden	(	uint	dataset,
		bool	hidden
	)

Definition at line 1131 of file KDChartLegend.cpp.

References d.

void Legend::setDefaultColors ( )

Definition at line 761 of file KDChartLegend.cpp.

References setColor().

void Legend::setDiagram ( KDChart::AbstractDiagram * newDiagram )

A convenience method doing the same as replaceDiagram( newDiagram, 0 );.

Replaces the first diagram by the given diagram. If the legend's list of diagram is empty the given diagram is added to the list.

See also:: diagram, diagrams, addDiagram, removeDiagram, removeDiagrams, replaceDiagram

Definition at line 437 of file KDChartLegend.cpp.

References replaceDiagram().

Referenced by KDChart::Widget::addLegend(), Legend(), KDChart::Widget::replaceLegend(), and KDChart::Widget::setType().

void Legend::setFloatingPosition ( const RelativePosition & relativePosition )

Specify the position and alignment of a floating legend.

Use setPosition and setAlignment to set position and alignment if your legend is non-floating.

Note:: When setFloatingPosition is called, the Legend's position value is set to KDChart::Position::Floating automatically.

If your Chart is pointed to by m_chart, your could have the floating legend aligned exactly to the chart's coordinate plane's top-right corner with the following commands:

KDChart::RelativePosition relativePosition;
relativePosition.setReferenceArea( m_chart->coordinatePlane() );
relativePosition.setReferencePosition( Position::NorthEast );
relativePosition.setAlignment( Qt::AlignTop | Qt::AlignRight );
relativePosition.setHorizontalPadding(
    KDChart::Measure( -1.0, KDChartEnums::MeasureCalculationModeAbsolute ) );
relativePosition.setVerticalPadding(
    KDChart::Measure( 0.0, KDChartEnums::MeasureCalculationModeAbsolute ) );
m_legend->setFloatingPosition( relativePosition );

To have the legend positioned at a fixed point, measured from the QPainter's top left corner, you could use the following code code:

KDChart::RelativePosition relativePosition;
relativePosition.setReferencePoints( PositionPoints( QPointF( 0.0, 0.0 ) ) );
relativePosition.setReferencePosition( Position::NorthWest );
relativePosition.setAlignment( Qt::AlignTop | Qt::AlignLeft );
relativePosition.setHorizontalPadding(
    KDChart::Measure( 4.0, KDChartEnums::MeasureCalculationModeAbsolute ) );
relativePosition.setVerticalPadding(
    KDChart::Measure( 4.0, KDChartEnums::MeasureCalculationModeAbsolute ) );
m_legend->setFloatingPosition( relativePosition );

Actually that's exactly the code KD Chart is using as default position for any floating legends, so if you just say setPosition( KDChart::Position::Floating ) without calling setFloatingPosition your legend will be positioned at point 4/4.

See also:: setPosition, setAlignment

Definition at line 509 of file KDChartLegend.cpp.

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

void AbstractAreaBase::setFrameAttributes ( const FrameAttributes & a ) [inherited]

Definition at line 95 of file KDChartAbstractAreaBase.cpp.

References d, and KDChart::AbstractAreaBase::positionHasChanged().

Referenced by clone().

void Legend::setHiddenDatasets ( const QList< uint > hiddenDatasets )

Sets a list of datasets that are to be hidden in the legend.

By passing an empty list, you show all datasets. Note that by default, all datasets are shown, which means that hiddenDatasets() == QList<uint>()

Definition at line 1121 of file KDChartLegend.cpp.

References d.

void Legend::setLegendStyle ( LegendStyle style )

Definition at line 188 of file KDChartLegend.cpp.

References d.

Referenced by clone().

void Legend::setMarkerAttributes	(	uint	dataset,
		const MarkerAttributes &	markerAttributes
	)

Note that any sizes specified via setMarkerAttributes are ignored, unless you disable the automatic size calculation, by saying setUseAutomaticMarkerSize( false ).

Definition at line 677 of file KDChartLegend.cpp.

References d.

void Legend::setOrientation ( Qt::Orientation orientation )

Definition at line 523 of file KDChartLegend.cpp.

References d.

void Legend::setPen	(	uint	dataset,
		const QPen &	pen
	)

Definition at line 655 of file KDChartLegend.cpp.

References d.

void Legend::setPosition ( Position position )

Specify the position of a non-floating legend.

Use setFloatingPosition to set position and alignment if your legend is floating.

See also:: setAlignment, setFloatingPosition

Definition at line 463 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Widget::addLegend(), and clone().

void Legend::setRainbowColors ( )

Definition at line 777 of file KDChartLegend.cpp.

References brush(), and setColor().

void Legend::setReferenceArea ( const QWidget * area )

Specifies the reference area for font size of title text, and for font size of the item texts, IF automatic area detection is set.

Note:: This parameter is ignored, if the Measure given for setTitleTextAttributes (or setTextAttributes, resp.) is not specifying automatic area detection.

If no reference area is specified, but automatic area detection is set, then the size of the legend's parent widget will be used.

See also:: KDChart::Measure, KDChartEnums::MeasureCalculationMode

Definition at line 302 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Chart::addLegend().

void Legend::setShowLines ( bool legendShowLines )

Definition at line 550 of file KDChartLegend.cpp.

References d.

void Legend::setSortOrder ( Qt::SortOrder order )

Definition at line 536 of file KDChartLegend.cpp.

References d.

void Legend::setSpacing ( uint space )

Definition at line 748 of file KDChartLegend.cpp.

References d.

void Legend::setSubduedColors ( bool ordered = false )

Definition at line 791 of file KDChartLegend.cpp.

References setColor().

void Legend::setText	(	uint	dataset,
		const QString &	text
	)

Definition at line 587 of file KDChartLegend.cpp.

References d.

void Legend::setTextAlignment ( Qt::Alignment alignment )

Specify the alignment of the text elements within the legend.

See also:: textAlignment()

Definition at line 496 of file KDChartLegend.cpp.

References d.

Referenced by clone().

void Legend::setTextAttributes ( const TextAttributes & a )

Definition at line 700 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Chart::addLegend(), and clone().

void Legend::setTitleText ( const QString & text )

Definition at line 712 of file KDChartLegend.cpp.

References d.

void Legend::setTitleTextAttributes ( const TextAttributes & a )

Definition at line 724 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Chart::addLegend(), and clone().

void Legend::setUseAutomaticMarkerSize ( bool useAutomaticMarkerSize )

This option is on by default, it means that Marker sizes in the Legend will be the same as the font height used for their respective label texts.

Set this to false, if you want to specify the marker sizes via setMarkerAttributes or if you want the Legend to use the same marker sizes as they are used in the Diagrams.

Definition at line 563 of file KDChartLegend.cpp.

References d.

Referenced by clone().

void Legend::setVisible ( bool visible ) [virtual]

Definition at line 448 of file KDChartLegend.cpp.

Referenced by KDChart::Chart::addLegend(), and KDChart::Chart::takeLegend().

bool Legend::showLines ( ) const

Definition at line 558 of file KDChartLegend.cpp.

References d.

Referenced by compare().

QSize Legend::sizeHint ( ) const [virtual]

Definition at line 149 of file KDChartLegend.cpp.

References d.

Referenced by minimumSizeHint(), KDChart::Chart::reLayoutFloatingLegends(), and resizeEvent().

Qt::SortOrder Legend::sortOrder ( ) const

Definition at line 545 of file KDChartLegend.cpp.

References d.

uint Legend::spacing ( ) const

Definition at line 756 of file KDChartLegend.cpp.

References d.

Referenced by compare().

QString Legend::text ( uint dataset ) const

Definition at line 594 of file KDChartLegend.cpp.

References d.

Qt::Alignment Legend::textAlignment ( ) const

Returns the alignment used while rendering text elements within the legend.

See also:: setTextAlignment()

Definition at line 504 of file KDChartLegend.cpp.

References d.

Referenced by clone(), and compare().

TextAttributes Legend::textAttributes ( ) const

Definition at line 707 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Chart::addLegend(), clone(), and compare().

const QMap< uint, QString > Legend::texts ( ) const

Definition at line 603 of file KDChartLegend.cpp.

References d.

Referenced by compare().

QString Legend::titleText ( ) const

Definition at line 719 of file KDChartLegend.cpp.

References d.

Referenced by compare().

TextAttributes Legend::titleTextAttributes ( ) const

Definition at line 731 of file KDChartLegend.cpp.

References d.

Referenced by KDChart::Chart::addLegend(), clone(), and compare().

bool Legend::useAutomaticMarkerSize ( ) const

Definition at line 570 of file KDChartLegend.cpp.

References d.

Referenced by clone(), and compare().

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

KDChart::Legend Class Reference

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation