YDownloadProgress Class Reference

#include <YDownloadProgress.h>

Inheritance diagram for YDownloadProgress:

List of all members.

Public Member Functions
virtual	~YDownloadProgress ()
virtual const char *	widgetClass () const
string	label () const
virtual void	setLabel (const string &label)
string	filename () const
virtual void	setFilename (const string &filename)
YFileSize_t	expectedSize () const
virtual void	setExpectedSize (YFileSize_t newSize)
virtual YFileSize_t	currentFileSize () const
int	currentPercent () const
int	value () const
virtual bool	setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const string &propertyName)
virtual const YPropertySet &	propertySet ()
Protected Member Functions
	YDownloadProgress (YWidget *parent, const string &label, const string &filename, YFileSize_t expectedSize)

---

Detailed Description

DownloadProgress: A progress bar that monitors downloading a file by repeatedly polling its size up to its expected size.

---

Constructor & Destructor Documentation

YDownloadProgress::YDownloadProgress	(	YWidget *	parent,
		const string &	label,
		const string &	filename,
		YFileSize_t	expectedSize
	)		[protected]

Constructor.

'label' is the label above the progress bar.

'filename' is the name (with path) of the file being monitored.

'expectedSize' is the expected size of the file in bytes.

YDownloadProgress::~YDownloadProgress

(

)

[virtual]

Destructor.

---

Member Function Documentation

YFileSize_t YDownloadProgress::currentFileSize

(

)

const [virtual]

Return the current size of the file that is being downloaded or 0 if this file doesn't exist (yet).

This default implementation returns the 'st_size' field of a stat() system call on the file. This should be useful for most implementations.

int YDownloadProgress::currentPercent

(

)

const

Return the percentage (0..100) of the file being downloaded so far.

YFileSize_t YDownloadProgress::expectedSize

(

)

const

Return the expected file size.

string YDownloadProgress::filename

(

)

const

Return the name of the file that is being monitored.

YPropertyValue YDownloadProgress::getProperty

(

const string &

propertyName

)

[virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

string YDownloadProgress::label

(

)

const

Get the label (the text above the progress bar).

const YPropertySet & YDownloadProgress::propertySet

(

)

[virtual]

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

void YDownloadProgress::setExpectedSize

(

YFileSize_t

newSize

)

[virtual]

Set the expected file size.

Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.

void YDownloadProgress::setFilename

(

const string &

filename

)

[virtual]

Set the name of a new file to monitor.

Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.

void YDownloadProgress::setLabel

(

const string &

label

)

[virtual]

Set the label (the text above the progress bar).

Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.

bool YDownloadProgress::setProperty	(	const string &	propertyName,
		const YPropertyValue &	val
	)		[virtual]

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).

Reimplemented from YWidget.

int YDownloadProgress::value

(

)

const [inline]

Alias for currentPercent().

virtual const char* YDownloadProgress::widgetClass

(

)

const [inline, virtual]

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

Reimplemented from YWidget.

---

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

• /data/gitorious.org/libyui/libyui-master/src/YDownloadProgress.h
• /data/gitorious.org/libyui/libyui-master/src/YDownloadProgress.cc