libyui  3.0.10
YPushButton Class Reference
Inheritance diagram for YPushButton:
Collaboration diagram for YPushButton:

List of all members.

Public Member Functions

virtual ~YPushButton ()
virtual const char * widgetClass () const
std::string label () const
virtual void setLabel (const std::string &label)
virtual void setIcon (const std::string &iconName)
bool isDefaultButton () const
virtual void setDefaultButton (bool def=true)
virtual void setRole (YButtonRole role)
YButtonRole role () const
virtual void setFunctionKey (int fkey_no)
bool isHelpButton () const
virtual void setHelpButton (bool helpButton=true)
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const std::string &propertyName)
virtual const YPropertySetpropertySet ()
virtual std::string shortcutString () const
virtual void setShortcutString (const std::string &str)

Protected Member Functions

 YPushButton (YWidget *parent, const std::string &label)

Detailed Description

Definition at line 34 of file YPushButton.h.


Constructor & Destructor Documentation

YPushButton::YPushButton ( YWidget parent,
const std::string &  label 
) [protected]

Constructor.

Definition at line 56 of file YPushButton.cc.

Here is the call graph for this function:

Destructor.

Definition at line 67 of file YPushButton.cc.

Here is the call graph for this function:


Member Function Documentation

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 231 of file YPushButton.cc.

Here is the call graph for this function:

Returns 'true' if this is the dialog's default button, i.e. the one button that gets activated if the user hits the [Return] key anywhere in the dialog.

Definition at line 90 of file YPushButton.cc.

bool YPushButton::isHelpButton ( ) const

Returns 'true' if this is a "Help" button.

When activated, a help button will traverse up its widget hierarchy and search for the topmost widget with a helpText() set and display that help text in a pop-up dialog (with a local event loop).

NOTE that this is only done during YDialog::waitForEvent() (i.e. in YCP UI::WaitForEvent(), UI::UserInput(), UI::TimeoutUserInput() ) and not during YDialog::pollEvent() (i.e. YCP UI::PollInput()) since displaying the help text will block the application until the user closes the help text.

Definition at line 125 of file YPushButton.cc.

std::string YPushButton::label ( ) const

Get the label (the text on the button).

Definition at line 84 of file YPushButton.cc.

const YPropertySet & YPushButton::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 198 of file YPushButton.cc.

Here is the call graph for this function:

YButtonRole YPushButton::role ( ) const

Return the role of this button.

Definition at line 164 of file YPushButton.cc.

void YPushButton::setDefaultButton ( bool  def = true) [virtual]

Make this button the default button.

Derived classes should reimplement this, but call this base class function in the overwritten function.

Definition at line 96 of file YPushButton.cc.

Here is the call graph for this function:

void YPushButton::setFunctionKey ( int  fkey_no) [virtual]

Assign a function key to this widget (1 for F1, 2 for F2, etc.; 0 for none)

Reimplemented from YWidget to map function keys to button roles.

Derived classes may want to overwrite this function, but they should call this base class function in the new function.

Reimplemented from YWidget.

Definition at line 172 of file YPushButton.cc.

Here is the call graph for this function:

void YPushButton::setHelpButton ( bool  helpButton = true) [virtual]

Make this button a help button.

Derived classes are free to reimplement this, but they should call this base class method in the overloaded function.

Definition at line 131 of file YPushButton.cc.

virtual void YPushButton::setIcon ( const std::string &  iconName) [inline, virtual]

Set this button's icon from an icon file in the UI's default icon directory. Clear the icon if the name is empty.

This default implementation does nothing. UIs that can handle icons can choose to overwrite this method.

Definition at line 74 of file YPushButton.h.

void YPushButton::setLabel ( const std::string &  label) [virtual]

Set the label (the text on the button).

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 YPushButton.cc.

Here is the call graph for this function:

bool YPushButton::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 216 of file YPushButton.cc.

Here is the call graph for this function:

void YPushButton::setRole ( YButtonRole  role) [virtual]

Set a predefined role for this button.

This is important when the button is a child of a YButtonBox so the layout can be arranged according to the conventions of the current UI or desktop environment.

See YButtonBox.h for more details. YButtonRole is defined in YTypes.h

The default is YCustomButton, i.e., no predefined role. setFunctionKey() uses some heuristics to map function keys to buttons:

F10 -> YOkButton F9 -> YCancelButton F1 -> YHelpButton

Derived classes are free to reimplement this, but they should call this base class function in the overwritten function.

Definition at line 140 of file YPushButton.cc.

Here is the call graph for this function:

virtual void YPushButton::setShortcutString ( const std::string &  str) [inline, virtual]

Set the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 193 of file YPushButton.h.

Here is the call graph for this function:

virtual std::string YPushButton::shortcutString ( ) const [inline, virtual]

Get the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 186 of file YPushButton.h.

Here is the call graph for this function:

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

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

Reimplemented from YWidget.

Definition at line 52 of file YPushButton.h.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends