libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YTree Class Referenceabstract

#include <YTree.h>

Inheritance diagram for YTree:
Collaboration diagram for YTree:

Public Member Functions

virtual ~YTree ()
 
virtual const char * widgetClass () const
 
virtual void rebuildTree ()=0
 
virtual void addItems (const YItemCollection &itemCollection)
 
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 ()
 
bool hasMultiSelection () const
 
virtual YTreeItemcurrentItem ()=0
 
- 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 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

 YTree (YWidget *parent, const std::string &label, bool multiSelection, bool recursiveSelection)
 
- 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

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

This is very similar to SelectionBox, but each item can have subitems that can be open (expanded) or closed (collapsed).

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

(*) 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.

'multiSelection' indicates whether or not the user can select multiple items at the same time. This can only be set in the constructor.

Definition at line 56 of file YTree.h.

Constructor & Destructor Documentation

YTree::YTree ( YWidget parent,
const std::string &  label,
bool  multiSelection,
bool  recursiveSelection 
)
protected

Constructor.

Definition at line 44 of file YTree.cc.

Here is the call graph for this function:

YTree::~YTree ( )
virtual

Destructor.

Definition at line 57 of file YTree.cc.

Member Function Documentation

void YTree::addItems ( const YItemCollection &  itemCollection)
virtual

Add multiple items. For some UIs, this can be more efficient than calling addItem() multiple times. This function also automatically calls rebuildTree() at the end.

Derived classes can overwrite this function, but they should call this base class function at the end of the new implementation.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

Definition at line 81 of file YTree.cc.

Here is the call graph for this function:

virtual YTreeItem* YTree::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 YTree::getProperty ( const std::string &  propertyName)
virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 146 of file YTree.cc.

Here is the call graph for this function:

bool YTree::hasMultiSelection ( ) const

Return 'true' if the user can select multiple items at the same time

Definition at line 165 of file YTree.cc.

Here is the call graph for this function:

bool YTree::immediateMode ( ) const

Deliver even more events than with notify() set.

For YTree, 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 tree. 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 tree send an event. Without immediateMode(), the NCTree 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 64 of file YTree.cc.

const YPropertySet & YTree::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 89 of file YTree.cc.

Here is the call graph for this function:

virtual void YTree::rebuildTree ( )
pure virtual

Rebuild the displayed tree from the internally stored YTreeItems.

The application should call this (once) after all items have been added with addItem(). YTree::addItems() calls this automatically.

Derived classes are required to implement this.

void YTree::setImmediateMode ( bool  on = true)

Set immediateMode() on or off.

Definition at line 71 of file YTree.cc.

Here is the call graph for this function:

bool YTree::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 123 of file YTree.cc.

Here is the call graph for this function:

const char* YTree::userInputProperty ( )
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 156 of file YTree.h.

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

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

Reimplemented from YSelectionWidget.

Definition at line 74 of file YTree.h.


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