YProgressBar Class Reference

Implementation of the ProgressBar widget. More...

#include <YProgressBar.h>

Inheritance diagram for YProgressBar:

List of all members.

Public Member Functions
	YProgressBar (const YWidgetOpt &opt, const YCPString &label, const YCPInteger &maxProgress, const YCPInteger &initialProgress)
virtual char *	widgetClass ()
YCPValue	changeWidget (const YCPSymbol &property, const YCPValue &newvalue)
YCPValue	queryWidget (const YCPSymbol &property)
virtual void	setLabel (const YCPString &label)
YCPString	getLabel ()
virtual void	setProgress (const YCPInteger &progress)
YCPInteger	getProgress ()
Protected Attributes
YCPString	label
YCPInteger	maxProgress
YCPInteger	progress

---

Detailed Description

Implementation of the ProgressBar widget.

ProgressBar

• string label the label describing the bar integer maxvalue the maximum value of the bar integer progress the current progress value of the bar `ProgressBar( `id( `pb ), "17 of 42 Packages installed", 42, 17 ) ProgressBar1.ycp ProgressBar2.ycp

A progress bar is a horizontal bar with a label that shows a progress value. If you omit the optional parameter maxvalue, the maximum value will be 100. If you omit the optional parameter progress, the progress bar will set to 0 initially.

---

Constructor & Destructor Documentation

YProgressBar::YProgressBar	(	const YWidgetOpt &	opt,
		const YCPString &	label,
		const YCPInteger &	maxProgress,
		const YCPInteger &	initialProgress
	)

Constructor.

---

Member Function Documentation

virtual char* YProgressBar::widgetClass

(

)

[inline, virtual]

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

Reimplemented from YWidget.

YCPValue YProgressBar::changeWidget	(	const YCPSymbol &	property,
		const YCPValue &	newvalue
	)			[virtual]

Implements the ui command changeWidget.

Reimplemented from YWidget.

YCPValue YProgressBar::queryWidget

(

const YCPSymbol &

property

)

[virtual]

Implements the ui command queryWidget

Reimplemented from YWidget.

void YProgressBar::setLabel

(

const YCPString &

label

)

[virtual]

Change the ProgressBar label. Overload this, but call YProgressBar::setLabel at the end of your own function.

YCPString YProgressBar::getLabel

(

)

Get the current label. This method cannot be overidden. The label of the ProgressBar cannot be changed other than by calling setProgress, i.e. not by the ui. Therefore setProgress stores the current ProgressBar in ProgressBar.

void YProgressBar::setProgress

(

const YCPInteger &

progress

)

[virtual]

Change the progress. Overload this, but call YProgressBar::setProgress at the end of your own function.

YCPInteger YProgressBar::getProgress

(

)

Get the current progress. This method cannot be overidden. The progress of the cannot be changed other than by calling setProgress, i.e. not by the ui. Therefore setProgress stores the current ProgressBar in ProgressBar.

---

Member Data Documentation

YCPString YProgressBar::label [protected]

Current label of the ProgressBar

YCPInteger YProgressBar::maxProgress [protected]

Maximum progress value of the progress bar. The progress can go from 0 to maxprogress.

YCPInteger YProgressBar::progress [protected]

current progress value of the ProgressBar.

---

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

• YProgressBar.h
• YProgressBar.cc

---