libyui
 
Loading...
Searching...
No Matches
YBarGraphSegment Class Reference

#include <YBarGraph.h>

Public Member Functions

 YBarGraphSegment (int value=0, const std::string &label=std::string(), const YColor &segmentColor=YColor(), const YColor &textColor=YColor())
 
int value () const
 
void setValue (int newValue)
 
std::string label () const
 
void setLabel (const std::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

One segment of a YBarGraph. It has a relative size, a label, label color and background color.

Constructor & Destructor Documentation

◆ YBarGraphSegment()

YBarGraphSegment::YBarGraphSegment ( int value = 0,
const std::string & label = std::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.

Member Function Documentation

◆ hasSegmentColor()

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.

◆ hasTextColor()

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.

◆ label()

std::string YBarGraphSegment::label ( ) const
inline

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

◆ segmentColor()

YColor YBarGraphSegment::segmentColor ( ) const
inline

Return the segment background color.

◆ setLabel()

void YBarGraphSegment::setLabel ( const std::string & newLabel)
inline

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

◆ setSegmentColor()

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

Set this segment's background color.

◆ setTextColor()

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

Set this segment's text color.

◆ setValue()

void YBarGraphSegment::setValue ( int newValue)
inline

Set the value of this segment.

◆ textColor()

YColor YBarGraphSegment::textColor ( ) const
inline

Return this segment's text color.

◆ value()

int YBarGraphSegment::value ( ) const
inline

Return the current value of this segment.


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