libyui
|
#include <YTree.h>
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.
See also https://github.com/libyui/libyui-ncurses/blob/master/doc/nctable-and-nctree.md
|
protected |
Constructor.
|
virtual |
Destructor.
Activate the item selected in the tree. This can be used in automated tests to simulate user input.
Derived classes are required to implement this.
|
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.
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.
Return the item in the tree that matches path of labels or 0 if not found.
'path' is a vector of strings with the path components, e.g. ["usr", "share", "doc", "packages"].
|
protected |
Recursively search the items between item iterators 'begin' and 'end' for a path specified in a string vector between 'path_begin' and 'path_end'. Return that item or 0 if not found.
This is a helper function for findItem( std::vector<std::string> & ).
|
virtual |
bool YTree::hasMultiSelection | ( | ) | const |
Return 'true' if the user can select multiple items at the same time
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.
|
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.
Set immediateMode() on or off.
|
virtual |
Returns a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YSelectionWidget.