TGUI  1.3.0
Loading...
Searching...
No Matches
tgui::TreeViewRenderer Class Reference
Inheritance diagram for tgui::TreeViewRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders.
 
TGUI_NODISCARD Borders getBorders () const
 Returns the size of the borders.
 
void setPadding (const Padding &padding)
 Changes the padding of the tree view.
 
TGUI_NODISCARD Padding getPadding () const
 Returns the size of the padding.
 
void setBackgroundColor (Color color)
 Changes the background color of the tree view.
 
TGUI_NODISCARD Color getBackgroundColor () const
 Returns the background color.
 
void setBorderColor (Color color)
 Changes the color of the borders.
 
TGUI_NODISCARD Color getBorderColor () const
 Returns the color of the borders.
 
void setTextColor (Color color)
 Changes the color of the text.
 
TGUI_NODISCARD Color getTextColor () const
 Returns the color of the text.
 
void setTextColorHover (Color color)
 Changes the color of the text of the item below the mouse.
 
TGUI_NODISCARD Color getTextColorHover () const
 Returns the color of the text of the item below the mouse.
 
void setSelectedTextColor (Color color)
 Changes the color of the text from the selected item.
 
TGUI_NODISCARD Color getSelectedTextColor () const
 Returns the color of the text from the selected item.
 
void setSelectedTextColorHover (Color color)
 Changes the color of the text of the selected item when it is below the mouse.
 
TGUI_NODISCARD Color getSelectedTextColorHover () const
 Returns the color of the text of the selected item when it is below the mouse.
 
void setSelectedBackgroundColor (Color color)
 Changes the background color of the selected item.
 
TGUI_NODISCARD Color getSelectedBackgroundColor () const
 Returns the background color of the selected item.
 
void setBackgroundColorHover (Color color)
 Changes the background color used for the item below the mouse.
 
TGUI_NODISCARD Color getBackgroundColorHover () const
 Returns the background color used for the item below the mouse.
 
void setSelectedBackgroundColorHover (Color backgroundColor)
 Changes the background color used for the selected item when the mouse hovers over it.
 
TGUI_NODISCARD Color getSelectedBackgroundColorHover () const
 Returns the background color used for the selected item when the mouse hovers over it.
 
void setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
 Sets the renderer data of the scrollbar.
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetScrollbar () const
 Returns the renderer data of the scrollbar.
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width of the scrollbar.
 
TGUI_NODISCARD float getScrollbarWidth () const
 Returns the wanted width of the scrollbar.
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the tree view.
 
TGUI_NODISCARD const TexturegetTextureBackground () const
 Returns the background image of the tree view.
 
void setTextureBranchExpanded (const Texture &textureBranchExpanded)
 Changes the image used in front of an expanded item.
 
TGUI_NODISCARD const TexturegetTextureBranchExpanded () const
 Returns the image used in front of an expanded item.
 
void setTextureBranchCollapsed (const Texture &textureBranchCollapsed)
 Changes the image used in front of a collapsed item.
 
TGUI_NODISCARD const TexturegetTextureBranchCollapsed () const
 Returns the image used in front of a collapsed item.
 
void setTextureLeaf (const Texture &textureLeaf)
 Changes the image used in front of a lead item.
 
TGUI_NODISCARD const TexturegetTextureLeaf () const
 Returns the image used in front of a leaf item.
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const WidgetRenderer &)
 Copy constructor.
 
 WidgetRenderer (WidgetRenderer &&)=default
 Default move constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data.
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const WidgetRenderer &)
 Copy constructor.
 
 WidgetRenderer (WidgetRenderer &&)=default
 Default move constructor.
 
WidgetRendereroperator= (const WidgetRenderer &)
 Copy assignment operator.
 
WidgetRendereroperator= (WidgetRenderer &&)=default
 Default move assignment operator.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data.
 
virtual ~WidgetRenderer ()=default
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget.
 
TGUI_NODISCARD float getOpacity () const
 Returns the opacity of the widget.
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled.
 
TGUI_NODISCARD float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled.
 
void setFont (const Font &font)
 Changes the font used for the text in the widget.
 
TGUI_NODISCARD Font getFont () const
 Returns the font associated with the widget (if any)
 
void setTextSize (unsigned int size)
 Changes the text size of the widget that is specified by the renderer.
 
TGUI_NODISCARD unsigned int getTextSize () const
 Returns text size of the widget that is specified by the renderer.
 
void setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.
 
TGUI_NODISCARD bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget.
 
void setProperty (const String &property, ObjectConverter &&value)
 Changes a property of the renderer.
 
TGUI_NODISCARD ObjectConverter getProperty (const String &property) const
 Retrieves the value of a certain property.
 
TGUI_NODISCARD const std::map< String, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values.
 
void subscribe (Widget *widget)
 Subscribes a callback function to changes in the renderer.
 
void unsubscribe (Widget *widget)
 Subscribes a callback function to changes in the renderer.
 
void setData (std::shared_ptr< RendererData > data)
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetData () const
 Returns the renderer data.
 
TGUI_NODISCARD std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data.
 

Additional Inherited Members

- Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererDatam_data = RendererData::create()
 

Member Function Documentation

◆ getBackgroundColor()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

◆ getBackgroundColorHover()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getBackgroundColorHover ( ) const

Returns the background color used for the item below the mouse.

Returns
Background color of hovered item

◆ getBorderColor()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

TGUI_NODISCARD Borders tgui::TreeViewRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getPadding()

TGUI_NODISCARD Padding tgui::TreeViewRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::TreeViewRenderer::getScrollbar ( ) const

Returns the renderer data of the scrollbar.

Returns
Data about how the scrollbar looks

◆ getScrollbarWidth()

TGUI_NODISCARD float tgui::TreeViewRenderer::getScrollbarWidth ( ) const

Returns the wanted width of the scrollbar.

Returns
Requested scrollbar width or 0 if no width was set (texture width or default value will be used)

◆ getSelectedBackgroundColor()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected item.

Returns
Selected item background color

◆ getSelectedBackgroundColorHover()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getSelectedBackgroundColorHover ( ) const

Returns the background color used for the selected item when the mouse hovers over it.

Returns
Background color of selected item in hover state

◆ getSelectedTextColor()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected item.

Returns
Selected text color

◆ getSelectedTextColorHover()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getSelectedTextColorHover ( ) const

Returns the color of the text of the selected item when it is below the mouse.

Returns
Hover text color

◆ getTextColor()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

◆ getTextColorHover()

TGUI_NODISCARD Color tgui::TreeViewRenderer::getTextColorHover ( ) const

Returns the color of the text of the item below the mouse.

Returns
Hover text color

◆ getTextureBackground()

TGUI_NODISCARD const Texture & tgui::TreeViewRenderer::getTextureBackground ( ) const

Returns the background image of the tree view.

Returns
Background texture

◆ getTextureBranchCollapsed()

TGUI_NODISCARD const Texture & tgui::TreeViewRenderer::getTextureBranchCollapsed ( ) const

Returns the image used in front of a collapsed item.

Returns
The collapsed branch texture

◆ getTextureBranchExpanded()

TGUI_NODISCARD const Texture & tgui::TreeViewRenderer::getTextureBranchExpanded ( ) const

Returns the image used in front of an expanded item.

Returns
The expanded branch texture

◆ getTextureLeaf()

TGUI_NODISCARD const Texture & tgui::TreeViewRenderer::getTextureLeaf ( ) const

Returns the image used in front of a leaf item.

Returns
The lead item texture

◆ setBackgroundColor()

void tgui::TreeViewRenderer::setBackgroundColor ( Color color)

Changes the background color of the tree view.

Parameters
colorThe new background color

◆ setBackgroundColorHover()

void tgui::TreeViewRenderer::setBackgroundColorHover ( Color color)

Changes the background color used for the item below the mouse.

Parameters
colorThe new hover background color

◆ setBorderColor()

void tgui::TreeViewRenderer::setBorderColor ( Color color)

Changes the color of the borders.

Parameters
colorThe new border color

◆ setBorders()

void tgui::TreeViewRenderer::setBorders ( const Borders & borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setPadding()

void tgui::TreeViewRenderer::setPadding ( const Padding & padding)

Changes the padding of the tree view.

Parameters
paddingThe padding width and height

◆ setScrollbar()

void tgui::TreeViewRenderer::setScrollbar ( std::shared_ptr< RendererData > scrollbarRendererData)

Sets the renderer data of the scrollbar.

Parameters
scrollbarRendererDataData about how the scrollbar should look

◆ setScrollbarWidth()

void tgui::TreeViewRenderer::setScrollbarWidth ( float scrollbarWidth)

Sets the wanted width of the scrollbar.

Parameters
scrollbarWidthRequested scrollbar width or 0 to use the default width (texture size if using textures)

◆ setSelectedBackgroundColor()

void tgui::TreeViewRenderer::setSelectedBackgroundColor ( Color color)

Changes the background color of the selected item.

Parameters
colorThe new selected item background color

◆ setSelectedBackgroundColorHover()

void tgui::TreeViewRenderer::setSelectedBackgroundColorHover ( Color backgroundColor)

Changes the background color used for the selected item when the mouse hovers over it.

Parameters
backgroundColorThe new selected hover background color

◆ setSelectedTextColor()

void tgui::TreeViewRenderer::setSelectedTextColor ( Color color)

Changes the color of the text from the selected item.

Parameters
colorThe new selected text color

◆ setSelectedTextColorHover()

void tgui::TreeViewRenderer::setSelectedTextColorHover ( Color color)

Changes the color of the text of the selected item when it is below the mouse.

Parameters
colorThe new hover text color

◆ setTextColor()

void tgui::TreeViewRenderer::setTextColor ( Color color)

Changes the color of the text.

Parameters
colorThe new text color

◆ setTextColorHover()

void tgui::TreeViewRenderer::setTextColorHover ( Color color)

Changes the color of the text of the item below the mouse.

Parameters
colorThe new hover text color

◆ setTextureBackground()

void tgui::TreeViewRenderer::setTextureBackground ( const Texture & texture)

Changes the background image of the tree view.

Parameters
textureThe background texture

When this image is set, the background color property will be ignored.

◆ setTextureBranchCollapsed()

void tgui::TreeViewRenderer::setTextureBranchCollapsed ( const Texture & textureBranchCollapsed)

Changes the image used in front of a collapsed item.

Parameters
textureBranchCollapsedThe collapsed branch texture

When this texture is not set, the TextureBranchExpanded will be used when available. If neither of these textures are set, TextureLeaf is tried. If TextureLeaf isn't set either then a "+" symbol will be displayed in the same color as the text.

◆ setTextureBranchExpanded()

void tgui::TreeViewRenderer::setTextureBranchExpanded ( const Texture & textureBranchExpanded)

Changes the image used in front of an expanded item.

Parameters
textureBranchExpandedThe expanded branch texture

When this texture is not set, the TextureBranchCollapsed will be used when available. If neither of these textures are set, TextureLeaf is tried. If TextureLeaf isn't set either then a "-" symbol will be displayed in the same color as the text.

◆ setTextureLeaf()

void tgui::TreeViewRenderer::setTextureLeaf ( const Texture & textureLeaf)

Changes the image used in front of a lead item.

Parameters
textureLeafThe lead item texture

When neither TextureBranchExpanded and TextureBranchCollapsed are set, this texture is also used for branch nodes.

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > & data)
inline

Construct the renderer from renderer data.

Parameters
dataRenderer data to initialize the renderer with

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