tgui::ChatBoxRenderer Class Reference

Inheritance diagram for tgui::ChatBoxRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.
Borders	getBorders () const
	Returns the size of the borders.
void	setPadding (const Padding &padding)
	Changes the padding of the chat box.
Padding	getPadding () const
	Returns the size of the padding.
void	setBackgroundColor (Color backgroundColor)
	Changes the background color of the chat box.
Color	getBackgroundColor () const
	Returns the background color.
void	setBorderColor (Color borderColor)
	Changes the color of the borders.
Color	getBorderColor () const
	Returns the color of the borders.
void	setTextureBackground (const Texture &texture)
	Changes the background image of the chat box.
const Texture &	getTextureBackground () const
	Returns the background image of the chat box.
void	setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
	Sets the renderer data of the scrollbar.
std::shared_ptr< RendererData >	getScrollbar () const
	Returns the renderer data of the scrollbar.
void	setScrollbarWidth (float scrollbarWidth)
	Sets the wanted width scrollbar.
float	getScrollbarWidth () const
	Returns the wanted width scrollbar.
	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.
WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.
WidgetRenderer &	operator= (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.
float	getOpacity () const
	Returns the opacity of the widget.
void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.
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.
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.
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.
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.
ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.
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)
std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.
std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

getBackgroundColor()

Color tgui::ChatBoxRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color.

Returns

Background color

getBorderColor()

Color tgui::ChatBoxRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns

Border color

getBorders()

Borders tgui::ChatBoxRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns

border size

getPadding()

Padding tgui::ChatBoxRenderer::getPadding ( ) const

nodiscard

Returns the size of the padding.

Returns

padding size

getScrollbar()

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

nodiscard

Returns the renderer data of the scrollbar.

Returns

Data about how the scrollbar looks

getScrollbarWidth()

float tgui::ChatBoxRenderer::getScrollbarWidth ( ) const

nodiscard

Returns the wanted width scrollbar.

Returns

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

getTextureBackground()

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

nodiscard

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

backgroundColor

The new background color

setBorderColor()

void tgui::ChatBoxRenderer::setBorderColor

(

Color

borderColor

)

Changes the color of the borders.

Parameters

borderColor

The new border color

setBorders()

void tgui::ChatBoxRenderer::setBorders

(

const Borders &

borders

)

Changes the size of the borders.

Parameters

borders

Size of the borders

setPadding()

void tgui::ChatBoxRenderer::setPadding

(

const Padding &

padding

)

Changes the padding of the chat box.

Parameters

padding

The padding width and height

setScrollbar()

void tgui::ChatBoxRenderer::setScrollbar

(

std::shared_ptr< RendererData >

scrollbarRendererData

)

Sets the renderer data of the scrollbar.

Parameters

scrollbarRendererData

Data about how the scrollbar should look

setScrollbarWidth()

void tgui::ChatBoxRenderer::setScrollbarWidth

(

float

scrollbarWidth

)

Sets the wanted width scrollbar.

Parameters

scrollbarWidth

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

setTextureBackground()

void tgui::ChatBoxRenderer::setTextureBackground

(

const Texture &

texture

)

Changes the background image of the chat box.

Parameters

texture

The background texture

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

WidgetRenderer()

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

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

---

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

• include/TGUI/Renderers/ChatBoxRenderer.hpp