libyui
3.0.13
|
#include <YDownloadProgress.h>
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 YPropertySet & | propertySet () |
![]() | |
virtual | ~YWidget () |
virtual std::string | debugLabel () const |
std::string | helpText () const |
void | setHelpText (const std::string &helpText) |
bool | hasChildren () const |
YWidget * | firstChild () const |
YWidget * | lastChild () const |
YWidgetListConstIterator | childrenBegin () const |
YWidgetListConstIterator | childrenEnd () const |
int | childrenCount () const |
bool | contains (YWidget *child) const |
virtual void | addChild (YWidget *child) |
virtual void | removeChild (YWidget *child) |
void | deleteChildren () |
YWidget * | parent () const |
bool | hasParent () const |
void | setParent (YWidget *newParent) |
YDialog * | findDialog () |
YWidget * | findWidget (YWidgetID *id, bool doThrow=true) const |
virtual int | preferredWidth ()=0 |
virtual int | preferredHeight ()=0 |
virtual int | preferredSize (YUIDimension dim) |
virtual void | setSize (int newWidth, int newHeight)=0 |
bool | isValid () const |
bool | beingDestroyed () const |
void * | widgetRep () const |
void | setWidgetRep (void *toolkitWidgetRep) |
bool | hasId () const |
YWidgetID * | id () const |
void | setId (YWidgetID *newId_disown) |
virtual void | setEnabled (bool enabled=true) |
void | setDisabled () |
virtual bool | isEnabled () const |
virtual bool | stretchable (YUIDimension dim) const |
void | setStretchable (YUIDimension dim, bool newStretch) |
void | setDefaultStretchable (YUIDimension dim, bool newStretch) |
virtual int | weight (YUIDimension dim) |
bool | hasWeight (YUIDimension dim) |
void | setWeight (YUIDimension dim, int weight) |
void | setNotify (bool notify=true) |
bool | notify () const |
void | setNotifyContextMenu (bool notifyContextMenu=true) |
bool | notifyContextMenu () const |
bool | sendKeyEvents () const |
void | setSendKeyEvents (bool doSend) |
bool | autoShortcut () const |
void | setAutoShortcut (bool _newAutoShortcut) |
int | functionKey () const |
bool | hasFunctionKey () const |
virtual void | setFunctionKey (int fkey_no) |
virtual bool | setKeyboardFocus () |
virtual std::string | shortcutString () const |
virtual void | setShortcutString (const std::string &str) |
virtual const char * | userInputProperty () |
void | dumpWidgetTree (int indentationLevel=0) |
void | dumpDialogWidgetTree () |
void | setChildrenEnabled (bool enabled) |
virtual void | saveUserInput (YMacroRecorder *macroRecorder) |
void * | operator new (size_t size) |
virtual void | startMultipleChanges () |
virtual void | doneMultipleChanges () |
Protected Member Functions | |
YDownloadProgress (YWidget *parent, const std::string &label, const std::string &filename, YFileSize_t expectedSize) | |
![]() | |
YWidget (YWidget *parent) | |
YWidgetChildrenManager * | childrenManager () const |
void | setChildrenManager (YWidgetChildrenManager *manager) |
void | setBeingDestroyed () |
void | dumpWidget (YWidget *w, int indentationLevel) |
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.
|
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.
|
virtual |
Destructor.
Definition at line 66 of file YDownloadProgress.cc.
|
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.
int YDownloadProgress::currentPercent | ( | ) | const |
Return the percentage (0..100) of the file being downloaded so far.
Definition at line 115 of file YDownloadProgress.cc.
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.
|
virtual |
Get a property. Reimplemented from YWidget.
This method may throw YUIPropertyExceptions.
Reimplemented from YWidget.
Definition at line 185 of file YDownloadProgress.cc.
std::string YDownloadProgress::label | ( | ) | const |
Get the label (the text above the progress bar).
Definition at line 73 of file YDownloadProgress.cc.
|
virtual |
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.
|
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.
|
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.
|
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.
|
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.
|
inline |
Alias for currentPercent().
Definition at line 121 of file YDownloadProgress.h.
|
inlinevirtual |
Returns a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YWidget.
Definition at line 63 of file YDownloadProgress.h.