#include <YRadioButton.h>

Inheritance diagram for YRadioButton:

Collaboration diagram for YRadioButton:

Public Member Functions
virtual	~YRadioButton ()

virtual const char *	widgetClass () const

virtual bool	value ()=0

virtual void	setValue (bool checked)=0

std::string	label () const

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

bool	useBoldFont () const

virtual void	setUseBoldFont (bool bold=true)

YRadioButtonGroup *	buttonGroup ()

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

virtual YPropertyValue	getProperty (const std::string &propertyName)

virtual const YPropertySet &	propertySet ()

virtual std::string	shortcutString () const

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

const char *	userInputProperty ()

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

YWidget *	firstChild () const

YWidget *	lastChild () 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 ()

YWidget *	parent () const

bool	hasParent () const

void	setParent (YWidget *newParent)

YDialog *	findDialog ()

YWidget *	findWidget (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

YWidgetID *	id () 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 void	setFunctionKey (int fkey_no)

virtual bool	setKeyboardFocus ()

void	dumpWidgetTree (int indentationLevel=0)

void	dumpDialogWidgetTree ()

void	setChildrenEnabled (bool enabled)

void *	operator new (size_t size)

void	operator delete (void *ptr) noexcept

virtual void	startMultipleChanges ()

virtual void	doneMultipleChanges ()

Protected Member Functions
	YRadioButton (YWidget *parent, const std::string &label)

YRadioButtonGroup *	findRadioButtonGroup () const

virtual void	saveUserInput (YMacroRecorder *macroRecorder)

Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)

YWidgetChildrenManager *	childrenManager () const

void	setChildrenManager (YWidgetChildrenManager *manager)

void	setBeingDestroyed ()

void	dumpWidget (YWidget *w, int indentationLevel)

Detailed Description

RadioButton: Widget for one-out-of-many selection.

Only one RadioButton in a RadioBox (in a RadioButtonGroup) can be set to "on" at the same time. Setting any RadioButton of a RadioButtonGroup to "on" automatically sets all others in the same RadioButtonGroup to "off".

RadioButtons customarily have a distinct visual appearance from CheckBoxes:

( ) RadioButton 1
(*) RadioButton 2
( ) RadioButton 3

[ ] CheckBox 1
[*] CheckBox 2
[*] CheckBox 3

Constructor & Destructor Documentation

◆ YRadioButton()

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

protected

Constructor.

Creates a new RadioButton with user-visible text 'label'. 'label' can and should contain a keyboard shortcut (designated with '&').

The caller has to take care to add this RadioButton to its RadioButtonGroup:

if ( radioButton->buttonGroup() ) radioButton->buttonGroup()->addRadioButton( radioButton );

This can't be done in the constructor because it would involve calling a virtual function, which doesn't work yet within the constructor.

◆ ~YRadioButton()

YRadioButton::~YRadioButton ( )

virtual

Destructor: Removes the button from the radio button group.

Member Function Documentation

◆ buttonGroup()

YRadioButtonGroup * YRadioButton::buttonGroup ( )

Get a pointer to the radio button group this button belongs to.

◆ findRadioButtonGroup()

YRadioButtonGroup * YRadioButton::findRadioButtonGroup ( ) const

protected

Traverse the widget hierarchy upwards to find the corresponding YRadioButtonGroup, i.e. the class that controls the radio box behaviour (i.e. that makes sure that no more than one RadioButton is set to "on" at the same time).

◆ getProperty()

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

◆ label()

string YRadioButton::label ( ) const

Get the label (the text on the RadioButton).

◆ propertySet()

const YPropertySet & YRadioButton::propertySet ( )

virtual

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

Reimplemented from YWidget.

◆ saveUserInput()

void YRadioButton::saveUserInput ( YMacroRecorder * macroRecorder )

protectedvirtual

Save the widget's user input to a macro recorder.

Reimplemented from YWidget because only radio buttons that are on (no more than one per radio box) are recorded.

Reimplemented from YWidget.

◆ setLabel()

void YRadioButton::setLabel ( const std::string & label )

virtual

Set the label (the text on the RadioButton).

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

◆ setProperty()

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

◆ setShortcutString()

virtual void YRadioButton::setShortcutString ( const std::string & str )

inlinevirtual

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

Reimplemented from YWidget.

◆ setUseBoldFont()

void YRadioButton::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.

◆ setValue()

virtual void YRadioButton::setValue ( bool checked )

pure virtual

Set the radio button value (on/off).

Derived classes are required to implement this.

◆ shortcutString()

virtual std::string YRadioButton::shortcutString ( ) const

inlinevirtual

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

Reimplemented from YWidget.

◆ useBoldFont()

bool YRadioButton::useBoldFont ( ) const

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

◆ userInputProperty()

const char * YRadioButton::userInputProperty ( )

inlinevirtual

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

Reimplemented from YWidget.

◆ value()

virtual bool YRadioButton::value ( )

pure virtual

Get the current on/off value: 'true' if checked, 'false' if unchecked.

Derived classes are required to implement this.

◆ widgetClass()

virtual const char * YRadioButton::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:

/__w/libyui/libyui/libyui/src/YRadioButton.h
/__w/libyui/libyui/libyui/src/YRadioButton.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YRadioButton()

◆ ~YRadioButton()

Member Function Documentation

◆ buttonGroup()

◆ findRadioButtonGroup()

◆ getProperty()

◆ label()

◆ propertySet()

◆ saveUserInput()

◆ setLabel()

◆ setProperty()

◆ setShortcutString()

◆ setUseBoldFont()

◆ setValue()

◆ shortcutString()

◆ useBoldFont()

◆ userInputProperty()

◆ value()

◆ widgetClass()