IlvPieSliceInfo Class Reference

Class allowing to add specific information to a slice. More...

#include <ilviews/charts/pie.h>

Inheritance diagram for IlvPieSliceInfo:

Public Member Functions
	IlvPieSliceInfo (IlBoolean tornOff, IlvPalette *palette=0, IlvGraphic *graphic=0)
	Constructor. More...
virtual	~IlvPieSliceInfo ()
	Destructor. More...
const char *	getLegendText () const
	Returns the text that will be used in a legend for the associated slice. More...
IlBoolean	isTornOff () const
	Indicates whether the associated slice is torn off. More...
void	setLegendText (const char *legendText)
	Sets the text that will be used in a legend for the associated slice. More...
void	setTornOff (IlBoolean flag)
	Specifies whether the associated slice is torn off. More...
Public Member Functions inherited from IlvChartDataGraphicInfo
	IlvChartDataGraphicInfo (IlvGraphic *graphic, IlvPos dx=0, IlvPos dy=0, IlvPosition anchorPosition=IlvCenter, IlvPalette *palette=0)
	Constructor. More...
virtual	~IlvChartDataGraphicInfo ()
	Destructor. More...
virtual IlBoolean	boundingBox (const IlvPoint &point, const IlvChartDataSet *dataSet, IlUInt ptidx, const IlvChartGraphic *chart, IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the bounding box of the graphical information drawn next to the representation of the data point. More...
virtual void	draw (const IlvPoint &point, const IlvChartDataSet *dataSet, IlUInt ptidx, const IlvChartGraphic *chart, IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Draws some graphical information next to the representation of the data point. More...
IlvPosition	getAnchorPosition () const
	Returns the anchor position of the graphic object. More...
IlvGraphic *	getGraphic () const
	Returns the stored graphic object. More...
const IlvPoint &	getOffset () const
	Returns the offset that is used to draw the graphic object. More...
void	setAnchorPosition (IlvPosition position)
	Sets the anchor position of the graphic object. More...
void	setGraphic (IlvGraphic *graphic)
	Sets the graphic object that is drawn. More...
virtual void	setMode (IlvDrawMode mode)
	Sets the drawing mode. More...
void	setOffset (const IlvPoint &offset)
	Sets the offset that is used to draw the stored graphic object. More...
virtual void	setOverwrite (IlBoolean o)
	Sets the way the drawing member functions operate. More...
Public Member Functions inherited from IlvChartDataPointInfo
	IlvChartDataPointInfo (IlvPalette *palette=0)
	Constructor. More...
	IlvChartDataPointInfo (const IlvChartDataPointInfo &pointInfo)
	Copy Constructor. More...
	IlvChartDataPointInfo (IlvInputFile &file)
	Constructor. More...
virtual	~IlvChartDataPointInfo ()
	Destructor. More...
virtual IlvChartDataPointInfo *	copy () const
	Virtual copy constructor. More...
IlvPalette *	getPalette () const
	Returns the specific palette. More...
virtual IlBoolean	getPalette (const IlvChartDataSet *dataSet, IlUInt idx, const IlvAbstractChartDisplayer *disp, const IlvPalette *defaultPalette, IlvPalette *returnPalette) const
	Gets the specific palette for a point in the same collection. More...
void	lock ()
	Locks the current IlvChartDataPointInfo object. More...
IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...
void	setForeground (IlvColor *color)
	Sets the foreground color for the specific palette. More...
void	setPalette (IlvPalette *pal)
	Sets the specific palette. More...
void	unLock ()
	Unlocks the current IlvChartDataPointInfo object. More...
virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvChartDataPointInfo
static IlvChartDataPointInfo *	Load (IlvInputFile &file)
	Reads a point information object from a file. More...
static IlvChartDataPointInfo *	Read (IlvInputFile &file)
	Reads the attributes of a point information object from a file. More...

Detailed Description

Class allowing to add specific information to a slice.

Library: ilvcharts

This class is a subclass of IlvChartDataGraphicInfo which is used to add specific information to a slice representing a given data point in a pie displayer. The IlvPieSliceInfo class stores a flag indicating whether the slice is torn off and a legend text that will be used in a legend for this slice in addition to the palette and the graphic object that are stored in the base classes.

See Also

IlvChartDataGraphicInfo, IlvPieChartDisplayer.

Constructor & Destructor Documentation

IlvPieSliceInfo::IlvPieSliceInfo	(	IlBoolean	tornOff,
		IlvPalette *	palette = 0,
		IlvGraphic *	graphic = 0
	)

Constructor.

Initializes a new IlvPieSliceInfo object.

Parameters

tornOff	The new value of the flag indicating whether the slice is torn off.
palette	The new specific palette that will be used to display the associated slice.
graphic	The new graphic object that will be drawn in addition to the slice. This graphic object can be used for example to define an annotation for the slice.

virtual IlvPieSliceInfo::~IlvPieSliceInfo ( )

virtual

Destructor.

The destructor deletes the legend text (if any) defined to be used in a legend for the associated slice.

Member Function Documentation

const char* IlvPieSliceInfo::getLegendText

(

)

const

Returns the text that will be used in a legend for the associated slice.

Returns

The text that will be used in a legend for the associated slice.

IlBoolean IlvPieSliceInfo::isTornOff

(

)

const

Indicates whether the associated slice is torn off.

Returns

IlTrue if the slice is torn off and IlFalse otherwise.

void IlvPieSliceInfo::setLegendText

(

const char *

legendText

)

Sets the text that will be used in a legend for the associated slice.

Parameters

legendText

The text that will be used in a legend for the associated slice. The text passed as a parameter is copied.

void IlvPieSliceInfo::setTornOff

(

IlBoolean

flag

)

Specifies whether the associated slice is torn off.

Parameters

flag	The new value of the flag indicating whether the slice is torn off.