YSelectionBox Class Reference

Implementation of the SelectionBox widget. More...

#include <YSelectionBox.h>

Inheritance diagram for YSelectionBox:

YSelectionWidget YWidget List of all members.

Public Member Functions

 YSelectionBox (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 int getCurrentItem ()=0
virtual void setCurrentItem (int index)=0

Private Member Functions

virtual void saveUserInput (YMacroRecorder *macroRecorder)

Detailed Description

Implementation of the SelectionBox widget.

SelectionBox

A selection box offers the user to select an item out of a list. Each item has a label and an optional id. When constructing the list of items, you have two way of specifying an item. Either you give a plain string, in which case the string is used both for the id and the label of the item. Or you specify a term `item( term id, string label ) or `item( term id, string label, boolean selected ), where you give an id of the form `id( any v ) where you can store an aribtrary value as id. The third argument controls whether the item is the selected item.


Constructor & Destructor Documentation

YSelectionBox::YSelectionBox const YWidgetOpt opt,
YCPString  label
 

Constructor

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


Member Function Documentation

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

Implements the ui command changeWidget.

Reimplemented from YWidget.

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

Returns the index of the currently selected item or -1 if no item is selected.

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

Implements the ui command queryWidget

Reimplemented from YWidget.

void YSelectionBox::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 YSelectionBox::setCurrentItem int  index  )  [protected, pure virtual]
 

Selects an item from the list.

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

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

Reimplemented from YWidget.

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