tmozIStatusBar Interface Reference

Status bar. More...

List of all members.

Public Member Functions
boolean	createProgressBar (in AString progressId, in AString description, in long value, in long max)
	Create progress bar Create new progress bar and set initial value.
boolean	setProgressBar (in AString progressId, in AString description, in long value, in long max)
	Set progress bar Set progress bar and current value.
boolean	removeProgressBar (in AString progressId)
	Remove progress bar Remove progress bar.

---

Detailed Description

Status bar.

Status bar object allows to display progress bar. It can be used to display progress of long running process.

---

Member Function Documentation

boolean createProgressBar	(	in AString	progressId,
		in AString	description,
		in long	value,
		in long	max
	)

Create progress bar Create new progress bar and set initial value.

Parameters:

	progressId	Unique id of the progress bar
	description	Description of the running process.
	value	Current value.
	max	Maximal value.

Returns:

Return true if progress bar was created. Return false if failed.

boolean removeProgressBar

(

in AString

progressId

)

Remove progress bar Remove progress bar.

Parameters:

progressId

Unique id of the progress bar

Returns:

Return true if removed. Return false if failed.

boolean setProgressBar	(	in AString	progressId,
		in AString	description,
		in long	value,
		in long	max
	)

Set progress bar Set progress bar and current value.

Parameters:

	progressId	Unique id of the progress bar
	description	Description of the running process.
	value	Current value.
	max	Maximal value.

Returns:

Return true if new value was set. Return false if failed.