Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvPieSliceInfo Class Reference

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

#include <ilviews/charts/pie.h>

Inheritance diagram for IlvPieSliceInfo:
IlvChartDataGraphicInfo IlvChartDataPointInfo

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)
 Initializes a new IlvChartDataGraphicInfo object. 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...
 
IlvGraphicgetGraphic () const
 Returns the stored graphic object. More...
 
const IlvPointgetOffset () 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)
 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)
 Sets the way the drawing member functions operate. More...
 
- Public Member Functions inherited from IlvChartDataPointInfo
 IlvChartDataPointInfo (const IlvChartDataPointInfo &pointInfo)
 Initializes a new IlvChartDataPointInfo object as a copy of another IlvChartDataPointInfo. More...
 
 IlvChartDataPointInfo (IlvInputFile &file)
 Initializes a new IlvChartDataPointInfo object from an input file. More...
 
 IlvChartDataPointInfo (IlvPalette *palette=0)
 Initializes a new IlvChartDataPointInfo object. More...
 
virtual ~IlvChartDataPointInfo ()
 Destructor. More...
 
virtual IlvChartDataPointInfocopy () const
 Creates and returns a copy of the current object. More...
 
IlvPalettegetPalette () 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...
 
IlvOutputFilesave (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 IlvChartDataPointInfoLoad (IlvInputFile &file)
 Reads a point information object from a file. More...
 
static IlvChartDataPointInfoRead (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::IlvPieSliceInfo ( IlBoolean  tornOff,
IlvPalette palette = 0,
IlvGraphic graphic = 0 
)

Constructor.

Initializes a new IlvPieSliceInfo object.

Parameters
tornOffThe new value of the flag indicating whether the slice is torn off.
paletteThe new specific palette that will be used to display the associated slice.
graphicThe 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.

◆ ~IlvPieSliceInfo()

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

◆ getLegendText()

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.

◆ isTornOff()

IlBoolean IlvPieSliceInfo::isTornOff ( ) const

Indicates whether the associated slice is torn off.

Returns
IlTrue if the slice is torn off and IlFalse otherwise.

◆ setLegendText()

void IlvPieSliceInfo::setLegendText ( const char *  legendText)

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

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

◆ setTornOff()

void IlvPieSliceInfo::setTornOff ( IlBoolean  flag)

Specifies whether the associated slice is torn off.

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