Tree view widget. More...

#include <TGUI/Widgets/TreeView.hpp>

Inheritance diagram for tgui::TreeView:

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

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

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

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

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

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

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

void	expandAll ()
	Expands all items.

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

void	collapseAll ()
	Collapses all items.

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

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

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

void	removeAllItems ()
	Removes all items.

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

std::vector< ConstNode >	getNodes () 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	mouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

void	draw (sf::RenderTarget &target, sf::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 ()
	Default constructor.

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

	~Widget ()
	Destructor.

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

Widget &	operator= (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...

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

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

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...

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 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...

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time 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 std::string &	getWidgetType () const
	Returns the type of the widget. More...

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

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

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

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

void	setUserData (std::any userData)
	Stores some data into the widget. More...

template<typename T >
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 Font &	getInheritedFont () 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 sf::String &name)
	Changes the name of a widget. More...

sf::String	getWidgetName () const
	Returns the name of a 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...

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)> >::value >::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, const Args &... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, BoundArgs &&... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, BoundArgs &&... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs>
unsigned int	connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
	Connect a signal handler to multiple signals. More...

bool	disconnect (unsigned int id)
	Disconnects a signal handler. More...

void	disconnectAll (std::string signalName)
	Disconnects all signal handler from a certain signal. More...

void	disconnectAll ()
	Disconnects all signal handlers from signals.

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.

SignalAnimation	onAnimationFinished = {"AnimationFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
Signal &	getSignal (std::string signalName) override
	Retrieves a signal based on its name. More...

void	rendererChanged (const std::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.

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

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type. More...

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.

Additional Inherited Members
Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

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

Detailed Description

Tree view widget.

Member Function Documentation

◆ addItem()

bool tgui::TreeView::addItem	(	const std::vector< sf::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)

◆ 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< sf::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 ( TreeView::ConstPtr treeView )

static

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

static

Creates a new tree view widget.

Returns: The new tree view

◆ draw()

void tgui::TreeView::draw	(	sf::RenderTarget &	target,
		sf::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< sf::String > & hierarchy )

Expands the given item.

Parameters

hierarchy Hierarchy 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< sf::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 ( std::string signalName )

overrideprotectedvirtual

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.

◆ getVerticalScrollbarValue()

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

Returns the thumb position of the vertical scrollbar.

Returns: Value of the vertical scrollbar

◆ mouseOnWidget()

bool tgui::TreeView::mouseOnWidget ( 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.

◆ removeItem()

bool tgui::TreeView::removeItem	(	const std::vector< sf::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 std::string & property )

overrideprotectedvirtual

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

Parameters

property Lowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ selectItem()

bool tgui::TreeView::selectItem ( const std::vector< sf::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

◆ setSize() [1/3]

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

virtual

Changes the size of the widget.

Parameters

size	Size 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});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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() [3/3]

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

◆ setTextSize()

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

overridevirtual

Changes the text size of the items.

Parameters

textSize The 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

value New value of the vertical scrollbar

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

include/TGUI/Widgets/TreeView.hpp

TGUI

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addItem()

◆ clone()

◆ collapse()

◆ copy()

◆ create()

◆ draw()

◆ expand()

◆ getHorizontalScrollbarValue()

◆ getItemHeight()

◆ getNodes()

◆ getRenderer()

◆ getSelectedItem()

◆ getSharedRenderer()

◆ getSignal()

◆ getVerticalScrollbarValue()

◆ mouseOnWidget()

◆ removeItem()

◆ rendererChanged()

◆ selectItem()

◆ setHorizontalScrollbarValue()

◆ setItemHeight()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setTextSize()

◆ setVerticalScrollbarValue()