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

List of all members.

Public Member Functions

virtual ~YCheckBox ()
virtual const char * widgetClass () const
virtual YCheckBoxState value ()=0
virtual void setValue (YCheckBoxState state)=0
bool isChecked ()
void setChecked (bool checked=true)
bool dontCare ()
void setDontCare ()
std::string label () const
virtual void setLabel (const std::string &label)
bool useBoldFont () const
virtual void setUseBoldFont (bool bold=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)
const char * userInputProperty ()

Protected Member Functions

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

Detailed Description

Definition at line 43 of file YCheckBox.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 45 of file YCheckBox.cc.

YCheckBox::~YCheckBox ( ) [virtual]

Destructor.

Definition at line 53 of file YCheckBox.cc.


Member Function Documentation

bool YCheckBox::dontCare ( ) [inline]

Simplified access to tri-state ("don't care").

Definition at line 109 of file YCheckBox.h.

Here is the call graph for this function:

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

Get a property. Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name

Reimplemented from YWidget.

Definition at line 121 of file YCheckBox.cc.

Here is the call graph for this function:

bool YCheckBox::isChecked ( ) [inline]

Simplified access to value(): Return 'true' if the CheckBox is checked.

Definition at line 98 of file YCheckBox.h.

Here is the call graph for this function:

std::string YCheckBox::label ( ) const

Get the label (the text on the CheckBox).

Definition at line 65 of file YCheckBox.cc.

const YPropertySet & YCheckBox::propertySet ( ) [virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 84 of file YCheckBox.cc.

Here is the call graph for this function:

void YCheckBox::setChecked ( bool  checked = true) [inline]

Simplified access to setValue(): Check of uncheck the CheckBox.

Definition at line 103 of file YCheckBox.h.

Here is the call graph for this function:

void YCheckBox::setDontCare ( ) [inline]

Simplified access to setting tri-state ("don't care").

Definition at line 114 of file YCheckBox.h.

Here is the call graph for this function:

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

Set the label (the text on the CheckBox).

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 59 of file YCheckBox.cc.

bool YCheckBox::setProperty ( const std::string &  propertyName,
const YPropertyValue val 
) [virtual]

Set a property. Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name
  • if the expected type and the type mismatch
  • if the value is out of range

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 105 of file YCheckBox.cc.

Here is the call graph for this function:

virtual void YCheckBox::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 187 of file YCheckBox.h.

Here is the call graph for this function:

void YCheckBox::setUseBoldFont ( bool  bold = true) [virtual]

Indicate whether or not a bold font should be used.

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 77 of file YCheckBox.cc.

virtual void YCheckBox::setValue ( YCheckBoxState  state) [pure virtual]

Set the CheckBox value (on/off/don't care).

Derived classes are required to implement this.

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

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 180 of file YCheckBox.h.

Here is the call graph for this function:

bool YCheckBox::useBoldFont ( ) const

Returns 'true' if a bold font should be used.

Definition at line 71 of file YCheckBox.cc.

const char* YCheckBox::userInputProperty ( ) [inline, virtual]

The name of the widget property that will return user input. Inherited from YWidget.

Reimplemented from YWidget.

Definition at line 194 of file YCheckBox.h.

virtual YCheckBoxState YCheckBox::value ( ) [pure virtual]

Get the current value:

YCheckBox_on CheckBox is checked YCheckBox_off CheckBox is unchecked

YCheckBox_dont_care tri-state: CheckBox is greyed out, neither checked nor unchecked

The user cannot set YCheckBox_dont_care directly. This status is always only set from the outside, usually because a setting cannot be clearly determined. For example, a checkbox

[ ] Read only

would be set to "don't care" (by the application, not directly by the user) when it is to display the read-only state of a group of files where some are read-only and some are writeable.

Derived classes are required to implement this function. (Intentionally not const)

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

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

Reimplemented from YWidget.

Definition at line 61 of file YCheckBox.h.


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