Tree view widget. More...

#include <TGUI/Widgets/TreeView.hpp>

Inheritance diagram for tgui::TreeView:

Classes
struct	ConstNode
	Read-only node representation used by getNode and getNodes. More...

struct	Node
	Internal representation of a node. More...

Public Types
using	Ptr = std::shared_ptr<TreeView>

using	ConstPtr = std::shared_ptr<const TreeView>

Public Types inherited from tgui::Widget
using	Ptr = std::shared_ptr<Widget>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Widget>
	Shared constant widget pointer.

Public Member Functions
	TreeView (const char *typeName=StaticWidgetType, bool initRenderer=true)

	TreeView (const TreeView &)

	TreeView (TreeView &&)=default

TreeView &	operator= (const TreeView &)

TreeView &	operator= (TreeView &&)=default

TreeViewRenderer *	getSharedRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const TreeViewRenderer *	getSharedRenderer () const override

TreeViewRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

void	setSize (const Layout2d &size) override
	Changes the size of the tree view.

bool	addItem (const std::vector< String > &hierarchy, bool createParents=true)
	Adds a new item to the tree view.

bool	changeItem (const std::vector< String > &hierarchy, const String &leafText)
	Changes the text of a leaf item.

void	expand (const std::vector< String > &hierarchy)
	Expands the given item.

void	expandAll ()
	Expands all items.

void	collapse (const std::vector< String > &hierarchy)
	Collapses the given item.

void	collapseAll ()
	Collapses all items.

bool	selectItem (const std::vector< String > &hierarchy)
	Selects an item in the tree view.

void	deselectItem ()
	Deselect the item if one was selected.

bool	removeItem (const std::vector< String > &hierarchy, bool removeParentsWhenEmpty=true)
	Removes an item.

void	removeAllItems ()
	Removes all items.

std::vector< String >	getSelectedItem () const
	Returns the selected item.

std::vector< String >	getHoveredItem () const
	Returns the item currently below the mouse cursor.

bool	setItemIndexInParent (const std::vector< String > &hierarchy, std::size_t index)
	Sets the index of an item, based on the items that share the same parent.

int	getItemIndexInParent (const std::vector< String > &hierarchy) const
	Returns the index of an item, based on the items that share the same parent.

bool	changeItemHierarchy (const std::vector< String > &oldHierarchy, const std::vector< String > &newHierarchy)
	Moves one item and its children from one location in the hierarchy to a completely different location.

ConstNode	getNode (const std::vector< String > &hierarchy) const
	Returns the node in the tree view at a given hierarchy.

std::vector< ConstNode >	getNodes () const
	Returns the nodes in the tree view.

void	setItemHeight (unsigned int itemHeight)
	Changes the height of the items in the tree view.

unsigned int	getItemHeight () const
	Returns the height of the items in the tree view.

void	setVerticalScrollbarValue (unsigned int value)
	Changes the thumb position of the vertical scrollbar.

unsigned int	getVerticalScrollbarValue () const
	Returns the thumb position of the vertical scrollbar.

unsigned int	getVerticalScrollbarMaxValue () const
	Returns the maximum thumb position of the vertical scrollbar.

void	setHorizontalScrollbarValue (unsigned int value)
	Changes the thumb position of the horizontal scrollbar.

unsigned int	getHorizontalScrollbarValue () const
	Returns the thumb position of the horizontal scrollbar.

unsigned int	getHorizontalScrollbarMaxValue () const
	Returns the maximum thumb position of the horizontal scrollbar.

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	leftMouseReleased (Vector2f pos) override

void	rightMousePressed (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

bool	scrolled (float delta, Vector2f pos, bool touch) override
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

void	keyPressed (const Event::KeyEvent &event) override

bool	canHandleKeyPress (const Event::KeyEvent &event) override
	Called by the parent of the widget to check if keyPressed would process the event.

void	markNodesDirty ()

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&) noexcept
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

bool	isEnabled () const
	Returns true when the widget is enabled.

virtual void	setFocused (bool focused)
	Focus or unfocus the widget.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename DataType >
DataType	getUserData () const
	Returns data stored in the widget.

bool	hasUserData () const
	Returns whether data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual void	setParent (Container *parent)

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual void	rightMouseReleased (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 Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () 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.

void	rendererChangedCallback (const String &property)

Public Member Functions inherited from tgui::DualScrollbarChildInterface
	DualScrollbarChildInterface ()
	Default constructor.

	DualScrollbarChildInterface (const DualScrollbarChildInterface &)
	Copy constructor.

	DualScrollbarChildInterface (DualScrollbarChildInterface &&) noexcept
	Move constructor.

virtual	~DualScrollbarChildInterface ()=default
	Destructor.

DualScrollbarChildInterface &	operator= (const DualScrollbarChildInterface &)
	Overload of copy assignment operator.

DualScrollbarChildInterface &	operator= (DualScrollbarChildInterface &&) noexcept
	Move assignment.

ScrollbarAccessor *	getVerticalScrollbar ()
	Returns an object that provides access to the widget's vertical scrollbar.

const ScrollbarAccessor *	getVerticalScrollbar () const
	Returns an object that provides access to the widget's vertical scrollbar.

ScrollbarAccessor *	getHorizontalScrollbar ()
	Returns an object that provides access to the widget's horizontal scrollbar.

const ScrollbarAccessor *	getHorizontalScrollbar () const
	Returns an object that provides access to the widget's horizontal scrollbar.

Static Public Member Functions
static TreeView::Ptr	create ()
	Creates a new tree view widget.

static TreeView::Ptr	copy (const TreeView::ConstPtr &treeView)
	Makes a copy of another tree view.

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	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "TreeView"
	Type name of the widget.

Protected Member Functions
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

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.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

void	scrollbarPolicyChanged (Orientation orientation) override
	Called when the policy of one of the scrollbars has been changed calling either getVerticalScrollbar()->setPolicy(...) or getHorizontalScrollbar()->setPolicy(...)

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.

void	updateTextColors (std::vector< std::shared_ptr< Node > > &nodes)

void	createNode (std::vector< std::shared_ptr< Node > > &menus, Node *parent, const String &text)

Node *	findParentNode (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.

virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Member Functions inherited from tgui::DualScrollbarChildInterface
virtual void	scrollbarValueChanged (Orientation orientation)
	Called when the value of one of the scrollbars has been changed by calling either getVerticalScrollbar()->setValue(...) or getHorizontalScrollbar()->setValue(...)

virtual void	scrollbarScrollAmountChanged (Orientation orientation)
	Called when the scroll amount of one of the scrollbars has been changed calling either getVerticalScrollbar()->setScrollAmount(...) or getHorizontalScrollbar()->setScrollAmount(...)

void	saveScrollbarPolicies (std::unique_ptr< DataIO::Node > &node) const
	This function should be called inside the save function in order to save the configured scrollbar policies.

void	loadScrollbarPolicies (const std::unique_ptr< DataIO::Node > &node)
	This function should be called inside the load function in order to load the wanted scrollbar policies.

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

float	m_maxRight = 0

Vector2f	m_iconBounds

bool	m_possibleDoubleClick = false

int	m_doubleClickNodeIndex = -1

Sprite	m_spriteBackground

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
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_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
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Protected Attributes inherited from tgui::DualScrollbarChildInterface
CopiedSharedPtr< ScrollbarChildWidget >	m_verticalScrollbar

CopiedSharedPtr< ScrollbarChildWidget >	m_horizontalScrollbar

ScrollbarAccessor	m_verticalScrollbarAccessor

ScrollbarAccessor	m_horizontalScrollbarAccessor

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

hierarchy	Hierarchy of items, with the last item being the leaf item
createParents	Should the hierarchy be created if it did not exist yet?

Returns: True when the item was added (always the case if createParents is true)

Example code:

treeView->addItem({"Smilies", "Happy"});
treeView->addItem({"Smilies", "Sad"});
treeView->addItem({"Smilies", "Neither"});
treeView->addItem({"Vehicles", "Parts", "Wheel"});
treeView->addItem({"Vehicles", "Whole", "Truck"});
treeView->addItem({"Vehicles", "Whole", "Car"});

◆ canHandleKeyPress()

bool tgui::TreeView::canHandleKeyPress ( const Event::KeyEvent & event )

overridevirtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters

event Key event that took place

Returns: True if the event would be handled by the widget, false if the key event doesn't affect the widget

Since: TGUI 1.1

Reimplemented from tgui::Widget.

◆ changeItem()

bool tgui::TreeView::changeItem	(	const std::vector< String > &	hierarchy,
		const String &	leafText )

Changes the text of a leaf item.

Parameters

hierarchy	Hierarchy of items, with the last item being the leaf item that should be renamed
leafText	New text to put in the leaf item

Returns: True when the item was renamed, false if no item matched with the given hierarchy

Example code:

treeView->changeItem({"Vehicles", "Whole", "Car"}, "Train"); // Changes the item to {"Vehicles", "Whole", "Train"}

Since: TGUI 1.2

◆ changeItemHierarchy()

bool tgui::TreeView::changeItemHierarchy	(	const std::vector< String > &	oldHierarchy,
		const std::vector< String > &	newHierarchy )

Moves one item and its children from one location in the hierarchy to a completely different location.

Parameters

oldHierarchy	The item that needs to be moved
newHierarchy	The new location of the item

Returns: True if the node was moved, false if oldHierarchy wasn't found or newHierarchy without the last element wasn't found

Example. Suppose you have the following tree:

A
  A1
    A1_1
    A1_2
  A2
B
  B1

Calling changeItemHierarchy({"A", "A1"}, {"B", "X"}) will result in the following tree:

A
  A2
B
  B1
  X
    A1_1
    A1_2

Since: TGUI 1.5

◆ clone()

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

nodiscardoverrideprotectedvirtual

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

hierarchy Hierarchy of items, identifying the node that has to be collapsed

◆ copy()

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

staticnodiscard

Makes a copy of another tree view.

Parameters

treeView The other tree view

Returns: The new tree view

◆ create()

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

staticnodiscard

Creates a new tree view widget.

Returns: The new tree view

◆ draw()

void tgui::TreeView::draw	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

◆ expand()

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

Expands the given item.

Parameters

hierarchy Hierarchy of items, identifying the node that has to be expanded

◆ getHorizontalScrollbarMaxValue()

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

nodiscard

Returns the maximum thumb position of the horizontal scrollbar.

Returns: Maximum value of the horizontal scrollbar

Since: TGUI 1.4

◆ getHorizontalScrollbarValue()

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

nodiscard

Returns the thumb position of the horizontal scrollbar.

Returns: Value of the horizontal scrollbar

◆ getHoveredItem()

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

nodiscard

Returns the item currently below the mouse cursor.

Returns: Hierarchy of items, identifying the node below the mouse, or an empty list when the mouse isn't on any item

Since: TGUI 1.5

◆ getItemHeight()

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

nodiscard

Returns the height of the items in the tree view.

Returns: The item height

◆ getItemIndexInParent()

int tgui::TreeView::getItemIndexInParent ( const std::vector< String > & hierarchy ) const

Returns the index of an item, based on the items that share the same parent.

Parameters

hierarchy Hierarchy of items, with the last element being the leaf item

Returns: The index of the item identified by the hierarchy, when only looking at items where only the last element of the hierarchy is different. Returns -1 if the hierarchy parameter didn't match an item in the tree view.

In the following example, both A, A1 and B1 would have index 0, while B and A2 would have index 1.

A
  A1
  A2
B
  B1

Since: TGUI 1.5

◆ getNode()

ConstNode tgui::TreeView::getNode ( const std::vector< String > & hierarchy ) const

nodiscard

Returns the node in the tree view at a given hierarchy.

Parameters

hierarchy Hierarchy of items, identifying the node to retrieve

Returns: Node that was identified by the hierarchy

If no node exists at the given hierarchy, the returned node will have an empty text and no children. If the node was found, its text property will always match with the last element of the hierarchy.

Since: TGUI 1.2

◆ getNodes()

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

nodiscard

Returns the nodes in the tree view.

Returns: List of nodes

◆ getRenderer()

TreeViewRenderer * tgui::TreeView::getRenderer ( )

nodiscardoverridevirtual

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.

Reimplemented from tgui::Widget.

◆ getSelectedItem()

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

nodiscard

Returns the selected item.

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

◆ getSharedRenderer() [1/2]

const TreeViewRenderer * tgui::TreeView::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TreeViewRenderer * tgui::TreeView::getSharedRenderer ( )

nodiscardoverridevirtual

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

Reimplemented from tgui::Widget.

◆ getSignal()

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

nodiscardoverrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::Widget.

◆ getVerticalScrollbarMaxValue()

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

nodiscard

Returns the maximum thumb position of the vertical scrollbar.

Returns: Maximum value of the vertical scrollbar

Since: TGUI 1.4

◆ getVerticalScrollbarValue()

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

nodiscard

Returns the thumb position of the vertical scrollbar.

Returns: Value of the vertical scrollbar

◆ isMouseOnWidget()

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

nodiscardoverridevirtual

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()

bool tgui::TreeView::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns: True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

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.

◆ removeItem()

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

Removes an item.

Parameters

hierarchy	Hierarchy of items, identifying the node to be removed
removeParentsWhenEmpty	Also 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

property Name 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

nodiscardoverrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ scrollbarPolicyChanged()

void tgui::TreeView::scrollbarPolicyChanged ( Orientation orientation )

overrideprotectedvirtual

Called when the policy of one of the scrollbars has been changed calling either getVerticalScrollbar()->setPolicy(...) or getHorizontalScrollbar()->setPolicy(...)

Parameters

orientation Vertical or Horizontal depending on which scrollbar triggered the callback

Reimplemented from tgui::DualScrollbarChildInterface.

◆ scrolled()

bool tgui::TreeView::scrolled	(	float	delta,
		Vector2f	pos,
		bool	touch )

overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters

delta	Scroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
pos	Mouse position, or the initial position of the touch events
touch	Was this a touch event or a mouse wheel scroll?

Returns: Was the scrolling was handled by the widget?

Reimplemented from tgui::Widget.

◆ selectItem()

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

Selects an item in the tree view.

Parameters

hierarchy Hierarchy 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

value New value of the horizontal scrollbar

◆ setItemHeight()

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

Changes the height of the items in the tree view.

Parameters

itemHeight The size of a single item in the tree view

◆ setItemIndexInParent()

bool tgui::TreeView::setItemIndexInParent	(	const std::vector< String > &	hierarchy,
		std::size_t	index )

Sets the index of an item, based on the items that share the same parent.

Parameters

hierarchy	Hierarchy of items, with the last element being the leaf item
index	The index that the item should have, when only looking at items where only the last element of the hierarchy is different. Passing a number that is too high will just move the item to the back, as if you passed to maximum valid number. Passing 0 moves the item to the front.

Returns: True if the hierarchy matched an item in the tree view, false otherwise.

See also: getItemIndexInParent

Since: TGUI 1.5

◆ setSize() [1/2]

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

overridevirtual

Changes the size of the tree view.

Parameters

size	The new size of the tree view

Reimplemented from tgui::Widget.

◆ setSize() [2/2]

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

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setVerticalScrollbarValue()

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

Changes the thumb position of the vertical scrollbar.

Parameters

value New value of the vertical scrollbar

◆ updateTextSize()

void tgui::TreeView::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

◆ updateTime()

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

overrideprotectedvirtual

Reimplemented from tgui::Widget.

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

include/TGUI/Widgets/TreeView.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addItem()

◆ canHandleKeyPress()

◆ changeItem()

◆ changeItemHierarchy()

◆ clone()

◆ collapse()

◆ copy()

◆ create()

◆ draw()

◆ expand()

◆ getHorizontalScrollbarMaxValue()

◆ getHorizontalScrollbarValue()

◆ getHoveredItem()

◆ getItemHeight()

◆ getItemIndexInParent()

◆ getNode()

◆ getNodes()

◆ getRenderer()

◆ getSelectedItem()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ getVerticalScrollbarMaxValue()

◆ getVerticalScrollbarValue()

◆ isMouseOnWidget()

◆ keyPressed()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ removeItem()

◆ rendererChanged()

◆ rightMousePressed()

◆ save()

◆ scrollbarPolicyChanged()

◆ scrolled()

◆ selectItem()

◆ setHorizontalScrollbarValue()

◆ setItemHeight()

◆ setItemIndexInParent()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setVerticalScrollbarValue()

◆ updateTextSize()

◆ updateTime()