libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YPushButton Class Reference
Inheritance diagram for YPushButton:
YWidget

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)
 
- 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 bool setKeyboardFocus ()
 
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

 YPushButton (YWidget *parent, const std::string &label)
 
- 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 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.

YPushButton::~YPushButton ( )
virtual

Destructor.

Definition at line 67 of file YPushButton.cc.

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.

bool YPushButton::isDefaultButton ( ) const

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.

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.

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.

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)
inlinevirtual

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.

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.

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.

virtual void YPushButton::setShortcutString ( const std::string &  str)
inlinevirtual

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.

virtual std::string YPushButton::shortcutString ( ) const
inlinevirtual

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.

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

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: