libyui
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
YProgressBar Class Reference

#include <YProgressBar.h>

Inheritance diagram for YProgressBar:
Inheritance graph
[legend]
Collaboration diagram for YProgressBar:
Collaboration graph
[legend]

Public Member Functions

virtual ~YProgressBar ()
 
virtual const char * widgetClass () const
 
std::string label ()
 
virtual void setLabel (const std::string &label)
 
int maxValue () const
 
int value () const
 
virtual void setValue (int newValue)
 
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

 YProgressBar (YWidget *parent, const std::string &label, int maxValue=100)
 
- 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

A progress bar, showing completion of value() out of maxValue() parts.

Constructor & Destructor Documentation

◆ YProgressBar()

YProgressBar::YProgressBar ( YWidget * parent,
const std::string & label,
int maxValue = 100 )
protected

Constructor.

◆ ~YProgressBar()

YProgressBar::~YProgressBar ( )
virtual

Destructor.

Member Function Documentation

◆ getProperty()

YPropertyValue YProgressBar::getProperty ( const std::string & propertyName)
virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ label()

string YProgressBar::label ( )

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

◆ maxValue()

int YProgressBar::maxValue ( ) const

Return the maximum progress value. Notice that this value can only be set in the constructor.

◆ propertySet()

const YPropertySet & YProgressBar::propertySet ( )
virtual

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

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ setLabel()

void YProgressBar::setLabel ( const std::string & label)
virtual

Set the label (the caption 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 YProgressBar::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.

◆ setValue()

void YProgressBar::setValue ( int newValue)
virtual

Set the current progress value ( <= maxValue() ).

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

◆ value()

int YProgressBar::value ( ) const

Return the current progress value.

◆ widgetClass()

virtual const char * YProgressBar::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: