libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YCheckBoxFrame Class Referenceabstract
Inheritance diagram for YCheckBoxFrame:
YSingleChildContainerWidget YWidget

Public Member Functions

 YCheckBoxFrame (YWidget *parent, const std::string &label, bool checked)
 
virtual ~YCheckBoxFrame ()
 
virtual const char * widgetClass () const
 
std::string label () const
 
virtual void setLabel (const std::string &label)
 
virtual void setValue (bool isChecked)=0
 
virtual bool value ()=0
 
bool autoEnable () const
 
virtual void setAutoEnable (bool autoEnable)
 
bool invertAutoEnable () const
 
virtual void setInvertAutoEnable (bool invertAutoEnable)
 
void handleChildrenEnablement (bool isChecked)
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
const char * userInputProperty ()
 
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 YSingleChildContainerWidget
virtual ~YSingleChildContainerWidget ()
 
virtual int preferredWidth ()
 
virtual int preferredHeight ()
 
virtual void setSize (int newWidth, int newHeight)
 
virtual bool stretchable (YUIDimension dim) const
 
- 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 preferredSize (YUIDimension dim)
 
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
 
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 ()
 
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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from YSingleChildContainerWidget
 YSingleChildContainerWidget (YWidget *parent)
 
- 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 35 of file YCheckBoxFrame.h.

Constructor & Destructor Documentation

YCheckBoxFrame::YCheckBoxFrame ( YWidget parent,
const std::string &  label,
bool  checked 
)

Constructor.

Definition at line 49 of file YCheckBoxFrame.cc.

YCheckBoxFrame::~YCheckBoxFrame ( )
virtual

Destructor.

Definition at line 59 of file YCheckBoxFrame.cc.

Member Function Documentation

bool YCheckBoxFrame::autoEnable ( ) const

Handle children enabling/disabling automatically based on the CheckBoxFrame's check box?

Definition at line 75 of file YCheckBoxFrame.cc.

YPropertyValue YCheckBoxFrame::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 149 of file YCheckBoxFrame.cc.

void YCheckBoxFrame::handleChildrenEnablement ( bool  isChecked)

Handle enabling/disabling of child widgets based on 'isChecked' (the current status of the check box) and autoEnable() and invertAutoEnable().

Derived classes should call this when the check box status changes rather than try to handle it on their level.

This method also needs to be called after new child widgets are added to establish the initial enabled or disabled state of the child widgets.

Definition at line 98 of file YCheckBoxFrame.cc.

bool YCheckBoxFrame::invertAutoEnable ( ) const

Invert the meaning of the CheckBoxFrame's check box, i.e., disable child widgets when checked?

Definition at line 86 of file YCheckBoxFrame.cc.

std::string YCheckBoxFrame::label ( ) const

Return the label text on the CheckBoxFrame.

Definition at line 65 of file YCheckBoxFrame.cc.

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

void YCheckBoxFrame::setAutoEnable ( bool  autoEnable)
virtual

Change autoEnabled flag.

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

Definition at line 80 of file YCheckBoxFrame.cc.

void YCheckBoxFrame::setInvertAutoEnable ( bool  invertAutoEnable)
virtual

Change invertAutonEnable flag.

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

Definition at line 91 of file YCheckBoxFrame.cc.

void YCheckBoxFrame::setLabel ( const std::string &  label)
virtual

Change the label text on the CheckBoxFrame.

Derived classes should overload this, but call this base class function in the overloaded function.

Definition at line 70 of file YCheckBoxFrame.cc.

bool YCheckBoxFrame::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 133 of file YCheckBoxFrame.cc.

virtual void YCheckBoxFrame::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 136 of file YCheckBoxFrame.h.

virtual void YCheckBoxFrame::setValue ( bool  isChecked)
pure virtual

Check or uncheck the CheckBoxFrame's check box.

Derived classes are required to implement this.

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

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 129 of file YCheckBoxFrame.h.

const char* YCheckBoxFrame::userInputProperty ( )
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 143 of file YCheckBoxFrame.h.

virtual bool YCheckBoxFrame::value ( )
pure virtual

Get the status of the CheckBoxFrame's check box.

Derived classes are required to implement this.

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

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

Reimplemented from YWidget.

Definition at line 54 of file YCheckBoxFrame.h.


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