YMultiProgressMeter Class Reference

#include <YMultiProgressMeter.h>

Inheritance diagram for YMultiProgressMeter:

List of all members.

Public Types
typedef long long	Value_t
Public Member Functions
	YMultiProgressMeter (const YWidgetOpt &opt, bool horizontal, const YCPList &maxValues)
virtual char *	widgetClass ()
YCPValue	changeWidget (const YCPSymbol &property, const YCPValue &newValue)
YCPValue	queryWidget (const YCPSymbol &property)
int	segments () const
Value_t	maxValue (int segment) const
Value_t	currentValue (int segment) const
void	setCurrentValue (int segment, Value_t value)
bool	horizontal () const
bool	vertical () const
Protected Member Functions
virtual void	doUpdate ()=0
Private Attributes
bool	_horizontal
std::vector< Value_t >	_maxValues
std::vector< Value_t >	_currentValues

---

Detailed Description

Implementation of the VMultiProgressMeter and HMultiProgressMeter widgets

---

Member Typedef Documentation

typedef long long YMultiProgressMeter::Value_t

---

Constructor & Destructor Documentation

YMultiProgressMeter::YMultiProgressMeter	(	const YWidgetOpt &	opt,
		bool	horizontal,
		const YCPList &	maxValues
	)

Constructor

---

Member Function Documentation

virtual char* YMultiProgressMeter::widgetClass

(

)

[inline, virtual]

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.

YCPValue YMultiProgressMeter::changeWidget	(	const YCPSymbol &	property,
		const YCPValue &	newValue
	)			[virtual]

Implements the ui command changeWidget.

Reimplemented from YWidget.

YCPValue YMultiProgressMeter::queryWidget

(

const YCPSymbol &

property

)

[virtual]

Implements the ui command queryWidget

Reimplemented from YWidget.

int YMultiProgressMeter::segments

(

)

const [inline]

Returns the number of segments

YMultiProgressMeter::Value_t YMultiProgressMeter::maxValue

(

int

segment

)

const

Returns the maximum value for the specified segment (counting from 0)

YMultiProgressMeter::Value_t YMultiProgressMeter::currentValue

(

int

segment

)

const

Returns the current value for the specified segment (counting from 0). If no value has been set yet, -1 is returned.

void YMultiProgressMeter::setCurrentValue	(	int	segment,
		Value_t	value
	)

Sets the current value for the specified segment. This must be in the range 0..maxValue( segment ).

bool YMultiProgressMeter::horizontal

(

)

const [inline]

Returns 'true' if the orientation is horizontal.

bool YMultiProgressMeter::vertical

(

)

const [inline]

Returns 'true' if the orientation is vertical.

virtual void YMultiProgressMeter::doUpdate

(

)

[protected, pure virtual]

Notification that values have been updated and the widget needs to be redisplayed. Derived classes need to reimplement this.

---

Member Data Documentation

bool YMultiProgressMeter::_horizontal [private]

std::vector<Value_t> YMultiProgressMeter::_maxValues [private]

std::vector<Value_t> YMultiProgressMeter::_currentValues [private]

---

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

• YMultiProgressMeter.h
• YMultiProgressMeter.cc

---