25#ifndef TGUI_TREE_VIEW_HPP
26#define TGUI_TREE_VIEW_HPP
28#include <TGUI/CopiedSharedPtr.hpp>
29#include <TGUI/Widgets/Scrollbar.hpp>
30#include <TGUI/Renderers/TreeViewRenderer.hpp>
31#include <TGUI/Text.hpp>
35TGUI_MODULE_EXPORT
namespace tgui
44 using Ptr = std::shared_ptr<TreeView>;
45 using ConstPtr = std::shared_ptr<const TreeView>;
47 static constexpr const char StaticWidgetType[] =
"TreeView";
54 std::vector<ConstNode> nodes;
61 unsigned int depth = 0;
63 Node* parent =
nullptr;
64 std::vector<std::shared_ptr<Node>> nodes;
74 TreeView(
const char* typeName = StaticWidgetType,
bool initRenderer =
true);
100 TGUI_NODISCARD
static TreeView::Ptr
create();
107 TGUI_NODISCARD
static TreeView::Ptr
copy(
const TreeView::ConstPtr& treeView);
128 using Widget::setSize;
148 bool addItem(
const std::vector<String>& hierarchy,
bool createParents =
true);
172 void expand(
const std::vector<String>& hierarchy);
184 void collapse(
const std::vector<String>& hierarchy);
213 bool removeItem(
const std::vector<String>& hierarchy,
bool removeParentsWhenEmpty =
true);
244 TGUI_NODISCARD std::vector<ConstNode>
getNodes()
const;
319 void leftMouseReleased(
Vector2f pos)
override;
324 void rightMousePressed(
Vector2f pos)
override;
329 void mouseMoved(
Vector2f pos)
override;
339 void mouseNoLongerOnWidget()
override;
344 void leftMouseButtonNoLongerDown()
override;
365 void markNodesDirty();
399 TGUI_NODISCARD std::unique_ptr<DataIO::Node>
save(SavingRenderersMap& renderers)
const override;
404 void load(
const std::unique_ptr<DataIO::Node>& node,
const LoadingRenderersMap& renderers)
override;
414 TGUI_NODISCARD
Vector2f getInnerSize()
const;
419 void updateIconBounds();
424 bool updateTime(
Duration elapsedTime)
override;
434 void updateTextColors(std::vector<std::shared_ptr<Node>>& nodes);
439 void createNode(std::vector<std::shared_ptr<Node>>& menus,
Node* parent,
const String& text);
444 TGUI_NODISCARD
Node* findParentNode(
const std::vector<String>& hierarchy,
unsigned int parentIndex, std::vector<std::shared_ptr<Node>>& nodes,
Node* parent,
bool createParents);
449 void toggleNodeInternal(std::size_t index);
454 bool expandOrCollapse(
const std::vector<String>& hierarchy,
bool expand);
459 void loadItems(
const std::unique_ptr<DataIO::Node>& node, std::vector<std::shared_ptr<Node>>& items,
Node* parent);
464 unsigned int updateVisibleNodes(std::vector<std::shared_ptr<Node>>& nodes,
Node* selectedNode,
float textPadding,
unsigned int pos);
469 void updateSelectedAndHoveringItemColors();
474 void updateHoveredItem(
int item);
479 void updateSelectedItem(
int item);
494 std::vector<std::shared_ptr<Node>> m_nodes;
495 std::vector<std::shared_ptr<Node>> m_visibleNodes;
497 int m_selectedItem = -1;
498 int m_hoveredItem = -1;
500 unsigned int m_itemHeight = 0;
501 float m_maxRight = 0;
508 bool m_possibleDoubleClick =
false;
509 int m_doubleClickNodeIndex = -1;
511 Sprite m_spriteBackground;
512 Sprite m_spriteBranchExpanded;
513 Sprite m_spriteBranchCollapsed;
519 Color m_borderColorCached;
520 Color m_backgroundColorCached;
521 Color m_textColorCached;
522 Color m_textColorHoverCached;
523 Color m_selectedTextColorCached;
524 Color m_selectedTextColorHoverCached;
525 Color m_selectedBackgroundColorCached;
526 Color m_selectedBackgroundColorHoverCached;
527 Color m_backgroundColorHoverCached;
Base class for render targets.
Definition BackendRenderTarget.hpp:46
Wrapper for colors.
Definition Color.hpp:73
Definition CopiedSharedPtr.hpp:42
Wrapper for durations.
Definition Duration.hpp:55
Class to store the position or size of a widget.
Definition Layout.hpp:313
Definition Outline.hpp:38
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:61
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:1060
Wrapper class to store strings.
Definition String.hpp:96
Backend-independent wrapper around the backend-specific text class.
Definition Text.hpp:48
Wrapper for text styles.
Definition TextStyle.hpp:55
Tree view widget.
Definition TreeView.hpp:41
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
TGUI_NODISCARD TreeViewRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
TGUI_NODISCARD ConstNode getNode(const std::vector< String > &hierarchy) const
Returns the node in the tree view at a given hierarchy.
void deselectItem()
Deselect the item if one was selected.
TGUI_NODISCARD Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
bool addItem(const std::vector< String > &hierarchy, bool createParents=true)
Adds a new item to the tree view.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
static TGUI_NODISCARD TreeView::Ptr create()
Creates a new tree view widget.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
void collapseAll()
Collapses all items.
void collapse(const std::vector< String > &hierarchy)
Collapses the given item.
bool changeItem(const std::vector< String > &hierarchy, const String &leafText)
Changes the text of a leaf item.
bool selectItem(const std::vector< String > &hierarchy)
Selects an item in the tree view.
TGUI_NODISCARD std::vector< String > getSelectedItem() const
Returns the selected item.
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 touch...
TGUI_NODISCARD 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.
TGUI_NODISCARD unsigned int getVerticalScrollbarValue() const
Returns the thumb position of the vertical scrollbar.
TGUI_NODISCARD unsigned int getHorizontalScrollbarValue() const
Returns the thumb position of the horizontal scrollbar.
TGUI_NODISCARD unsigned int getHorizontalScrollbarMaxValue() const
Returns the maximum thumb position of the horizontal scrollbar.
TGUI_NODISCARD 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 removeItem(const std::vector< String > &hierarchy, bool removeParentsWhenEmpty=true)
Removes an item.
void setItemHeight(unsigned int itemHeight)
Changes the height of the items in the tree view.
void expandAll()
Expands all items.
bool canHandleKeyPress(const Event::KeyEvent &event) override
Called by the parent of the widget to check if keyPressed would process the event.
void setVerticalScrollbarValue(unsigned int value)
Changes the thumb position of the vertical scrollbar.
void expand(const std::vector< String > &hierarchy)
Expands the given item.
void removeAllItems()
Removes all items.
TGUI_NODISCARD unsigned int getVerticalScrollbarMaxValue() const
Returns the maximum thumb position of the vertical scrollbar.
static TGUI_NODISCARD TreeView::Ptr copy(const TreeView::ConstPtr &treeView)
Makes a copy of another tree view.
TGUI_NODISCARD TreeViewRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
TGUI_NODISCARD unsigned int getItemHeight() const
Returns the height of the items in the tree view.
void setHorizontalScrollbarValue(unsigned int value)
Changes the thumb position of the horizontal scrollbar.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
TGUI_NODISCARD std::vector< ConstNode > getNodes() const
Returns the nodes in the tree view.
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
void setSize(const Layout2d &size) override
Changes the size of the tree view.
Definition TreeViewRenderer.hpp:35
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
KeyPressed event parameters.
Definition Event.hpp:168
States used for drawing.
Definition RenderStates.hpp:38
Read-only node representation used by getNode and getNodes.
Definition TreeView.hpp:51
Internal representation of a node.
Definition TreeView.hpp:59