|
|
| TreeView (const char *typeName=StaticWidgetType, bool initRenderer=true) |
| |
|
| TreeView (const TreeView &) |
| |
|
| TreeView (TreeView &&)=default |
| |
|
TreeView & | operator= (const TreeView &) |
| |
|
TreeView & | operator= (TreeView &&)=default |
| |
| TGUI_NODISCARD TreeViewRenderer * | getSharedRenderer () override |
| | Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
| |
| TGUI_NODISCARD const TreeViewRenderer * | getSharedRenderer () const override |
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD std::vector< String > | getSelectedItem () const |
| | Returns the selected item.
|
| |
| TGUI_NODISCARD 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) |
| | 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.
|
| |
| TGUI_NODISCARD ConstNode | getNode (const std::vector< String > &hierarchy) const |
| | Returns the node in the tree view at a given hierarchy.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD unsigned int | getVerticalScrollbarValue () const |
| | Returns the thumb position of the vertical scrollbar.
|
| |
| TGUI_NODISCARD 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.
|
| |
| 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 | 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.
|
| |
|
| 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD Vector2f | getSize () const |
| | Returns the size of the widget.
|
| |
| virtual TGUI_NODISCARD Vector2f | getFullSize () const |
| | Returns the entire size that the widget is using.
|
| |
| virtual TGUI_NODISCARD Vector2f | getAbsolutePosition (Vector2f offset={}) const |
| | Get the absolute position of the widget instead of the relative position to its parent.
|
| |
| virtual TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD Vector2f | getScale () const |
| | Returns the scaling to be applied to the widget.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD float | getRotation () const |
| | Returns the rotation to be applied to the widget.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD bool | isVisible () const |
| | Returns true when the widget is visible.
|
| |
| virtual void | setEnabled (bool enabled) |
| | Enables or disables the widget.
|
| |
| TGUI_NODISCARD bool | isEnabled () const |
| | Returns true when the widget is enabled.
|
| |
| virtual void | setFocused (bool focused) |
| | Focus or unfocus the widget.
|
| |
| TGUI_NODISCARD bool | isFocused () const |
| | Returns true when the widget is focused and false otherwise.
|
| |
| TGUI_NODISCARD const String & | getWidgetType () const |
| | Returns the type of the widget.
|
| |
| TGUI_NODISCARD Container * | getParent () const |
| | Returns a pointer to the parent widget.
|
| |
| TGUI_NODISCARD BackendGui * | getParentGui () const |
| | Returns a pointer to the gui to which this widget belongs.
|
| |
| TGUI_NODISCARD 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 > |
| TGUI_NODISCARD DataType | getUserData () const |
| | Returns data stored in the widget.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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.
|
| |
| TGUI_NODISCARD 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 TGUI_NODISCARD bool | canGainFocus () const |
| | Returns whether the widget can currently gain focus.
|
| |
| TGUI_NODISCARD bool | isContainer () const |
| | Returns whether the widget is a container widget or not.
|
| |
| TGUI_NODISCARD 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 TGUI_NODISCARD Widget::Ptr | askToolTip (Vector2f mousePos) |
| |
|
TGUI_NODISCARD const Layout2d & | getPositionLayout () const |
| |
|
TGUI_NODISCARD const Layout2d & | getSizeLayout () const |
| |
|
void | bindPositionLayout (Layout *layout) |
| |
|
void | unbindPositionLayout (Layout *layout) |
| |
|
void | bindSizeLayout (Layout *layout) |
| |
|
void | unbindSizeLayout (Layout *layout) |
| |
|
template<typename WidgetType > |
| TGUI_NODISCARD std::shared_ptr< const WidgetType > | cast () const |
| | Downcast const widget.
|
| |
|
template<typename WidgetType > |
| TGUI_NODISCARD std::shared_ptr< WidgetType > | cast () |
| | Downcast widget.
|
| |
|
void | rendererChangedCallback (const String &property) |
| |
|
| 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.
|
| |
|
| TGUI_NODISCARD 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.
|
| |
| 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.
|
| |
|
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(...)
|
| |
|
TGUI_NODISCARD Vector2f | getInnerSize () const |
| |
|
void | updateIconBounds () |
| |
| bool | updateTime (Duration elapsedTime) override |
| |
| TGUI_NODISCARD 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) |
| |
|
TGUI_NODISCARD 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) |
| |
| 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.
|
| |
| 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.
|
| |