libyui  2.42.5
 All Classes Functions Variables Enumerations Friends
YSelectionBox Class Reference

#include <YSelectionBox.h>

Inheritance diagram for YSelectionBox:
YSelectionWidget YWidget

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 std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
const char * userInputProperty ()
 
- Public Member Functions inherited from YSelectionWidget
virtual ~YSelectionWidget ()
 
std::string label () const
 
virtual void setLabel (const std::string &newLabel)
 
virtual void addItem (YItem *item_disown)
 
void addItem (const std::string &itemLabel, bool selected=false)
 
void addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)
 
virtual void addItems (const YItemCollection &itemCollection)
 
virtual void deleteAllItems ()
 
void setItems (const YItemCollection &itemCollection)
 
YItemIterator itemsBegin ()
 
YItemConstIterator itemsBegin () const
 
YItemIterator itemsEnd ()
 
YItemConstIterator itemsEnd () const
 
bool hasItems () const
 
int itemsCount () const
 
YItemfirstItem () const
 
virtual YItemselectedItem ()
 
virtual YItemCollection selectedItems ()
 
bool hasSelectedItem ()
 
virtual void selectItem (YItem *item, bool selected=true)
 
virtual void deselectAllItems ()
 
void setIconBasePath (const std::string &basePath)
 
std::string iconBasePath () const
 
std::string iconFullPath (const std::string &iconName) const
 
std::string iconFullPath (YItem *item) const
 
bool itemsContain (YItem *item) const
 
YItemfindItem (const std::string &itemLabel) const
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
virtual std::string debugLabel () const
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
bool hasChildren () const
 
YWidgetfirstChild () const
 
YWidgetlastChild () const
 
YWidgetListConstIterator childrenBegin () const
 
YWidgetListConstIterator childrenEnd () const
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 
virtual int preferredWidth ()=0
 
virtual int preferredHeight ()=0
 
virtual int preferredSize (YUIDimension dim)
 
virtual void setSize (int newWidth, int newHeight)=0
 
bool isValid () const
 
bool beingDestroyed () const
 
void * widgetRep () const
 
void setWidgetRep (void *toolkitWidgetRep)
 
bool hasId () const
 
YWidgetIDid () const
 
void setId (YWidgetID *newId_disown)
 
virtual void setEnabled (bool enabled=true)
 
void setDisabled ()
 
virtual bool isEnabled () const
 
virtual bool stretchable (YUIDimension dim) const
 
void setStretchable (YUIDimension dim, bool newStretch)
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 
virtual int weight (YUIDimension dim)
 
bool hasWeight (YUIDimension dim)
 
void setWeight (YUIDimension dim, int weight)
 
void setNotify (bool notify=true)
 
bool notify () const
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 
bool notifyContextMenu () const
 
bool sendKeyEvents () const
 
void setSendKeyEvents (bool doSend)
 
bool autoShortcut () const
 
void setAutoShortcut (bool _newAutoShortcut)
 
int functionKey () const
 
bool hasFunctionKey () const
 
virtual void setFunctionKey (int fkey_no)
 
virtual bool setKeyboardFocus ()
 
void dumpWidgetTree (int indentationLevel=0)
 
void dumpDialogWidgetTree ()
 
void setChildrenEnabled (bool enabled)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YSelectionBox (YWidget *parent, const std::string &label)
 
- Protected Member Functions inherited from YSelectionWidget
 YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recurisveSelection=false)
 
void setEnforceSingleSelection (bool on)
 
bool enforceSingleSelection () const
 
bool recursiveSelection () const
 
YItemfindSelectedItem (YItemConstIterator begin, YItemConstIterator end)
 
void findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)
 
void deselectAllItems (YItemIterator begin, YItemIterator end)
 
YItemfindItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const
 
bool itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const
 
YItemitemAt (int index) const
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

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.

Definition at line 56 of file YSelectionBox.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 48 of file YSelectionBox.cc.

YSelectionBox::~YSelectionBox ( )
virtual

Destructor.

Definition at line 61 of file YSelectionBox.cc.

Member Function Documentation

YPropertyValue YSelectionBox::getProperty ( const std::string &  propertyName)
virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 140 of file YSelectionBox.cc.

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.

Definition at line 79 of file YSelectionBox.cc.

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.

Definition at line 95 of file YSelectionBox.cc.

void YSelectionBox::setImmediateMode ( bool  on = true)

Set immediateMode() on or off.

Definition at line 85 of file YSelectionBox.cc.

bool YSelectionBox::setProperty ( const std::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.

Definition at line 121 of file YSelectionBox.cc.

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.

Definition at line 73 of file YSelectionBox.cc.

bool YSelectionBox::shrinkable ( ) const

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

Definition at line 67 of file YSelectionBox.cc.

const char* YSelectionBox::userInputProperty ( )
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 149 of file YSelectionBox.h.

virtual const char* YSelectionBox::widgetClass ( ) const
inlinevirtual

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

Reimplemented from YSelectionWidget.

Definition at line 75 of file YSelectionBox.h.


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