UTFWin::ITreeView class
#include <Spore ModAPI/Spore/UTFWin/ITreeView.h>

Base classes

class UTFWinObject

Derived classes

class WinTreeView

Public types

enum ColorIndices { kColorText = 0, kColorBackground = 1, kColorDisabledText = 2, kColorDisabledBackground = 3, kColorSelectedText = 4, kColorSelectedBackground = 5, kColorHighlightedText = 6, kColorHighlightedBackground = 7, kColorConnectorLines = 8 }
enum Params { kParamIndentWidth = 0, kParamLineWidth = 1, kParamLineIndent = 2, kParamIconSpacing = 3 }

Public static variables

static const uint32_t TYPE

Public functions

auto ToWindow() -> IWindow* pure virtual
auto GetColor(int index) const -> Color pure virtual
Gets the color used for the specific component.
auto SetColor(int index, Color color) -> void pure virtual
Sets the color used for the specific component.
auto GetBorderWidth() const -> const Math::Rectangle& pure virtual
Gets the width of the borders.
auto SetBorderWidth(const Math::Rectangle& value) -> void pure virtual
Sets the width of the borders.
auto SetTreeViewFlag(int flag, bool value) -> void pure virtual
Sets the value of the specified tree view flag.
auto GetTreeViewFlags() const -> bool pure virtual
Gets the value of the tree view flags, which are the ITreeView::kFlag... values.
auto SetItemHeight(size_t value) -> void pure virtual
Sets the height of individual rows.
auto GetItemHeight() const -> size_t pure virtual
Gets the height of individual rows.
auto SetParameter(int paramIndex, size_t value) -> void pure virtual
Chagnes the value of the specified parameter, which can be one of the following: ITreeView::kParamIdentWidth, ITreeView::kParamLineWidth, ITreeView::kParamLineIndent and ITreeView::kParamIconSpacing.
auto GetParameter(int paramIndex) -> size_t pure virtual
Gets the value of the specified parameter, which can be one of the following: ITreeView::kParamIdentWidth, ITreeView::kParamLineWidth, ITreeView::kParamLineIndent and ITreeView::kParamIconSpacing.
auto SetDefaultIcon(IDrawable* pIconDrawable) -> void pure virtual
Sets the icon that is drawn by default on each item.
auto GetDefaultIcon() const -> IDrawable* pure virtual
Gets the icon that is drawn by default on each item.
auto SetExpanderDrawable(IDrawable* pExpanderDrawable) -> void pure virtual
Sets the IDrawable of the expander button that is rendered before every icon.
auto GetExpanderDrawable() const -> IDrawable* pure virtual
Gets the IDrawable of the expander button that is rendered before every icon.
auto GetRootNode() -> TreeNode& pure virtual

Function documentation

Color UTFWin::ITreeView::GetColor(int index) const pure virtual

Gets the color used for the specific component.

Parameters
index The component, in the ITreeView::kColor... values

void UTFWin::ITreeView::SetColor(int index, Color color) pure virtual

Sets the color used for the specific component.

Parameters
index The component, in the ITreeView::kColor... values
color The new color value.

void UTFWin::ITreeView::SetBorderWidth(const Math::Rectangle& value) pure virtual

Sets the width of the borders.

Parameters
value A Rectangle with the new borders width.

void UTFWin::ITreeView::SetTreeViewFlag(int flag, bool value) pure virtual

Sets the value of the specified tree view flag.

Parameters
flag The flag to set, one of the ITreeView::kFlag... values.
value The new bool value of that flag.

The flag must be one of the ITreeView::kFlag... values.

void UTFWin::ITreeView::SetItemHeight(size_t value) pure virtual

Sets the height of individual rows.

Parameters
value The new row height.

void UTFWin::ITreeView::SetParameter(int paramIndex, size_t value) pure virtual

Chagnes the value of the specified parameter, which can be one of the following: ITreeView::kParamIdentWidth, ITreeView::kParamLineWidth, ITreeView::kParamLineIndent and ITreeView::kParamIconSpacing.

Parameters
paramIndex The parameter to change.
value The new value of the parameter.

size_t UTFWin::ITreeView::GetParameter(int paramIndex) pure virtual

Gets the value of the specified parameter, which can be one of the following: ITreeView::kParamIdentWidth, ITreeView::kParamLineWidth, ITreeView::kParamLineIndent and ITreeView::kParamIconSpacing.

Parameters
paramIndex The parameter whose value will be returned.

void UTFWin::ITreeView::SetDefaultIcon(IDrawable* pIconDrawable) pure virtual

Sets the icon that is drawn by default on each item.

Parameters
pIconDrawable The IDrawable that will render the icon.

void UTFWin::ITreeView::SetExpanderDrawable(IDrawable* pExpanderDrawable) pure virtual

Sets the IDrawable of the expander button that is rendered before every icon.

Parameters
pExpanderDrawable The IDrawable that will render the icon (usually a TreeExpanderDrawable)