libyui
 
Loading...
Searching...
No Matches
YRadioButtonGroup Class Reference

#include <YRadioButtonGroup.h>

Inheritance diagram for YRadioButtonGroup:
Collaboration diagram for YRadioButtonGroup:

Public Member Functions

virtual ~YRadioButtonGroup ()
 
virtual const char * widgetClass () const
 
YRadioButtoncurrentButton () const
 
YRadioButtonvalue () const
 
virtual void addRadioButton (YRadioButton *radioButton)
 
virtual void removeRadioButton (YRadioButton *radioButton)
 
void uncheckOtherButtons (YRadioButton *radioButton)
 
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
 
YWidgetListIterator childrenBegin () const
 
YWidgetListIterator childrenEnd () const
 
YWidgetListConstIterator childrenConstBegin () const
 
YWidgetListConstIterator childrenConstEnd () const
 
YWidgetListIterator begin ()
 
YWidgetListIterator end ()
 
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 ()
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
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)
 
void operator delete (void *ptr) noexcept
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YRadioButtonGroup (YWidget *parent)
 
YRadioButtonListConstIterator radioButtonsBegin () const
 
YRadioButtonListConstIterator radioButtonsEnd () const
 
int radioButtonsCount () const
 
- 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

A group of YRadioButton widgets.

Constructor & Destructor Documentation

◆ YRadioButtonGroup()

YRadioButtonGroup::YRadioButtonGroup ( YWidget * parent)
protected

Constructor.

◆ ~YRadioButtonGroup()

YRadioButtonGroup::~YRadioButtonGroup ( )
virtual

Destructor.

Member Function Documentation

◆ addRadioButton()

void YRadioButtonGroup::addRadioButton ( YRadioButton * radioButton)
virtual

Add a RadioButton to this button group. RadioButtons are required to call this in their constructor.

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

◆ currentButton()

YRadioButton * YRadioButtonGroup::currentButton ( ) const

Find the currently selected button.

◆ getProperty()

YPropertyValue YRadioButtonGroup::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.

◆ propertySet()

const YPropertySet & YRadioButtonGroup::propertySet ( )
virtual

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

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ radioButtonsBegin()

YRadioButtonListConstIterator YRadioButtonGroup::radioButtonsBegin ( ) const
protected

Return an iterator that points to the first RadioButton of this button group.

Note that RadioButtons in this group may be direct or indirect children of the group, so don't confuse this with YWidget::widgetsBegin().

◆ radioButtonsCount()

int YRadioButtonGroup::radioButtonsCount ( ) const
protected

Return the number of RadioButtons in this button group.

◆ radioButtonsEnd()

YRadioButtonListConstIterator YRadioButtonGroup::radioButtonsEnd ( ) const
protected

Return an iterator that points behind the last RadioButton of this button group.

◆ removeRadioButton()

void YRadioButtonGroup::removeRadioButton ( YRadioButton * radioButton)
virtual

Remove a RadioButton from this button group. RadioButtons are required to call this in their destructor, but only if the button group is not also in the process of being destroyed (otherwise there may be race conditions with child widgets already destroyed):

if ( ! buttonGroup()->beingDestroyed )
    buttonGroup()->removeRadioButton( this );

◆ setProperty()

bool YRadioButtonGroup::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.

◆ uncheckOtherButtons()

void YRadioButtonGroup::uncheckOtherButtons ( YRadioButton * radioButton)

Unchecks all radio buttons except one. This method can be used by a concrete UI (the Qt UI or the NCurses UI) in the implementation of YRadioButton::setValue().

◆ value()

YRadioButton * YRadioButtonGroup::value ( ) const
inline

The same as currentButton() above for convenience.

◆ widgetClass()

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

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: