libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YBusyIndicator Class Reference
Inheritance diagram for YBusyIndicator:
Collaboration diagram for YBusyIndicator:

Public Member Functions

virtual ~YBusyIndicator ()
 
virtual const char * widgetClass () const
 
std::string label ()
 
virtual void setLabel (const std::string &label)
 
int timeout () const
 
virtual void setTimeout (int newTimeout)
 
bool alive () const
 
virtual void setAlive (bool newAlive)
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
- 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
 
YWidgetfirstChild () const
 
YWidgetlastChild () 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 ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (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
 
YWidgetIDid () 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

 YBusyIndicator (YWidget *parent, const std::string &label, int timeout=1000, bool alive=true)
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

Definition at line 33 of file YBusyIndicator.h.

Constructor & Destructor Documentation

YBusyIndicator::YBusyIndicator ( YWidget parent,
const std::string &  label,
int  timeout = 1000,
bool  alive = true 
)
protected

Constructor.

Definition at line 52 of file YBusyIndicator.cc.

Here is the call graph for this function:

YBusyIndicator::~YBusyIndicator ( )
virtual

Destructor.

Definition at line 66 of file YBusyIndicator.cc.

Member Function Documentation

bool YBusyIndicator::alive ( ) const

Return whether busy indicator is alive or in stalled stated.

Definition at line 104 of file YBusyIndicator.cc.

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 149 of file YBusyIndicator.cc.

Here is the call graph for this function:

std::string YBusyIndicator::label ( )

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

Definition at line 72 of file YBusyIndicator.cc.

const YPropertySet & YBusyIndicator::propertySet ( )
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 110 of file YBusyIndicator.cc.

Here is the call graph for this function:

void YBusyIndicator::setAlive ( bool  newAlive)
virtual

Send a keep alive message to prevent BusyIndicator from changing to 'stalled' state.

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

Definition at line 99 of file YBusyIndicator.cc.

Here is the call graph for this function:

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

Definition at line 78 of file YBusyIndicator.cc.

Here is the call graph for this function:

bool YBusyIndicator::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 132 of file YBusyIndicator.cc.

Here is the call graph for this function:

void YBusyIndicator::setTimeout ( int  newTimeout)
virtual

Set the timeout in milliseconds after that the widget shows 'stalled' when no new tick is received.

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

Definition at line 90 of file YBusyIndicator.cc.

int YBusyIndicator::timeout ( ) const

Return the current timeout in milliseconds.

Definition at line 84 of file YBusyIndicator.cc.

virtual const char* YBusyIndicator::widgetClass ( ) const
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 54 of file YBusyIndicator.h.


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