libyui  3.0.10
YTree Class Reference

#include <YTree.h>

Inheritance diagram for YTree:
Collaboration diagram for YTree:

List of all members.

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

Protected Member Functions

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

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 ( ) [inline, virtual]

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 [inline, virtual]

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:
 All Classes Functions Variables Enumerations Friends