Inheritance diagram for tgui::EditBoxRenderer:

Public Member Functions
void	setTextStyle (TextStyles style)
	Changes the text style.

TextStyles	getTextStyle () const
	Returns text style.

void	setDefaultTextStyle (TextStyles style)
	Changes the text style of the default text (the text drawn when the edit box is empty)

TextStyles	getDefaultTextStyle () const
	Returns the text style of the default text (the text drawn when the edit box is empty)

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

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

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

float	getCaretWidth () const
	Returns the caret width.

void	setTextColor (Color textColor)
	Sets the text color that will be used inside the edit box.

Color	getTextColor () const
	Returns the text color that will be used inside the edit box.

void	setTextColorDisabled (Color textColor)
	Sets the text color that will be used inside the edit box when the edit box is disabled.

Color	getTextColorDisabled () const
	Returns the text color that will be used inside the edit box when the edit box is disabled.

void	setTextColorFocused (Color textColor)
	Sets the text color that will be used inside the edit box when the edit box is focused.

Color	getTextColorFocused () const
	Returns the text color that will be used inside the edit box when the edit box is focused.

void	setSelectedTextColor (Color selectedTextColor)
	Sets the text color of the selected text that will be used inside the edit box.

Color	getSelectedTextColor () const
	Returns the text color of the selected text that will be used inside the edit box.

void	setSelectedTextBackgroundColor (Color selectedTextBackgroundColor)
	Sets the background color of the selected text that will be used inside the edit box.

Color	getSelectedTextBackgroundColor () const
	Returns the background color of the selected text that will be used inside the edit box.

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

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

void	setBackgroundColor (Color color)
	Changes the color of the background.

Color	getBackgroundColor () const
	Returns the color of the background.

void	setBackgroundColorHover (Color color)
	Changes the color of the background in the hover state (mouse on edit box, but not pressed)

Color	getBackgroundColorHover () const
	Returns the color of the background in the hover state (mouse on edit box)

void	setBackgroundColorDisabled (Color color)
	Changes the color of the background when the edit box is disabled.

Color	getBackgroundColorDisabled () const
	Returns the color of the background when the edit box is disabled.

void	setBackgroundColorFocused (Color color)
	Changes the color of the background when the edit box is focused.

Color	getBackgroundColorFocused () const
	Returns the color of the background when the edit box is focused.

void	setCaretColor (Color caretColor)
	Sets the color that will be used inside the edit box for the blinking caret.

Color	getCaretColor () const
	Returns the color that will be used inside the edit box for the blinking caret.

void	setCaretColorHover (Color caretColor)
	Sets the color that will be used for the blinking caret when the mouse is on top of the edit box.

Color	getCaretColorHover () const
	Returns the color that will be used for the blinking caret when the mouse is on top of the edit box.

void	setCaretColorFocused (Color caretColor)
	Sets the color that will be used for the blinking caret when the edit box is focused.

Color	getCaretColorFocused () const
	Returns the color that will be used for the blinking caret when the edit box is focused.

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

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

void	setBorderColorHover (Color color)
	Changes the color of the borders used when the mouse is on top of the edit box.

Color	getBorderColorHover () const
	Returns the color of the borders used when the mouse is on top of the edit box.

void	setBorderColorDisabled (Color color)
	Changes the color of the borders used when the edit box is disabled.

Color	getBorderColorDisabled () const
	Returns the color of the borders used when the edit box is disabled.

void	setBorderColorFocused (Color color)
	Changes the color of the borders used when the edit box is focused.

Color	getBorderColorFocused () const
	Returns the color of the borders used when the edit box is focused.

void	setTexture (const Texture &texture)
	Changes the image that is displayed.

const Texture &	getTexture () const
	Returns the image that is displayed.

void	setTextureHover (const Texture &texture)
	Changes the image that is displayed when the mouse is located on top of the edit box.

const Texture &	getTextureHover () const
	Returns the image that is displayed when the mouse is located on top of the edit box.

void	setTextureDisabled (const Texture &texture)
	Changes the image that is displayed when the edit box is disabled.

const Texture &	getTextureDisabled () const
	Returns the image that is displayed when the edit box is disabled.

void	setTextureFocused (const Texture &texture)
	Changes the image that is drawn on top of the edit box image when the edit box is focused.

const Texture &	getTextureFocused () const
	Returns the image that is drawn on top of the edit box image when the edit box is focused.

	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::EditBoxRenderer::getBackgroundColor ( ) const

nodiscard

Returns the color of the background.

Returns: Background color

◆ getBackgroundColorDisabled()

Color tgui::EditBoxRenderer::getBackgroundColorDisabled ( ) const

nodiscard

Returns the color of the background when the edit box is disabled.

Returns: Background color in disabled state

◆ getBackgroundColorFocused()

Color tgui::EditBoxRenderer::getBackgroundColorFocused ( ) const

nodiscard

Returns the color of the background when the edit box is focused.

Returns: Background color in focused state

◆ getBackgroundColorHover()

Color tgui::EditBoxRenderer::getBackgroundColorHover ( ) const

nodiscard

Returns the color of the background in the hover state (mouse on edit box)

Returns: Background color in hover state

◆ getBorderColor()

Color tgui::EditBoxRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns: border color

◆ getBorderColorDisabled()

Color tgui::EditBoxRenderer::getBorderColorDisabled ( ) const

nodiscard

Returns the color of the borders used when the edit box is disabled.

Returns: border color

◆ getBorderColorFocused()

Color tgui::EditBoxRenderer::getBorderColorFocused ( ) const

nodiscard

Returns the color of the borders used when the edit box is focused.

Returns: border color

◆ getBorderColorHover()

Color tgui::EditBoxRenderer::getBorderColorHover ( ) const

nodiscard

Returns the color of the borders used when the mouse is on top of the edit box.

Returns: border color

◆ getBorders()

Borders tgui::EditBoxRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns: border size

◆ getCaretColor()

Color tgui::EditBoxRenderer::getCaretColor ( ) const

nodiscard

Returns the color that will be used inside the edit box for the blinking caret.

Returns: The color of the blinking caret

◆ getCaretColorFocused()

Color tgui::EditBoxRenderer::getCaretColorFocused ( ) const

nodiscard

Returns the color that will be used for the blinking caret when the edit box is focused.

Returns: The color of the blinking caret

◆ getCaretColorHover()

Color tgui::EditBoxRenderer::getCaretColorHover ( ) const

nodiscard

Returns the color that will be used for the blinking caret when the mouse is on top of the edit box.

Returns: The color of the blinking caret

◆ getCaretWidth()

float tgui::EditBoxRenderer::getCaretWidth ( ) const

nodiscard

Returns the caret width.

Returns: Width of the caret

◆ getDefaultTextColor()

Color tgui::EditBoxRenderer::getDefaultTextColor ( ) const

nodiscard

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

Returns: Default text color

◆ getDefaultTextStyle()

TextStyles tgui::EditBoxRenderer::getDefaultTextStyle ( ) const

nodiscard

Returns the text style of the default text (the text drawn when the edit box is empty)

Returns: Style of the default text

◆ getPadding()

Padding tgui::EditBoxRenderer::getPadding ( ) const

nodiscard

Returns the size of the padding.

Returns: padding size

See also: setPadding

◆ getSelectedTextBackgroundColor()

Color tgui::EditBoxRenderer::getSelectedTextBackgroundColor ( ) const

nodiscard

Returns the background color of the selected text that will be used inside the edit box.

Returns: Background color of selected text

◆ getSelectedTextColor()

Color tgui::EditBoxRenderer::getSelectedTextColor ( ) const

nodiscard

Returns the text color of the selected text that will be used inside the edit box.

Returns: Text color of selected text

◆ getTextColor()

Color tgui::EditBoxRenderer::getTextColor ( ) const

nodiscard

Returns the text color that will be used inside the edit box.

Returns: Text color

◆ getTextColorDisabled()

Color tgui::EditBoxRenderer::getTextColorDisabled ( ) const

nodiscard

Returns the text color that will be used inside the edit box when the edit box is disabled.

Returns: Text color

◆ getTextColorFocused()

Color tgui::EditBoxRenderer::getTextColorFocused ( ) const

nodiscard

Returns the text color that will be used inside the edit box when the edit box is focused.

Returns: Text color

◆ getTextStyle()

TextStyles tgui::EditBoxRenderer::getTextStyle ( ) const

nodiscard

Returns text style.

Returns: Style of the text

◆ getTexture()

const Texture & tgui::EditBoxRenderer::getTexture ( ) const

nodiscard

Returns the image that is displayed.

Returns: edit box texture

◆ getTextureDisabled()

const Texture & tgui::EditBoxRenderer::getTextureDisabled ( ) const

nodiscard

Returns the image that is displayed when the edit box is disabled.

Returns: disabled texture

◆ getTextureFocused()

const Texture & tgui::EditBoxRenderer::getTextureFocused ( ) const

nodiscard

Returns the image that is drawn on top of the edit box image when the edit box is focused.

Returns: focused texture

◆ getTextureHover()

const Texture & tgui::EditBoxRenderer::getTextureHover ( ) const

nodiscard

Returns the image that is displayed when the mouse is located on top of the edit box.

Returns: hover texture

◆ setBackgroundColor()

void tgui::EditBoxRenderer::setBackgroundColor ( Color color )

Changes the color of the background.

Parameters

color New background color

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

◆ setBackgroundColorDisabled()

void tgui::EditBoxRenderer::setBackgroundColorDisabled ( Color color )

Changes the color of the background when the edit box is disabled.

Parameters

color New background color

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

◆ setBackgroundColorFocused()

void tgui::EditBoxRenderer::setBackgroundColorFocused ( Color color )

Changes the color of the background when the edit box is focused.

Parameters

color New background color

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

◆ setBackgroundColorHover()

void tgui::EditBoxRenderer::setBackgroundColorHover ( Color color )

Changes the color of the background in the hover state (mouse on edit box, but not pressed)

Parameters

color New background color

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

◆ setBorderColor()

void tgui::EditBoxRenderer::setBorderColor ( Color color )

Changes the color of the borders.

Parameters

color New border color

◆ setBorderColorDisabled()

void tgui::EditBoxRenderer::setBorderColorDisabled ( Color color )

Changes the color of the borders used when the edit box is disabled.

Parameters

color New border color

◆ setBorderColorFocused()

void tgui::EditBoxRenderer::setBorderColorFocused ( Color color )

Changes the color of the borders used when the edit box is focused.

Parameters

color New border color

◆ setBorderColorHover()

void tgui::EditBoxRenderer::setBorderColorHover ( Color color )

Changes the color of the borders used when the mouse is on top of the edit box.

Parameters

color New border color

◆ setBorders()

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

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setCaretColor()

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

Sets the color that will be used inside the edit box for the blinking caret.

Parameters

caretColor The color of the blinking caret

◆ setCaretColorFocused()

void tgui::EditBoxRenderer::setCaretColorFocused ( Color caretColor )

Sets the color that will be used for the blinking caret when the edit box is focused.

Parameters

caretColor The color of the blinking caret

◆ setCaretColorHover()

void tgui::EditBoxRenderer::setCaretColorHover ( Color caretColor )

Sets the color that will be used for the blinking caret when the mouse is on top of the edit box.

Parameters

caretColor The color of the blinking caret

◆ setCaretWidth()

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

Changes the width of the caret.

Parameters

width New width of the caret

◆ setDefaultTextColor()

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

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

Parameters

defaultTextColor The new default text color

◆ setDefaultTextStyle()

void tgui::EditBoxRenderer::setDefaultTextStyle ( TextStyles style )

Changes the text style of the default text (the text drawn when the edit box is empty)

Parameters

style The new default text style

editBox->getSharedRenderer()->setDefaultTextStyle(tgui::TextStyle::Italic | tgui::TextStyle::Bold);

tgui::Bold

@ Bold

Bold characters.

Definition TextStyle.hpp:40

tgui::Italic

@ Italic

Italic characters.

Definition TextStyle.hpp:41

◆ setPadding()

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

Changes the padding of the edit box.

When the text is auto-scaled then it will be drawn within the area defined by the size minus the border and padding. The padding is also used to define the clipping area for when the text it too long.

Parameters

padding The padding width and height

◆ setSelectedTextBackgroundColor()

void tgui::EditBoxRenderer::setSelectedTextBackgroundColor ( Color selectedTextBackgroundColor )

Sets the background color of the selected text that will be used inside the edit box.

Parameters

selectedTextBackgroundColor The new background color

◆ setSelectedTextColor()

void tgui::EditBoxRenderer::setSelectedTextColor ( Color selectedTextColor )

Sets the text color of the selected text that will be used inside the edit box.

Parameters

selectedTextColor The new selected text color

◆ setTextColor()

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

Sets the text color that will be used inside the edit box.

Parameters

textColor The new text color

◆ setTextColorDisabled()

void tgui::EditBoxRenderer::setTextColorDisabled ( Color textColor )

Sets the text color that will be used inside the edit box when the edit box is disabled.

Parameters

textColor The new text color

◆ setTextColorFocused()

void tgui::EditBoxRenderer::setTextColorFocused ( Color textColor )

Sets the text color that will be used inside the edit box when the edit box is focused.

Parameters

textColor The new text color

◆ setTextStyle()

void tgui::EditBoxRenderer::setTextStyle ( TextStyles style )

Changes the text style.

Parameters

style New text style

◆ setTexture()

void tgui::EditBoxRenderer::setTexture ( const Texture & texture )

Changes the image that is displayed.

Parameters

texture The new edit box texture

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

◆ setTextureDisabled()

void tgui::EditBoxRenderer::setTextureDisabled ( const Texture & texture )

Changes the image that is displayed when the edit box is disabled.

Parameters

texture The new disabled texture

◆ setTextureFocused()

void tgui::EditBoxRenderer::setTextureFocused ( const Texture & texture )

Changes the image that is drawn on top of the edit box image when the edit box is focused.

Parameters

texture The new focus texture

◆ setTextureHover()

void tgui::EditBoxRenderer::setTextureHover ( const Texture & texture )

Changes the image that is displayed when the mouse is located on top of the edit box.

Parameters

texture The new hover texture

◆ 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/EditBoxRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBackgroundColorDisabled()

◆ getBackgroundColorFocused()

◆ getBackgroundColorHover()

◆ getBorderColor()

◆ getBorderColorDisabled()

◆ getBorderColorFocused()

◆ getBorderColorHover()

◆ getBorders()

◆ getCaretColor()

◆ getCaretColorFocused()

◆ getCaretColorHover()

◆ getCaretWidth()

◆ getDefaultTextColor()

◆ getDefaultTextStyle()

◆ getPadding()

◆ getSelectedTextBackgroundColor()

◆ getSelectedTextColor()

◆ getTextColor()

◆ getTextColorDisabled()

◆ getTextColorFocused()

◆ getTextStyle()

◆ getTexture()

◆ getTextureDisabled()

◆ getTextureFocused()

◆ getTextureHover()

◆ setBackgroundColor()

◆ setBackgroundColorDisabled()

◆ setBackgroundColorFocused()

◆ setBackgroundColorHover()

◆ setBorderColor()

◆ setBorderColorDisabled()

◆ setBorderColorFocused()

◆ setBorderColorHover()

◆ setBorders()

◆ setCaretColor()

◆ setCaretColorFocused()

◆ setCaretColorHover()

◆ setCaretWidth()

◆ setDefaultTextColor()

◆ setDefaultTextStyle()

◆ setPadding()

◆ setSelectedTextBackgroundColor()

◆ setSelectedTextColor()

◆ setTextColor()

◆ setTextColorDisabled()

◆ setTextColorFocused()

◆ setTextStyle()

◆ setTexture()

◆ setTextureDisabled()

◆ setTextureFocused()

◆ setTextureHover()

◆ WidgetRenderer()