libyui  3.0.10
YDownloadProgress Class Reference

#include <YDownloadProgress.h>

Inheritance diagram for YDownloadProgress:
Collaboration diagram for YDownloadProgress:

List of all members.

Public Member Functions

virtual ~YDownloadProgress ()
virtual const char * widgetClass () const
std::string label () const
virtual void setLabel (const std::string &label)
std::string filename () const
virtual void setFilename (const std::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 std::string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const std::string &propertyName)
virtual const YPropertySetpropertySet ()

Protected Member Functions

 YDownloadProgress (YWidget *parent, const std::string &label, const std::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.

Definition at line 37 of file YDownloadProgress.h.


Constructor & Destructor Documentation

YDownloadProgress::YDownloadProgress ( YWidget parent,
const std::string &  label,
const std::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.

Definition at line 52 of file YDownloadProgress.cc.

Here is the call graph for this function:

Destructor.

Definition at line 66 of file YDownloadProgress.cc.


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.

Definition at line 130 of file YDownloadProgress.cc.

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

Definition at line 115 of file YDownloadProgress.cc.

Here is the call graph for this function:

YFileSize_t YDownloadProgress::expectedSize ( ) const

Return the expected file size.

Definition at line 101 of file YDownloadProgress.cc.

std::string YDownloadProgress::filename ( ) const

Return the name of the file that is being monitored.

Definition at line 87 of file YDownloadProgress.cc.

YPropertyValue YDownloadProgress::getProperty ( const std::string &  propertyName) [virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 185 of file YDownloadProgress.cc.

Here is the call graph for this function:

std::string YDownloadProgress::label ( ) const

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

Definition at line 73 of file YDownloadProgress.cc.

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 142 of file YDownloadProgress.cc.

Here is the call graph for this function:

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.

Definition at line 108 of file YDownloadProgress.cc.

void YDownloadProgress::setFilename ( const std::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.

Definition at line 94 of file YDownloadProgress.cc.

Here is the call graph for this function:

void YDownloadProgress::setLabel ( const std::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.

Definition at line 80 of file YDownloadProgress.cc.

Here is the call graph for this function:

bool YDownloadProgress::setProperty ( const std::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.

Definition at line 168 of file YDownloadProgress.cc.

Here is the call graph for this function:

int YDownloadProgress::value ( ) const [inline]

Alias for currentPercent().

Definition at line 121 of file YDownloadProgress.h.

Here is the call graph for this function:

virtual const char* YDownloadProgress::widgetClass ( ) const [inline, virtual]

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

Reimplemented from YWidget.

Definition at line 63 of file YDownloadProgress.h.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends