KSD_EXPORT_CLASSclass TWidgetTree

Manages a widget heirarchy.

Public Methods

[more]void Init(TWidget* root)
Initializes the widget tree to this root widget.
[more]void Add(TWidget* widget)
Inserts this widget into is proper location in the widget tree.
[more]void Remove(TWidget* widget)
Remove a widget and all of its children from the widget tree.
[more]TWidget* GetRoot()
Returns the root widget of this tree
[more]iterator begin()
Returns an iterator that points to the beginning of the widget tree
[more]iterator end()
Returns an iterator that points to the end of the widget tree
[more]layer_iterator layer_begin()
Returns a layer iterator that points to the beginning og the widget tree
[more]layer_iterator layer_end()
Returns a layer iterator that points to the end of the widget tree
[more]reverse_iterator rbegin()
Returns a reverse iterator that points to the end of the widget tree
[more]reverse_iterator rend()
Returns a reverse iterator that points to the end of the widget tree
[more]unsigned int size() const
Returns the number of widgets in this tree
[more]reverse_layer_iterator_range GetReverseLayerRange(iterator iter)
gets a reverse layer range
[more]iterator find_widget(TWidget* w)
Returns an iterator that points to the widget requested.
[more]void MoveUp(iterator i)
Moves this widget up one layer in the draw order
[more]void MoveToFront(iterator i)
Moves this widget to the top layer in the draw order


Documentation

Manages a widget heirarchy. This class is used to store and manipulate the relationships between the widgets. This is only used internally, and you should never have to deal with it directly.
ovoid Init(TWidget* root)
Initializes the widget tree to this root widget. A "root widget" is the only widget that is allowed to exist in the widget tree without a parent.

ovoid Add(TWidget* widget)
Inserts this widget into is proper location in the widget tree. All widgets must be dynamically allocated. The memory will be freed automatically this widget or one of its parents, is removed from the widget tree.

ovoid Remove(TWidget* widget)
Remove a widget and all of its children from the widget tree. De-allocates the widgets.

oTWidget* GetRoot()
Returns the root widget of this tree

oiterator begin()
Returns an iterator that points to the beginning of the widget tree

oiterator end()
Returns an iterator that points to the end of the widget tree

olayer_iterator layer_begin()
Returns a layer iterator that points to the beginning og the widget tree

olayer_iterator layer_end()
Returns a layer iterator that points to the end of the widget tree

oreverse_iterator rbegin()
Returns a reverse iterator that points to the end of the widget tree

oreverse_iterator rend()
Returns a reverse iterator that points to the end of the widget tree

ounsigned int size() const
Returns the number of widgets in this tree

oreverse_layer_iterator_range GetReverseLayerRange(iterator iter)
gets a reverse layer range

oiterator find_widget(TWidget* w)
Returns an iterator that points to the widget requested. If the widget is not in the tree, it will return end().

ovoid MoveUp(iterator i)
Moves this widget up one layer in the draw order

ovoid MoveToFront(iterator i)
Moves this widget to the top layer in the draw order


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.