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

Member Function Documentation

◆ getBackgroundColor()

Color tgui::TreeViewRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

◆ getBackgroundColorHover()

Color tgui::TreeViewRenderer::getBackgroundColorHover ( ) const

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

Returns
Background color of hovered item

◆ getBorderColor()

Color tgui::TreeViewRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::TreeViewRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getPadding()

Padding tgui::TreeViewRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbar.

Returns
Data about how the scrollbar looks

◆ getScrollbarWidth()

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

Color tgui::TreeViewRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected item.

Returns
Selected item background color

◆ getSelectedBackgroundColorHover()

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

Color tgui::TreeViewRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected item.

Returns
Selected text color

◆ getSelectedTextColorHover()

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

Color tgui::TreeViewRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

◆ getTextColorHover()

Color tgui::TreeViewRenderer::getTextColorHover ( ) const

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

Returns
Hover text color

◆ getTextureBranchCollapsed()

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

Returns the image used in front of a collapsed item.

Returns
The collapsed branch texture

◆ getTextureBranchExpanded()

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

Returns the image used in front of an expanded item.

Returns
The expanded branch texture

◆ getTextureLeaf()

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

◆ 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
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: