WidgetTreeBox Class
This class creates a box with a tree-like hierarchy. For example:
Source code(UnigineScript)
int init() {
Gui gui = engine.getGui();
WidgetTreeBox tree = new WidgetTreeBox(gui);
tree.addItem("1st item"); // Add items into the tree.
tree.addItem("2nd item");
tree.addItem("3rd item");
tree.addItem("4th item");
tree.addItemChild(0,1); // Make a 2nd item a child of the 1st one.
tree.setItemFolded(0,1); // Collapse children of the 1st child.
WidgetWindow window = new WidgetWindow(gui); // Create a window.
gui.addChild(window,GUI_ALIGN_CENTER);
window.addChild(tree,GUI_ALIGN_CENTER); // Render a tree in the window.
return 1;
}As a result, you will get:
WidgetTreeBox in a window
WidgetTreeBox Class
Members
WidgetTreeBox (Gui gui)
Constructor. Creates an empty tree box.Arguments
- Gui gui - GUI, to which the new tree box will belong.
int getItem (int num)
Returns the ID of a given item by its number. The IDs are unique, and the numbers simply point at the place in the list of all items.Arguments
- int num - Item number.
Return value
ID of the item.int isItemSelectable (int item)
Returns a value indicating if a given item can be selected.Arguments
- int item - Item number.
Return value
1 if the item is selectable; otherwise, 0.void setItemText (int item, string str)
Sets a text for a given item.Arguments
- int item - Item ID.
- string str - Item text.
int isMultiSelection ()
Returns a value indicating if multiple selection of items is enabled.Return value
1 if several items can be selected at once; otherwise, 0.void setItemTexture (int item, int texture)
Sets an icon for a given item.Arguments
- int item - Item ID.
- int texture - Zero-based ID of the icon.
void setItemFolded (int item, int folded)
Expands or collapses an hierarchy of a given item.Arguments
- int item - Item ID.
- int folded - 1 to collapse the item hierarchy, 0 to expand it.
void addItemChild (int item, int child)
Adds a child to a given item.Arguments
- int item - Item ID.
- int child - Child item ID.
void setItemHidden (int item, int hidden)
Sets a value indicating if a given item is hidden.Arguments
- int item - Item ID.
- int hidden - 1 to hide the item, 0 to show it.
void setImage (Image image)
Sets an image with mini-icons to be used with items. The image is a vertical strip of square icons.Arguments
- Image image - Image to set.
void clearSelection ()
Clears list of selected items.string getItemText (int item)
Returns the text of a given item.Arguments
- int item - Item ID.
Return value
Item text.WidgetTreeBox create (Widget widget)
WidgetTreeBox constructor.Arguments
- Widget widget - Widget smart pointer.
Return value
int getSelectedItem (int num)
Returns ID of a selected item (multi-selection mode).Arguments
- int num - Number of an item in the list of selected items.
Return value
ID of the selected item.void setItemData (int item, string str)
Sets the data for a given item. The data can be used as a text identifier of the item (instead of using the number of the item).Arguments
- int item - Item number in range from 0 to the total number of items.
- string str - Data to set.
int getItemChild (int item, int num)
Returns a child of a given item.Arguments
- int item - Item ID.
- int num - Child number in the list of children.
Return value
Child item ID.void setCurrentItem (int item)
Places focus on a given item.Arguments
- int item - Item ID.
void setItemParent (int item, int parent)
Sets a parent for a given item.Arguments
- int item - Item ID.
- int parent - Parent item ID. -1 removes the current parent.
int getCurrentItem ()
Returns the item currently in focus.Return value
Item ID.void setItemSelectable (int item, int selectable)
Sets a value indicating if a given item can be selected.Arguments
- int item - Item number.
- int selectable - 1 to set the item as selectable, 0 to set it as unselectable.
int addItem (string str, int texture = -1)
Adds a new item with a given text and and an icon.Arguments
- string str - Item text.
- int texture - Zero-based ID of the icon.
Return value
ID of the added item.void showItem (int item)
Scrolls a tree box so that a given item is visible.Arguments
- int item - Item ID.
void setEditable (int editable)
Sets a value indicating if item hierarchy can be edited.Arguments
- int editable - 1 to make the hierarchy editable, 0 to make it read-only.
int getItemTexture (int item)
Returns the icon of a given item.Arguments
- int item - Item ID.
Return value
Zero-based ID of the icon.int getNumItems ()
Returns the number of visible items in the tree box. Items that are currently to a parent level are not returned.Return value
Number of items.string getItemData (int item)
Returns the data of the currently selected item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Item data.int isItemFolded (int item)
Returns a value indicating if a given item is collapsed.Arguments
- int item - Item ID.
Return value
1 if the item is collapsed; otherwise, 0.int isItemSelected (int item)
Returns a value indicating if a given item is selected.Arguments
- int item - Item ID.
Return value
1 if the item is selected; otherwise, 0.void clear ()
Removes all items from the tree box.void setMultiSelection (int selection)
Enables or disables multiple selection of items.Arguments
- int selection - 1 to enable multiple selection, 0 to disable it.
string getCurrentItemText ()
Returns the text of the currently focused item.Return value
Item text.int getItemParent (int item)
Returns the parent of a given item.Arguments
- int item - Item ID.
Return value
Parent item ID.void setTexture (string texture)
Sets a texture with mini-icons to be used with items. The texture is a vertical strip of square icons.Arguments
- string texture - Path to a texture file.
void setItemColor (int item, vec4 color)
Sets a custom color for a given item.Arguments
- int item - Item ID.
- vec4 color - Color to set.
int isItemChild (int item, int child)
Checks if a given item is a child of another specified item.Arguments
- int item - Item ID.
- int child - Child item ID.
Return value
1 if child is actually a child of the item; otherwise, 0.int type ()
WidgetTreeBox type.Return value
WidgetTreeBox type identifier.vec4 getItemColor (int item)
Returns a color set to a given item.Arguments
- int item - Item ID.
Return value
Color.int isEditable ()
Returns a value indicating if item hierarchy can be edited.Return value
1 if the hierarchy can be edited; otherwise, 0.void removeItem (int item)
Removes a given item from the tree box. Children items will be kept.Arguments
- int item - Item ID.
int getNumItemChildren (int item)
Returns the number of child items of a given item.Arguments
- int item - Item ID.
Return value
Number of child items.string getCurrentItemData ()
Returns the data of a given item.Return value
Item data.int isItemHidden (int item)
Returns a value indicating if an item is hidden or not.Arguments
- int item - Item ID.
Return value
1 if the item is hidden; otherwise, 0.void getImage (Image image)
Returns the image with mini-icons.Arguments
- Image image - Image with mini-icons (the vertical strip of square icons).
void removeItemChild (int item, int child)
Removes a child of a given item.Arguments
- int item - Item ID.
- int child - Child item ID.
void setItemSelected (int item, int selected)
Selects or deselects a given item.Arguments
- int item - Item ID.
- int selected - 1 to select the item, 0 to deselect it.
string getTexture ()
Returns file name of the image with mini-icons.Return value
Path to the texture file.int getNumSelectedItems ()
Returns number of selected items in the box.Return value
Number of selected items.void getItems (int items)
Returns all items in the tree box.Arguments
- int items - An array with item IDs.
Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)