C4 Engine
C4 Engine API Documentation

class TreeWidget

Defined in:  C4Widgets.h
The TreeWidget class represents an interface widget that displays a tree list.

class TreeWidget final : public ListWidget

Member Functions
TreeWidget::GetIndentSpacing Returns the subitem indent spacing.
TreeWidget::SetIndentSpacing Sets the subitem indent spacing.
TreeWidget::PrependTreeItem Adds an item to the beginning of a tree.
TreeWidget::AppendTreeItem Adds an item to the end of a tree.

TreeWidget(const Vector2D& size, float spacing = 13.0F, const char *font = "font/Regular", float em = kDefaultFontSize);

size The size of the tree box, in pixels.
spacing The vertical distance from between one tree item and the next.
font The name of the font in which text-only tree items are displayed.
em The em size of the font, in pixels.
The TreeWidget class is used to display a box that contains a hierarchical tree of other widgets shown in a scrollable list. The members of a tree widget are always widgets of the type TreeItemWidget.

The default widget color corresponds to the kWidgetColorBorder color type and determines the color of the tree's border. Other color types supported by the tree widget are kWidgetColorBackground and kWidgetColorHilite. If a highlight color has not been explicitly specified, then the Interface Manager's global highlight color is used.
Base Classes
ListWidget The tree widget is a specific type of ListWidget.
See Also



Wiki Articles

Tree Widget