TGUI  0.7.4
tgui::ChatBoxRenderer Class Reference
Inheritance diagram for tgui::ChatBoxRenderer:
tgui::WidgetRenderer tgui::WidgetBorders tgui::WidgetPadding

Public Member Functions

 ChatBoxRenderer (ChatBox *chatBox)
 Constructor. More...
 
virtual void setProperty (std::string property, const std::string &value) override
 Change a property of the renderer. More...
 
virtual void setProperty (std::string property, ObjectConverter &&value) override
 Change a property of the renderer. More...
 
virtual ObjectConverter getProperty (std::string property) const override
 Retrieve the value of a certain property. More...
 
virtual std::map< std::string, ObjectConvertergetPropertyValuePairs () const override
 Get a map with all properties and their values. More...
 
void setBorderColor (const Color &borderColor)
 Set the border color that will be used inside the chat box. More...
 
void setBackgroundColor (const Color &backgroundColor)
 Set the background color that will be used inside the chat box. More...
 
void setBackgroundTexture (const Texture &texture)
 Changes the background image. More...
 
void setPadding (const Padding &padding) override
 Changes the size of the padding. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
virtual ~WidgetRenderer ()
 Virtual destructor.
 
- Public Member Functions inherited from tgui::WidgetBorders
virtual void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
void setBorders (float leftBorder, float topBorder, float rightBorder, float bottomBorder)
 Changes the size of the borders. More...
 
void setBorders (float width, float height)
 Changes the size of the borders. More...
 
virtual Borders getBorders () const
 Returns the size of the borders as a tgui::Borders. More...
 
- Public Member Functions inherited from tgui::WidgetPadding
void setPadding (float leftPadding, float topPadding, float rightPadding, float bottomPadding)
 Changes the size of the padding. More...
 
void setPadding (float width, float height)
 Changes the size of the padding. More...
 
virtual Padding getPadding () const
 Returns the size of the padding. More...
 

Constructor & Destructor Documentation

◆ ChatBoxRenderer()

tgui::ChatBoxRenderer::ChatBoxRenderer ( ChatBox chatBox)
inline

Constructor.

Parameters
chatBoxThe chat box that is connected to the renderer

Member Function Documentation

◆ getProperty()

virtual ObjectConverter tgui::ChatBoxRenderer::getProperty ( std::string  property) const
overridevirtual

Retrieve the value of a certain property.

Parameters
propertyThe property that you would like to retrieve
Returns
The value inside a ObjectConverter object which you can extract with the correct get function or an ObjectConverter object with type ObjectConverter::Type::None when the property did not exist.

Reimplemented from tgui::WidgetRenderer.

◆ getPropertyValuePairs()

virtual std::map<std::string, ObjectConverter> tgui::ChatBoxRenderer::getPropertyValuePairs ( ) const
overridevirtual

Get a map with all properties and their values.

Returns
Property-value pairs of the renderer

Reimplemented from tgui::WidgetRenderer.

◆ setBackgroundColor()

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

Set the background color that will be used inside the chat box.

Parameters
backgroundColorThe new background color.

Note that this color is ignored when you set a background image.

◆ setBackgroundTexture()

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

Changes the background image.

Parameters
textureNew background texture

When this image is set, the background color property will be ignored. Pass an empty string to unset the image, in this case the background color property will be used again.

◆ setBorderColor()

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

Set the border color that will be used inside the chat box.

Parameters
borderColorThe color of the borders

◆ setPadding()

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

Changes the size of the padding.

Parameters
paddingSize of the padding

This padding will be scaled together with the background image. If there is no background image, or when 9-slice scaling is used, the padding will be exactly what you pass here.

Reimplemented from tgui::WidgetPadding.

◆ setProperty() [1/2]

virtual void tgui::ChatBoxRenderer::setProperty ( std::string  property,
const std::string &  value 
)
overridevirtual

Change a property of the renderer.

Parameters
propertyThe property that you would like to change
valueThe new serialized value that you like to assign to the property
Exceptions
Exceptionwhen deserialization fails or when the widget does not have this property.
Exceptionwhen loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

◆ setProperty() [2/2]

virtual void tgui::ChatBoxRenderer::setProperty ( std::string  property,
ObjectConverter &&  value 
)
overridevirtual

Change a property of the renderer.

Parameters
propertyThe property that you would like to change
valueThe new value that you like to assign to the property. The ObjectConverter is implicitly constructed from the possible value types.
Exceptions
Exceptionfor unknown properties or when value was of a wrong type.
Exceptionwhen loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.


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