TGUI  0.8.9
tgui::TextBoxRenderer Class Reference
Inheritance diagram for tgui::TextBoxRenderer:
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 list box. More...
 
Padding getPadding () const
 Returns the size of the padding. More...
 
void setBackgroundColor (Color backgroundColor)
 Changes the background color of the text box. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
void setTextColor (Color textColor)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setDefaultTextColor (Color defaultTextColor)
 Sets the color of the default text that can optionally be displayed when the text box is empty. More...
 
Color getDefaultTextColor () const
 Returns the color of the default text that can optionally be displayed when the text box is empty. More...
 
void setSelectedTextColor (Color textColor)
 Changes the color of the selected text. More...
 
Color getSelectedTextColor () const
 Returns the color of the selected text. More...
 
void setSelectedTextBackgroundColor (Color textColor)
 Changes the color of the background of the selected text. More...
 
Color getSelectedTextBackgroundColor () const
 Returns the color of the background of the selected text. More...
 
void setBorderColor (Color borderColor)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setCaretColor (Color caretColor)
 Changes the color of the blinking caret. More...
 
Color getCaretColor () const
 Returns the color of the blinking caret. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the text box. More...
 
TexturegetTextureBackground () const
 Returns the background image of the text box. More...
 
void setCaretWidth (float width)
 Changes the width of the blinking caret. More...
 
float getCaretWidth () const
 Returns the width of the blinking caret. 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...
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width scrollbar. More...
 
float getScrollbarWidth () const
 Returns the wanted width scrollbar. More...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. 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 setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled. More...
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled. 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 setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. 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::TextBoxRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

◆ getBorderColor()

Color tgui::TextBoxRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::TextBoxRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getCaretColor()

Color tgui::TextBoxRenderer::getCaretColor ( ) const

Returns the color of the blinking caret.

Returns
Caret color

◆ getCaretWidth()

float tgui::TextBoxRenderer::getCaretWidth ( ) const

Returns the width of the blinking caret.

Returns
caret width

◆ getDefaultTextColor()

Color tgui::TextBoxRenderer::getDefaultTextColor ( ) const

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

Returns
Default text color

◆ getPadding()

Padding tgui::TextBoxRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

◆ getScrollbar()

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

Returns the renderer data of the scrollbar.

Returns
Data about how the scrollbar looks

◆ getScrollbarWidth()

float tgui::TextBoxRenderer::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::TextBoxRenderer::getSelectedTextBackgroundColor ( ) const

Returns the color of the background of the selected text.

Returns
Selected text background color

◆ getSelectedTextColor()

Color tgui::TextBoxRenderer::getSelectedTextColor ( ) const

Returns the color of the selected text.

Returns
Selected text color

◆ getTextColor()

Color tgui::TextBoxRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

◆ getTextureBackground()

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

Returns the background image of the text box.

Returns
Background texture

◆ setBackgroundColor()

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

Changes the background color of the text box.

Parameters
backgroundColorThe new background color

◆ setBorderColor()

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

Changes the color of the borders.

Parameters
borderColorThe new border color

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setCaretColor()

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

Changes the color of the blinking caret.

Parameters
caretColorThe new caret color

◆ setCaretWidth()

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

Changes the width of the blinking caret.

Parameters
widthNew width of the caret

◆ setDefaultTextColor()

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

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

Parameters
defaultTextColorThe new default text color

◆ setPadding()

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

Changes the padding of the list box.

Parameters
paddingThe padding width and height

◆ setScrollbar()

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

Sets the renderer data of the scrollbar.

Parameters
scrollbarRendererDataData about how the scrollbar should look

◆ setScrollbarWidth()

void tgui::TextBoxRenderer::setScrollbarWidth ( float  scrollbarWidth)

Sets the wanted width scrollbar.

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

◆ setSelectedTextBackgroundColor()

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

Changes the color of the background of the selected text.

Parameters
textColorThe new selected text background color

◆ setSelectedTextColor()

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

Changes the color of the selected text.

Parameters
textColorThe new selected text color

◆ setTextColor()

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

Changes the color of the text.

Parameters
textColorThe new text color

◆ setTextureBackground()

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

Changes the background image of the text box.

Parameters
textureThe 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
dataRenderer data to initialize the renderer with

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