#include <YBarGraph.h>

Public Member Functions
	YBarGraphSegment (int value=0, const string &label=string(), const YColor &segmentColor=YColor(), const YColor &textColor=YColor())
int	value () const
void	setValue (int newValue)
string	label () const
void	setLabel (const string &newLabel)
YColor	segmentColor () const
bool	hasSegmentColor () const
void	setSegmentColor (const YColor &color)
YColor	textColor () const
bool	hasTextColor () const
void	setTextColor (const YColor &color)

Detailed Description

Helper class to describe one segment of a YBarGraph.

Constructor & Destructor Documentation

YBarGraphSegment::YBarGraphSegment	(	int	value = `0`,
		const string &	label = `string()`,
		const YColor &	segmentColor = `YColor()`,
		const YColor &	textColor = `YColor()`
	)		`[inline]`

Constructor.

'value' is the initial value of this segment.

'label' is the label text in the segment. Use 1 as a placeholder for the current value.

'segmentColor' is the background color of this segment.

'textColor' is the color for the label text.

The YBarGraph widget will automatically assign some default colors (one of at least 5 different ones) if none are specified.

bool YBarGraphSegment::hasSegmentColor ( ) const [inline]

Return 'true' if this segment's background color is defined, i.e. it has a real RGB value and was not just created with the default constructor.

bool YBarGraphSegment::hasTextColor ( ) const [inline]

Return 'true' if this segment's text color is defined, i.e. it has a real RGB value and was not just created with the default constructor.

string YBarGraphSegment::label ( ) const [inline]

Return the current text label of this segment. Any 1 placeholder will be returned as 1 (not expanded).

YColor YBarGraphSegment::segmentColor ( ) const [inline]

Return the segment background color.

void YBarGraphSegment::setLabel ( const string & newLabel ) [inline]

Set the text label of this segment. Use 1 as a placeholder for the current value.

void YBarGraphSegment::setSegmentColor ( const YColor & color ) [inline]

Set this segment's background color.

void YBarGraphSegment::setTextColor ( const YColor & color ) [inline]

Set this segment's text color.

void YBarGraphSegment::setValue ( int newValue ) [inline]

Set the value of this segment.

YColor YBarGraphSegment::textColor ( ) const [inline]

Return this segment's text color.

int YBarGraphSegment::value ( ) const [inline]

Return the current value of this segment.

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