YCheckBox Class Reference

Implementation of the CheckBox widget. More...

#include <YCheckBox.h>

Inheritance diagram for YCheckBox:

List of all members.

Public Member Functions
	YCheckBox (const YWidgetOpt &opt, const YCPString &label)
virtual char *	widgetClass ()
YCPValue	changeWidget (const YCPSymbol &property, const YCPValue &newvalue)
YCPValue	queryWidget (const YCPSymbol &property)
virtual void	setValue (const YCPValue &checked)=0
virtual YCPValue	getValue ()=0
virtual void	setLabel (const YCPString &label)
YCPString	getLabel ()
const char *	shortcutProperty ()
const char *	userInputProperty ()
Protected Attributes
YCPString	label
Private Member Functions
virtual void	saveUserInput (YMacroRecorder *macroRecorder)

---

Detailed Description

Implementation of the CheckBox widget.

Clickable on/off toggle button.

CheckBox

• string label the text describing the check box boolean|nil checked whether the check box should start checked - nil means tristate condition, i.e. neither on nor off boldFont use a bold font `CheckBox( `id( `cheese ), "& Extra cheese" ) CheckBox1.ycp CheckBox2.ycp CheckBox3.ycp CheckBox4.ycp

A checkbox widget has two states: Checked and not checked. It returns no user input but you can query and change its state via the Value property.

---

Constructor & Destructor Documentation

YCheckBox::YCheckBox	(	const YWidgetOpt &	opt,
		const YCPString &	label
	)

Constructor

---

Member Function Documentation

virtual char* YCheckBox::widgetClass

(

)

[inline, virtual]

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

Reimplemented from YWidget.

YCPValue YCheckBox::changeWidget	(	const YCPSymbol &	property,
		const YCPValue &	newvalue
	)			[virtual]

Implements the ui command changeWidget.

Reimplemented from YWidget.

YCPValue YCheckBox::queryWidget

(

const YCPSymbol &

property

)

[virtual]

Implements the ui command queryWidget

Reimplemented from YWidget.

virtual void YCheckBox::setValue

(

const YCPValue &

checked

)

[pure virtual]

Set the check box on or off

virtual YCPValue YCheckBox::getValue

(

)

[pure virtual]

Returns whether the checkbox is checked. This may return 'true' or 'false' or 'nil' for a tristate check box.

void YCheckBox::setLabel

(

const YCPString &

label

)

[virtual]

Change the check box label. Overload this, but call YCheckBox::setLabel at the end of your own function.

YCPString YCheckBox::getLabel

(

)

Get the current check box label. This method cannot be overidden. The value of the label cannot be changed other than by calling setLabel, i.e. not by the ui. Therefore setLabel stores the current label in label.

const char* YCheckBox::shortcutProperty

(

)

[inline, virtual]

The name of the widget property that holds the keyboard shortcut. Inherited from YWidget.

Reimplemented from YWidget.

const char* YCheckBox::userInputProperty

(

)

[inline, virtual]

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

Reimplemented from YWidget.

void YCheckBox::saveUserInput

(

YMacroRecorder *

macroRecorder

)

[private, virtual]

Save the widget's user input to a macro recorder. Intentionally declared as "private" so all macro recording internals are handled by the abstract libyui level, not by a specific UI.

Reimplemented from YWidget.

---

Member Data Documentation

YCPString YCheckBox::label [protected]

The CheckBox label

---

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

• YCheckBox.h
• YCheckBox.cc

---