libyui
3.4.2
|
RadioButton: Widget for one-out-of-many selection. More...
#include <YRadioButton.h>
Public Member Functions | |
virtual | ~YRadioButton () |
Destructor: Removes the button from the radio button group. | |
virtual const char * | widgetClass () const |
Returns a descriptive name of this widget class for logging, debugging etc. More... | |
virtual bool | value ()=0 |
Get the current on/off value: 'true' if checked, 'false' if unchecked. More... | |
virtual void | setValue (bool checked)=0 |
Set the radio button value (on/off). More... | |
std::string | label () const |
Get the label (the text on the RadioButton). | |
virtual void | setLabel (const std::string &label) |
Set the label (the text on the RadioButton). More... | |
bool | useBoldFont () const |
Returns 'true' if a bold font should be used. | |
virtual void | setUseBoldFont (bool bold=true) |
Indicate whether or not a bold font should be used. More... | |
YRadioButtonGroup * | buttonGroup () |
Get a pointer to the radio button group this button belongs to. | |
virtual bool | setProperty (const std::string &propertyName, const YPropertyValue &val) |
Set a property. More... | |
virtual YPropertyValue | getProperty (const std::string &propertyName) |
Get a property. More... | |
virtual const YPropertySet & | propertySet () |
Return this class's property set. More... | |
virtual std::string | shortcutString () const |
Get the string of this widget that holds the keyboard shortcut. More... | |
virtual void | setShortcutString (const std::string &str) |
Set the string of this widget that holds the keyboard shortcut. More... | |
const char * | userInputProperty () |
The name of the widget property that will return user input. More... | |
![]() | |
virtual | ~YWidget () |
Destructor. | |
virtual std::string | debugLabel () const |
Returns a descriptive label of this widget instance. More... | |
std::string | helpText () const |
Return the help text for this widget. | |
void | setHelpText (const std::string &helpText) |
Set a help text for this widget. More... | |
bool | hasChildren () const |
Returns 'true' if this widget has any children. | |
YWidget * | firstChild () const |
Returns the first child or 0 if there is none. More... | |
YWidget * | lastChild () const |
Returns the last child or 0 if there is none. | |
YWidgetListIterator | childrenBegin () const |
Return an iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListIterator | childrenEnd () const |
Return an interator that points after the last child. | |
YWidgetListConstIterator | childrenConstBegin () const |
Return a const iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListConstIterator | childrenConstEnd () const |
Return a const interator that points after the last child. | |
YWidgetListIterator | begin () |
A helper for the range-based "for" loop. More... | |
YWidgetListIterator | end () |
A helper for the range-based "for" loop. More... | |
int | childrenCount () const |
Returns the current number of children. | |
bool | contains (YWidget *child) const |
Checks if 'child' is a (direct!) child of this widget. | |
virtual void | addChild (YWidget *child) |
Add a new child. More... | |
virtual void | removeChild (YWidget *child) |
Remove a child. More... | |
void | deleteChildren () |
Delete all children and remove them from the children manager's list. | |
YWidget * | parent () const |
Return this widget's parent or 0 if it doesn't have a parent. | |
bool | hasParent () const |
Return 'true' if this widget has a parent, 'false' if not. | |
void | setParent (YWidget *newParent) |
Set this widget's parent. | |
YDialog * | findDialog () |
Traverse up the widget hierarchy and find the dialog this widget belongs to. More... | |
YWidget * | findWidget (YWidgetID *id, bool doThrow=true) const |
Recursively find a widget by its ID. More... | |
virtual int | preferredWidth ()=0 |
Preferred width of the widget. More... | |
virtual int | preferredHeight ()=0 |
Preferred height of the widget. More... | |
virtual int | preferredSize (YUIDimension dim) |
Preferred size of the widget in the specified dimension. More... | |
virtual void | setSize (int newWidth, int newHeight)=0 |
Set the new size of the widget. More... | |
bool | isValid () const |
Checks whether or not this object is valid. More... | |
bool | beingDestroyed () const |
Check if this widget is in the process of being destroyed. | |
void * | widgetRep () const |
Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. | |
void | setWidgetRep (void *toolkitWidgetRep) |
Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More... | |
bool | hasId () const |
Returns 'true' if this widget has an ID. | |
YWidgetID * | id () const |
Returns this widget's ID. | |
void | setId (YWidgetID *newId_disown) |
Set this widget's ID. More... | |
virtual void | setEnabled (bool enabled=true) |
Enable or disable this widget, i.e. More... | |
void | setDisabled () |
Disable this widget (overloaded for better readability). | |
virtual bool | isEnabled () const |
Returns 'true' if this widget is enabled. | |
virtual bool | stretchable (YUIDimension dim) const |
This is a boolean value that determines whether the widget is resizable beyond its preferred size in the specified dimension. More... | |
void | setStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options. | |
void | setDefaultStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch". More... | |
virtual int | weight (YUIDimension dim) |
The weight is used in situations where all widgets can get their preferred size and yet space is available. More... | |
bool | hasWeight (YUIDimension dim) |
Return whether or not the widget has a weight in the specified dimension. | |
void | setWeight (YUIDimension dim, int weight) |
Set a weight in the specified dimension. | |
void | setNotify (bool notify=true) |
Sets the Notify property. | |
bool | notify () const |
Returns whether the widget will notify, i.e. More... | |
void | setNotifyContextMenu (bool notifyContextMenu=true) |
Sets the notifyContextMenu property. | |
bool | notifyContextMenu () const |
Returns whether the widget will send an event when the user clicks selects the context menu e.g. More... | |
bool | sendKeyEvents () const |
Returns 'true' if this widget should send key events, i.e. More... | |
void | setSendKeyEvents (bool doSend) |
Specify whether or not this widget should send key events. | |
bool | autoShortcut () const |
Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file. | |
void | setAutoShortcut (bool _newAutoShortcut) |
Sets the 'autoShortcut' flag. | |
int | functionKey () const |
Return a function key number that is assigned to this widget. More... | |
bool | hasFunctionKey () const |
Check if a function key is assigned to this widget. | |
virtual void | setFunctionKey (int fkey_no) |
Assign a function key to this widget (1 for F1, 2 for F2, etc. More... | |
virtual bool | setKeyboardFocus () |
Set the keyboard focus to this widget. More... | |
void | dumpWidgetTree (int indentationLevel=0) |
Debugging function: Dump the widget tree from here on to the log file. | |
void | dumpDialogWidgetTree () |
Debugging function: Dump the widget tree from this widget's dialog parent. More... | |
void | setChildrenEnabled (bool enabled) |
Enable or disable all widgets in this widget tree. | |
void * | operator new (size_t size) |
Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More... | |
virtual void | startMultipleChanges () |
In some UIs updating the screen content is an expensive operation. More... | |
virtual void | doneMultipleChanges () |
Protected Member Functions | |
YRadioButton (YWidget *parent, const std::string &label) | |
Constructor. More... | |
YRadioButtonGroup * | findRadioButtonGroup () const |
Traverse the widget hierarchy upwards to find the corresponding YRadioButtonGroup, i.e. More... | |
virtual void | saveUserInput (YMacroRecorder *macroRecorder) |
Save the widget's user input to a macro recorder. More... | |
![]() | |
YWidget (YWidget *parent) | |
Constructor. | |
YWidgetChildrenManager * | childrenManager () const |
Returns this widget's children manager. | |
void | setChildrenManager (YWidgetChildrenManager *manager) |
Sets a new children manager for this widget. More... | |
void | setBeingDestroyed () |
Set the "being destroyed" flag, i.e. More... | |
void | dumpWidget (YWidget *w, int indentationLevel) |
Helper function for dumpWidgetTree(): Dump one widget to the log file. | |
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
Definition at line 51 of file YRadioButton.h.
|
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.
Definition at line 60 of file YRadioButton.cc.
|
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).
Definition at line 175 of file YRadioButton.cc.
|
virtual |
Get a property.
Reimplemented from YWidget.
This method may throw exceptions, for example
Reimplemented from YWidget.
Definition at line 149 of file YRadioButton.cc.
|
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 YRadioButton.cc.
|
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.
Definition at line 194 of file YRadioButton.cc.
|
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.
Definition at line 87 of file YRadioButton.cc.
|
virtual |
Set a property.
Reimplemented from YWidget.
This method may throw exceptions, for example
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 YRadioButton.cc.
|
inlinevirtual |
Set the string of this widget that holds the keyboard shortcut.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 177 of file YRadioButton.h.
|
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 105 of file YRadioButton.cc.
|
pure virtual |
Set the radio button value (on/off).
Derived classes are required to implement this.
|
inlinevirtual |
Get the string of this widget that holds the keyboard shortcut.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 170 of file YRadioButton.h.
|
inlinevirtual |
The name of the widget property that will return user input.
Inherited from YWidget.
Reimplemented from YWidget.
Definition at line 184 of file YRadioButton.h.
|
pure virtual |
Get the current on/off value: 'true' if checked, 'false' if unchecked.
Derived classes are required to implement this.
|
inlinevirtual |
Returns a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 84 of file YRadioButton.h.