Public Member Functions | Protected Member Functions

YSelectionBox Class Reference

#include <YSelectionBox.h>

Inheritance diagram for YSelectionBox:
YSelectionWidget YWidget

List of all members.

Public Member Functions

virtual ~YSelectionBox ()
virtual const char * widgetClass () const
bool shrinkable () const
virtual void setShrinkable (bool shrinkable=true)
bool immediateMode () const
void setImmediateMode (bool on=true)
virtual bool setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const string &propertyName)
virtual const YPropertySetpropertySet ()
const char * userInputProperty ()

Protected Member Functions

 YSelectionBox (YWidget *parent, const string &label)

Detailed Description

Selection box: List box that displays a (scrollable) list of items from which the user can select exactly one. Each item has a label text and an optional icon (*).

This widget displays a number of items at once (as screen space permits). If there is little screen space, you might consider using a ComboBox instead which (in non-editable mode which is the default) displays just one item (the selected item) right away and the others in a pop-up dialog upon mouse click or keypress.

The selection box also has a caption label that is displayed above the list. The hotkey displayed in that caption label will move the keyboard focus into the list.

If multiple columns are needed, use the table widget instead. For tree-like structures, use the tree widget.

(*) Not all UIs (in particular not text-based UIs) support displaying icons, so an icon should never be an exclusive means to display any kind of information.

Constructor & Destructor Documentation

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


YSelectionBox::~YSelectionBox ( ) [virtual]


Member Function Documentation

YPropertyValue YSelectionBox::getProperty ( const string &  propertyName) [virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

bool YSelectionBox::immediateMode ( ) const

Deliver even more events than with notify() set.

For YSelectionBox, this is relevant mostly for the NCurses UI:

In graphical UIs like the Qt UI, the user can use the mouse to select an item in a selection box. With notify() set, this will send an event right away (i.e., it will make UserInput and related return, while normally it would only return when the user clicks a PushButton).

In the NCurses UI, there is no mouse, so the user has to use the cursor keys to move to the item he wants to select. In immediateMode(), every cursor key press will make the selection box send an event. Without immediateMode(), the NCSelectionBox will wait until the user hits the [Return] key until an event is sent. Depending on what the application does upon each selection box event, immediateMode() might make the application less responsive.

const YPropertySet & YSelectionBox::propertySet ( ) [virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

void YSelectionBox::setImmediateMode ( bool  on = true)

Set immediateMode() on or off.

bool YSelectionBox::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 YSelectionBox::setShrinkable ( bool  shrinkable = true) [virtual]

Make this SelectionBox 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 YSelectionBox::shrinkable ( ) const

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

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

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

Reimplemented from YWidget.

virtual const char* YSelectionBox::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:
 All Classes Functions Variables Enumerations Friends