Inheritance diagram for tgui::TextAreaRenderer:

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 list box.

Padding	getPadding () const
	Returns the size of the padding.

void	setBackgroundColor (Color backgroundColor)
	Changes the background color of the text area.

Color	getBackgroundColor () const
	Returns the background color.

void	setTextColor (Color textColor)
	Changes the color of the text.

Color	getTextColor () const
	Returns the color of the text.

void	setDefaultTextColor (Color defaultTextColor)
	Sets the color of the default text that can optionally be displayed when the text area is empty.

Color	getDefaultTextColor () const
	Returns the color of the default text that can optionally be displayed when the text area is empty.

void	setSelectedTextColor (Color textColor)
	Changes the color of the selected text.

Color	getSelectedTextColor () const
	Returns the color of the selected text.

void	setSelectedTextBackgroundColor (Color textColor)
	Changes the color of the background of the selected text.

Color	getSelectedTextBackgroundColor () const
	Returns the color of the background of the selected text.

void	setBorderColor (Color borderColor)
	Changes the color of the borders.

Color	getBorderColor () const
	Returns the color of the borders.

void	setCaretColor (Color caretColor)
	Changes the color of the blinking caret.

Color	getCaretColor () const
	Returns the color of the blinking caret.

void	setTextureBackground (const Texture &texture)
	Changes the background image of the text area.

const Texture &	getTextureBackground () const
	Returns the background image of the text area.

void	setCaretWidth (float width)
	Changes the width of the blinking caret.

float	getCaretWidth () const
	Returns the width of the blinking caret.

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 std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

Public Member Functions inherited from tgui::WidgetRenderer
	WidgetRenderer ()=default
	Default constructor.

	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 (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	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 (const void *id, const std::function< void(const String &property)> &function)
	Subscribes a callback function to changes in the renderer.

void	unsubscribe (const void *id)
	Subscribes a callback function to changes in the renderer.

void	setData (const 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::TextAreaRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns: Background color

◆ getBorderColor()

Color tgui::TextAreaRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns: Border color

◆ getBorders()

Borders tgui::TextAreaRenderer::getBorders ( ) const

Returns the size of the borders.

Returns: border size

◆ getCaretColor()

Color tgui::TextAreaRenderer::getCaretColor ( ) const

Returns the color of the blinking caret.

Returns: Caret color

◆ getCaretWidth()

float tgui::TextAreaRenderer::getCaretWidth ( ) const

Returns the width of the blinking caret.

Returns: caret width

◆ getDefaultTextColor()

Color tgui::TextAreaRenderer::getDefaultTextColor ( ) const

Returns the color of the default text that can optionally be displayed when the text area is empty.

Returns: Default text color

◆ getPadding()

Padding tgui::TextAreaRenderer::getPadding ( ) const

Returns the size of the padding.

Returns: padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbar.

Returns: Data about how the scrollbar looks

◆ getScrollbarWidth()

float tgui::TextAreaRenderer::getScrollbarWidth ( ) const

Returns the wanted width scrollbar.

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

◆ getSelectedTextBackgroundColor()

Color tgui::TextAreaRenderer::getSelectedTextBackgroundColor ( ) const

Returns the color of the background of the selected text.

Returns: Selected text background color

◆ getSelectedTextColor()

Color tgui::TextAreaRenderer::getSelectedTextColor ( ) const

Returns the color of the selected text.

Returns: Selected text color

◆ getTextColor()

Color tgui::TextAreaRenderer::getTextColor ( ) const

Returns the color of the text.

Returns: Text color

◆ getTextureBackground()

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

Returns the background image of the text area.

Returns: Background texture

◆ setBackgroundColor()

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

Changes the background color of the text area.

Parameters

backgroundColor The new background color

◆ setBorderColor()

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

Changes the color of the borders.

Parameters

borderColor The new border color

◆ setBorders()

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

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setCaretColor()

void tgui::TextAreaRenderer::setCaretColor ( Color caretColor )

Changes the color of the blinking caret.

Parameters

caretColor The new caret color

◆ setCaretWidth()

void tgui::TextAreaRenderer::setCaretWidth ( float width )

Changes the width of the blinking caret.

Parameters

width New width of the caret

◆ setDefaultTextColor()

void tgui::TextAreaRenderer::setDefaultTextColor ( Color defaultTextColor )

Sets the color of the default text that can optionally be displayed when the text area is empty.

Parameters

defaultTextColor The new default text color

◆ setPadding()

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

Changes the padding of the list box.

Parameters

padding The padding width and height

◆ setScrollbar()

void tgui::TextAreaRenderer::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::TextAreaRenderer::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)

◆ setSelectedTextBackgroundColor()

void tgui::TextAreaRenderer::setSelectedTextBackgroundColor ( Color textColor )

Changes the color of the background of the selected text.

Parameters

textColor The new selected text background color

◆ setSelectedTextColor()

void tgui::TextAreaRenderer::setSelectedTextColor ( Color textColor )

Changes the color of the selected text.

Parameters

textColor The new selected text color

◆ setTextColor()

void tgui::TextAreaRenderer::setTextColor ( Color textColor )

Changes the color of the text.

Parameters

textColor The new text color

◆ setTextureBackground()

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

Changes the background image of the text area.

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/TextAreaRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBorderColor()

◆ getBorders()

◆ getCaretColor()

◆ getCaretWidth()

◆ getDefaultTextColor()

◆ getPadding()

◆ getScrollbar()

◆ getScrollbarWidth()

◆ getSelectedTextBackgroundColor()

◆ getSelectedTextColor()

◆ getTextColor()

◆ getTextureBackground()

◆ setBackgroundColor()

◆ setBorderColor()

◆ setBorders()

◆ setCaretColor()

◆ setCaretWidth()

◆ setDefaultTextColor()

◆ setPadding()

◆ setScrollbar()

◆ setScrollbarWidth()

◆ setSelectedTextBackgroundColor()

◆ setSelectedTextColor()

◆ setTextColor()

◆ setTextureBackground()

◆ WidgetRenderer()