TGUI  0.8-dev
tgui::ChatBoxRenderer Class Reference
Inheritance diagram for tgui::ChatBoxRenderer:
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 chat box. More...
 
Padding getPadding () const
 Returns the size of the padding. More...
 
void setBackgroundColor (Color backgroundColor)
 Changes the background color of the chat box. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
void setBorderColor (Color borderColor)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the chat box. More...
 
TexturegetTextureBackground () const
 Returns the background image of the chat box. 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...
 
- 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.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. 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 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::ChatBoxRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

◆ getBorderColor()

Color tgui::ChatBoxRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::ChatBoxRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getPadding()

Padding tgui::ChatBoxRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbar.

Returns
Data about how the scrollbar looks

◆ getTextureBackground()

Texture& tgui::ChatBoxRenderer::getTextureBackground ( ) const

Returns the background image of the chat box.

Returns
Background texture

◆ setBackgroundColor()

void tgui::ChatBoxRenderer::setBackgroundColor ( Color  backgroundColor)

Changes the background color of the chat box.

Parameters
backgroundColorThe new background color

◆ setBorderColor()

void tgui::ChatBoxRenderer::setBorderColor ( Color  borderColor)

Changes the color of the borders.

Parameters
borderColorThe new border color

◆ setBorders()

void tgui::ChatBoxRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setPadding()

void tgui::ChatBoxRenderer::setPadding ( const Padding padding)

Changes the padding of the chat box.

Parameters
paddingThe padding width and height

◆ setScrollbar()

void tgui::ChatBoxRenderer::setScrollbar ( std::shared_ptr< RendererData scrollbarRendererData)

Sets the renderer data of the scrollbar.

Parameters
scrollbarRendererDataData about how the scrollbar should look

◆ setTextureBackground()

void tgui::ChatBoxRenderer::setTextureBackground ( const Texture texture)

Changes the background image of the chat box.

Parameters
textureThe background texture

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


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