libyui
Public Member Functions | Protected Member Functions

YBusyIndicator Class Reference

Inheritance diagram for YBusyIndicator:
YWidget

List of all members.

Public Member Functions

virtual ~YBusyIndicator ()
virtual const char * widgetClass () const
string label ()
virtual void setLabel (const string &label)
int timeout () const
virtual void setTimeout (int newTimeout)
bool alive () const
virtual void setAlive (bool newAlive)
virtual bool setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const string &propertyName)
virtual const YPropertySetpropertySet ()

Protected Member Functions

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

Constructor & Destructor Documentation

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

Constructor.

YBusyIndicator::~YBusyIndicator ( ) [virtual]

Destructor.


Member Function Documentation

bool YBusyIndicator::alive ( ) const

Return whether busy indicator is alive or in stalled stated.

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

string YBusyIndicator::label ( )

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

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.

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.

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

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

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.

int YBusyIndicator::timeout ( ) const

Return the current timeout in milliseconds.

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

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:
 All Classes Functions Variables Enumerations Friends