#include <YDownloadProgress.h>

Inheritance diagram for YDownloadProgress:

Collaboration diagram for YDownloadProgress:

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 ()
Public Member Functions inherited from YWidget
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
YWidgetListIterator	childrenBegin () const
YWidgetListIterator	childrenEnd () const
YWidgetListConstIterator	childrenConstBegin () const
YWidgetListConstIterator	childrenConstEnd () const
YWidgetListIterator	begin ()
YWidgetListIterator	end ()
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)
void	operator delete (void *ptr) noexcept
virtual void	startMultipleChanges ()
virtual void	doneMultipleChanges ()

Protected Member Functions
	YDownloadProgress (YWidget *parent, const std::string &label, const std::string &filename, YFileSize_t expectedSize)
Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)
YWidgetChildrenManager *	childrenManager () const
void	setChildrenManager (YWidgetChildrenManager *manager)
void	setBeingDestroyed ()
void	dumpWidget (YWidget *w, int indentationLevel)

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::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.

◆ ~YDownloadProgress()

YDownloadProgress::~YDownloadProgress ( )

virtual

Destructor.

Member Function Documentation

◆ currentFileSize()

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.

◆ currentPercent()

int YDownloadProgress::currentPercent ( ) const

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

◆ expectedSize()

YFileSize_t YDownloadProgress::expectedSize ( ) const

Return the expected file size.

◆ filename()

string YDownloadProgress::filename ( ) const

Return the name of the file that is being monitored.

◆ getProperty()

YPropertyValue YDownloadProgress::getProperty ( const std::string & propertyName )

virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ label()

string YDownloadProgress::label ( ) const

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

◆ propertySet()

const YPropertySet & YDownloadProgress::propertySet ( )

virtual

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

Reimplemented from YWidget.

◆ setExpectedSize()

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.

◆ setFilename()

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.

◆ setLabel()

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.

◆ setProperty()

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.

◆ value()

int YDownloadProgress::value ( ) const

inline

Alias for currentPercent().

◆ widgetClass()

virtual const char * YDownloadProgress::widgetClass ( ) const

inlinevirtual

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:

/builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui/src/YDownloadProgress.h
/builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui/src/YDownloadProgress.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YDownloadProgress()

◆ ~YDownloadProgress()

Member Function Documentation

◆ currentFileSize()

◆ currentPercent()

◆ expectedSize()

◆ filename()

◆ getProperty()

◆ label()

◆ propertySet()

◆ setExpectedSize()

◆ setFilename()

◆ setLabel()

◆ setProperty()

◆ value()

◆ widgetClass()