TGUI  0.9.3

Tree view widget. More...

#include <TGUI/Widgets/TreeView.hpp>

Inheritance diagram for tgui::TreeView:
tgui::Widget

Classes

struct  ConstNode
 Read-only node representation used by getNodes. More...
 
struct  Node
 Internal representation of a node. More...
 

Public Types

typedef std::shared_ptr< TreeViewPtr
 
typedef std::shared_ptr< const TreeViewConstPtr
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 TreeView (const char *typeName="TreeView", bool initRenderer=true)
 
 TreeView (const TreeView &)
 
 TreeView (TreeView &&)=default
 
TreeViewoperator= (const TreeView &)
 
TreeViewoperator= (TreeView &&)=default
 
TreeViewRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const TreeViewRenderergetSharedRenderer () const
 
TreeViewRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const TreeViewRenderergetRenderer () const
 
void setSize (const Layout2d &size) override
 Changes the size of the tree view. More...
 
bool addItem (const std::vector< String > &hierarchy, bool createParents=true)
 Adds a new item to the tree view. More...
 
void expand (const std::vector< String > &hierarchy)
 Expands the given item. More...
 
void expandAll ()
 Expands all items.
 
void collapse (const std::vector< String > &hierarchy)
 Collapses the given item. More...
 
void collapseAll ()
 Collapses all items.
 
bool selectItem (const std::vector< String > &hierarchy)
 Selects an item in the tree view. More...
 
void deselectItem ()
 Deselect the item if one was selected.
 
bool removeItem (const std::vector< String > &hierarchy, bool removeParentsWhenEmpty=true)
 Removes an item. More...
 
void removeAllItems ()
 Removes all items.
 
std::vector< StringgetSelectedItem () const
 Returns the selected item. More...
 
std::vector< ConstNodegetNodes () const
 Returns the nodes in the tree view. More...
 
void setItemHeight (unsigned int itemHeight)
 Changes the height of the items in the tree view. More...
 
unsigned int getItemHeight () const
 Returns the height of the items in the tree view. More...
 
void setTextSize (unsigned int textSize) override
 Changes the text size of the items. More...
 
void setVerticalScrollbarValue (unsigned int value)
 Changes the thumb position of the vertical scrollbar. More...
 
unsigned int getVerticalScrollbarValue () const
 Returns the thumb position of the vertical scrollbar. More...
 
void setHorizontalScrollbarValue (unsigned int value)
 Changes the thumb position of the horizontal scrollbar. More...
 
unsigned int getHorizontalScrollbarValue () const
 Returns the thumb position of the horizontal scrollbar. More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void keyPressed (const Event::KeyEvent &event) override
 
void markNodesDirty ()
 
void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetRenderer () const
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
GuiBasegetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual void setParent (Container *parent)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void textEntered (char32_t key)
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

static TreeView::Ptr create ()
 Creates a new tree view widget. More...
 
static TreeView::Ptr copy (TreeView::ConstPtr treeView)
 Makes a copy of another tree view. More...
 

Public Attributes

SignalItemHierarchy onItemSelect = {"ItemSelected"}
 An node was selected in the tree view. Optional parameter: selected node.
 
SignalItemHierarchy onDoubleClick = {"DoubleClicked"}
 A leaf node was double clicked. Optional parameter: selected node.
 
SignalItemHierarchy onExpand = {"Expanded"}
 A branch node was expanded in the tree view. Optional parameter: expanded node.
 
SignalItemHierarchy onCollapse = {"Collapsed"}
 A branch node was collapsed in the tree view. Optional parameter: collapsed node.
 
SignalItemHierarchy onRightClick = {"RightClicked"}
 A node was right clicked. Optional parameter: node below mouse.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalShowEffect onAnimationFinish = {"AnimationFinished"}
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Vector2f getInnerSize () const
 
void updateIconBounds ()
 
bool updateTime (Duration elapsedTime) override
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
void updateTextColors (std::vector< std::shared_ptr< Node > > &nodes)
 
void createNode (std::vector< std::shared_ptr< Node > > &menus, Node *parent, const String &text)
 
NodefindParentNode (const std::vector< String > &hierarchy, unsigned int parentIndex, std::vector< std::shared_ptr< Node > > &nodes, Node *parent, bool createParents)
 
void toggleNodeInternal (std::size_t index)
 
bool expandOrCollapse (const std::vector< String > &hierarchy, bool expand)
 
void loadItems (const std::unique_ptr< DataIO::Node > &node, std::vector< std::shared_ptr< Node > > &items, Node *parent)
 
unsigned int updateVisibleNodes (std::vector< std::shared_ptr< Node > > &nodes, Node *selectedNode, float textPadding, unsigned int pos)
 
void updateSelectedAndHoveringItemColors ()
 
void updateHoveredItem (int item)
 
void updateSelectedItem (int item)
 
- Protected Member Functions inherited from tgui::Widget
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

Protected Attributes

std::vector< std::shared_ptr< Node > > m_nodes
 
std::vector< std::shared_ptr< Node > > m_visibleNodes
 
int m_selectedItem = -1
 
int m_hoveredItem = -1
 
unsigned int m_itemHeight = 0
 
unsigned int m_requestedTextSize = 0
 
float m_maxRight = 0
 
Vector2f m_iconBounds
 
CopiedSharedPtr< ScrollbarChildWidgetm_verticalScrollbar
 
CopiedSharedPtr< ScrollbarChildWidgetm_horizontalScrollbar
 
bool m_possibleDoubleClick = false
 
int m_doubleClickNodeIndex = -1
 
Sprite m_spriteBranchExpanded
 
Sprite m_spriteBranchCollapsed
 
Sprite m_spriteLeaf
 
Borders m_bordersCached
 
Borders m_paddingCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Color m_textColorCached
 
Color m_textColorHoverCached
 
Color m_selectedTextColorCached
 
Color m_selectedTextColorHoverCached
 
Color m_selectedBackgroundColorCached
 
Color m_selectedBackgroundColorHoverCached
 
Color m_backgroundColorHoverCached
 
TextStyles m_textStyleCached
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 
bool m_visible = true
 
Containerm_parent = nullptr
 
GuiBasem_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
std::function< void(const String &property)> m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }
 

Additional Inherited Members

- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
 
using LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
 

Detailed Description

Tree view widget.

Member Function Documentation

◆ addItem()

bool tgui::TreeView::addItem ( const std::vector< String > &  hierarchy,
bool  createParents = true 
)

Adds a new item to the tree view.

Parameters
hierarchyHierarchy of items, with the last item being the leaf item
createParentsShould the hierarchy be created if it did not exist yet?
Returns
True when the item was added (always the case if createParents is true)

◆ clone()

Widget::Ptr tgui::TreeView::clone ( ) const
inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Implements tgui::Widget.

◆ collapse()

void tgui::TreeView::collapse ( const std::vector< String > &  hierarchy)

Collapses the given item.

Parameters
hierarchyHierarchy of items, identifying the node that has to be collapsed

◆ copy()

static TreeView::Ptr tgui::TreeView::copy ( TreeView::ConstPtr  treeView)
static

Makes a copy of another tree view.

Parameters
treeViewThe other tree view
Returns
The new tree view

◆ create()

static TreeView::Ptr tgui::TreeView::create ( )
static

Creates a new tree view widget.

Returns
The new tree view

◆ draw()

void tgui::TreeView::draw ( BackendRenderTargetBase target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ expand()

void tgui::TreeView::expand ( const std::vector< String > &  hierarchy)

Expands the given item.

Parameters
hierarchyHierarchy of items, identifying the node that has to be expanded

◆ getHorizontalScrollbarValue()

unsigned int tgui::TreeView::getHorizontalScrollbarValue ( ) const

Returns the thumb position of the horizontal scrollbar.

Returns
Value of the horizontal scrollbar

◆ getItemHeight()

unsigned int tgui::TreeView::getItemHeight ( ) const

Returns the height of the items in the tree view.

Returns
The item height

◆ getNodes()

std::vector< ConstNode > tgui::TreeView::getNodes ( ) const

Returns the nodes in the tree view.

Returns
List of nodes

◆ getRenderer()

TreeViewRenderer * tgui::TreeView::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSelectedItem()

std::vector< String > tgui::TreeView::getSelectedItem ( ) const

Returns the selected item.

Returns
Hierarchy of items, identifying the selected node, or an empty list when no item was selected

◆ getSharedRenderer()

TreeViewRenderer * tgui::TreeView::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal & tgui::TreeView::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getVerticalScrollbarValue()

unsigned int tgui::TreeView::getVerticalScrollbarValue ( ) const

Returns the thumb position of the vertical scrollbar.

Returns
Value of the vertical scrollbar

◆ isMouseOnWidget()

bool tgui::TreeView::isMouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ keyPressed()

void tgui::TreeView::keyPressed ( const Event::KeyEvent event)
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::TreeView::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

void tgui::TreeView::leftMousePressed ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::TreeView::leftMouseReleased ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::TreeView::mouseMoved ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::TreeView::mouseNoLongerOnWidget ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseWheelScrolled()

bool tgui::TreeView::mouseWheelScrolled ( float  delta,
Vector2f  pos 
)
overridevirtual

Reimplemented from tgui::Widget.

◆ removeItem()

bool tgui::TreeView::removeItem ( const std::vector< String > &  hierarchy,
bool  removeParentsWhenEmpty = true 
)

Removes an item.

Parameters
hierarchyHierarchy of items, identifying the node to be removed
removeParentsWhenEmptyAlso delete the parent of the deleted item if it has no other children
Returns
True when the item existed and was removed, false when hierarchy was incorrect

◆ rendererChanged()

void tgui::TreeView::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ rightMousePressed()

void tgui::TreeView::rightMousePressed ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::TreeView::save ( SavingRenderersMap &  renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ selectItem()

bool tgui::TreeView::selectItem ( const std::vector< String > &  hierarchy)

Selects an item in the tree view.

Parameters
hierarchyHierarchy of items, with the last item being the leaf item, which is being selected
Returns
True when the item was selected, false when hierarchy was incorrect

◆ setHorizontalScrollbarValue()

void tgui::TreeView::setHorizontalScrollbarValue ( unsigned int  value)

Changes the thumb position of the horizontal scrollbar.

Parameters
valueNew value of the horizontal scrollbar

◆ setItemHeight()

void tgui::TreeView::setItemHeight ( unsigned int  itemHeight)

Changes the height of the items in the tree view.

Parameters
itemHeightThe size of a single item in the tree view

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::TreeView::setSize ( const Layout2d size)
overridevirtual

Changes the size of the tree view.

Parameters
sizeThe new size of the tree view

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTextSize()

void tgui::TreeView::setTextSize ( unsigned int  textSize)
overridevirtual

Changes the text size of the items.

Parameters
textSizeThe size size of the text

This will not change the height that each item has. When passing 0 to this function, the text will be auto-sized to nicely fit inside this item height.

See also
setItemHeight

Reimplemented from tgui::Widget.

◆ setVerticalScrollbarValue()

void tgui::TreeView::setVerticalScrollbarValue ( unsigned int  value)

Changes the thumb position of the vertical scrollbar.

Parameters
valueNew value of the vertical scrollbar

◆ updateTime()

bool tgui::TreeView::updateTime ( Duration  elapsedTime)
overrideprotectedvirtual

Reimplemented from tgui::Widget.


The documentation for this class was generated from the following file: