YMultiSelectionBox Class Reference

Implementation of the MultiSelectionBox widget. More...

#include <YMultiSelectionBox.h>

Inheritance diagram for YMultiSelectionBox:

YSelectionWidget YWidget List of all members.

Public Member Functions

 YMultiSelectionBox (const YWidgetOpt &opt, YCPString label)
virtual char * widgetClass ()
YCPValue changeWidget (const YCPSymbol &property, const YCPValue &newvalue)
YCPValue queryWidget (const YCPSymbol &property)
const char * userInputProperty ()

Protected Member Functions

virtual bool itemIsSelected (int index)=0
virtual void selectItem (int index)=0
virtual void deselectAllItems ()=0
virtual int getCurrentItem ()=0
virtual void setCurrentItem (int index)=0

Private Member Functions

virtual void saveUserInput (YMacroRecorder *macroRecorder)

Detailed Description

Implementation of the MultiSelectionBox widget.

MultiSelectionBox

The MultiSelectionBox displays a ( scrollable ) list of items from which any number (even nothing!) can be selected. Use the MultiSelectionBox's SelectedItems property to find out which.

Each item can be specified either as a simple string or as `item( ... ) which includes an ( optional ) ID and an (optional) 'selected' flag that specifies the initial selected state ('not selected', i.e. 'false', is default).


Constructor & Destructor Documentation

YMultiSelectionBox::YMultiSelectionBox const YWidgetOpt opt,
YCPString  label
 

Constructor

Parameters:
text the initial text of the MultiSelectionBox label
opt the widget options


Member Function Documentation

YCPValue YMultiSelectionBox::changeWidget const YCPSymbol property,
const YCPValue newvalue
[virtual]
 

Implements the ui command changeWidget.

Reimplemented from YWidget.

virtual void YMultiSelectionBox::deselectAllItems  )  [protected, pure virtual]
 

Deselect all items.

Reimplement this in derived classes!

virtual int YMultiSelectionBox::getCurrentItem  )  [protected, pure virtual]
 

Returns the index of the item that currently has the keyboard focus.

Reimplement this in derived classes!

virtual bool YMultiSelectionBox::itemIsSelected int  index  )  [protected, pure virtual]
 

Check whether or not item index is selected.

Reimplement this in derived classes!

YCPValue YMultiSelectionBox::queryWidget const YCPSymbol property  )  [virtual]
 

Implements the ui command queryWidget

Reimplemented from YWidget.

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

virtual void YMultiSelectionBox::selectItem int  index  )  [protected, pure virtual]
 

Select item index.

Reimplement this in derived classes!

virtual void YMultiSelectionBox::setCurrentItem int  index  )  [protected, pure virtual]
 

Set the keyboard focus to one item.

Reimplement this in derived classes!

const char* YMultiSelectionBox::userInputProperty  )  [inline, virtual]
 

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

Reimplemented from YWidget.

virtual char* YMultiSelectionBox::widgetClass  )  [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:
Generated on Fri Jun 16 18:07:47 2006 for yast2-core by  doxygen 1.4.6