YMultiSelectionBox Class Reference

Inheritance diagram for YMultiSelectionBox:

List of all members.

Public Member Functions
virtual	~YMultiSelectionBox ()
virtual const char *	widgetClass () const
bool	shrinkable () const
virtual void	setShrinkable (bool shrinkable=true)
virtual bool	setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const string &propertyName)
virtual const YPropertySet &	propertySet ()
const char *	userInputProperty ()
virtual YItem *	currentItem ()=0
virtual void	setCurrentItem (YItem *item)=0
virtual void	saveUserInput (YMacroRecorder *macroRecorder)
Protected Member Functions
	YMultiSelectionBox (YWidget *parent, const string &label)

---

Constructor & Destructor Documentation

YMultiSelectionBox::YMultiSelectionBox	(	YWidget *	parent,
		const string &	label
	)		[protected]

Constructor.

YMultiSelectionBox::~YMultiSelectionBox

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual YItem* YMultiSelectionBox::currentItem

(

)

[pure virtual]

Return the the item that currently has the keyboard focus or 0 if no item currently has the keyboard focus.

Notice that for a MultiSelectionBox the current item is not necessarily selected, i.e., its check box may or may not be checked.

Derived classes are required to implement this function.

YPropertyValue YMultiSelectionBox::getProperty

(

const string &

propertyName

)

[virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

const YPropertySet & YMultiSelectionBox::propertySet

(

)

[virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

void YMultiSelectionBox::saveUserInput

(

YMacroRecorder *

macroRecorder

)

[virtual]

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

Reimplemented from YWidget because two properties need to be recorded.

Reimplemented from YWidget.

virtual void YMultiSelectionBox::setCurrentItem

(

YItem *

item

)

[pure virtual]

Set the keyboard focus to the specified item. 0 means clear the keyboard focus.

Notice that for a MultiSelectionBox the current item is not necessarily selected, i.e., its check box may or may not be checked. Use selectItem() for that.

Also notice that selectItem() does not make that newly selected item the current item.

Derived classes are required to implement this function.

bool YMultiSelectionBox::setProperty	(	const string &	propertyName,
		const YPropertyValue &	val
	)		[virtual]

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

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.

void YMultiSelectionBox::setShrinkable

(

bool

shrinkable = true

)

[virtual]

Make this MultiSelectionBox very small. This will take effect only upon the next geometry management run.

Derived classes can overwrite this, but should call this base class function in the new function.

bool YMultiSelectionBox::shrinkable

(

)

const

Return 'true' if this MultiSelectionBox should be very small.

const char* YMultiSelectionBox::userInputProperty

(

)

[inline, virtual]

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

Reimplemented from YWidget.

virtual const char* YMultiSelectionBox::widgetClass

(

)

const [inline, virtual]

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

Reimplemented from YSelectionWidget.

---

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

• /data/gitorious.org/libyui/libyui-master/src/YMultiSelectionBox.h
• /data/gitorious.org/libyui/libyui-master/src/YMultiSelectionBox.cc