TGUI  0.8-dev
tgui::ListBoxRenderer Class Reference
Inheritance diagram for tgui::ListBoxRenderer:
tgui::WidgetRenderer

Public Member Functions

 ListBoxRenderer ()=default
 Default constructor.
 
 ListBoxRenderer (std::shared_ptr< RendererData > data)
 Construct the renderer from renderer data. More...
 
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 setTextStyle (TextStyle style)
 Changes the text style. More...
 
TextStyle getTextStyle () const
 Returns text style. More...
 
void setSelectedTextStyle (TextStyle style)
 Changes the text style of the selected item. More...
 
TextStyle getSelectedTextStyle () const
 Returns text style of the selected item. More...
 
void setBackgroundColor (Color backgroundColor)
 Changes the background color of the list box. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
void setBackgroundColorHover (Color backgroundColor)
 Changes the background color used for the item below the mouse. More...
 
Color getBackgroundColorHover () const
 Returns the background color used for the item below the mouse. More...
 
void setSelectedBackgroundColor (Color backgroundColor)
 Changes the background color of the selected item. More...
 
Color getSelectedBackgroundColor () const
 Returns the background color of the selected item. More...
 
void setSelectedBackgroundColorHover (Color backgroundColor)
 Changes the background color used for the selected item when the mouse hovers over it. More...
 
Color getSelectedBackgroundColorHover () const
 Returns the background color used for the selected item when the mouse hovers over it. More...
 
void setTextColor (Color textColor)
 Changes the color of the text. More...
 
Color getTextColor () const
 Returns the color of the text. More...
 
void setTextColorHover (Color textColor)
 Changes the color of the text of the item below the mouse. More...
 
Color getTextColorHover () const
 Returns the color of the text of the item below the mouse. More...
 
void setSelectedTextColor (Color textColor)
 Changes the color of the text from the selected item. More...
 
Color getSelectedTextColor () const
 Returns the color of the text from the selected item. More...
 
void setSelectedTextColorHover (Color textColor)
 Changes the color of the text of the selected item when it is below the mouse. More...
 
Color getSelectedTextColorHover () const
 Returns the color of the text of the selected item when it is below the mouse. More...
 
void setBorderColor (Color borderColor)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the list box. More...
 
TexturegetTextureBackground () const
 Returns the background image of the list box. 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...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (std::shared_ptr< RendererData > data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. 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 setProperty (const std::string &property, const std::string &value)
 Changes a property of the renderer. 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 (void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (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...
 

Constructor & Destructor Documentation

§ ListBoxRenderer()

tgui::ListBoxRenderer::ListBoxRenderer ( std::shared_ptr< RendererData data)
inline

Construct the renderer from renderer data.

Parameters
dataRenderer data to initialize the renderer with

Member Function Documentation

§ getBackgroundColor()

Color tgui::ListBoxRenderer::getBackgroundColor ( ) const

Returns the background color.

Returns
Background color

§ getBackgroundColorHover()

Color tgui::ListBoxRenderer::getBackgroundColorHover ( ) const

Returns the background color used for the item below the mouse.

Returns
Background color of hovered item

§ getBorderColor()

Color tgui::ListBoxRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

§ getBorders()

Borders tgui::ListBoxRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

§ getPadding()

Padding tgui::ListBoxRenderer::getPadding ( ) const

Returns the size of the padding.

Returns
padding size

§ getScrollbar()

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

Returns the renderer data of the scrollbar.

Returns
Data about how the scrollbar looks

§ getSelectedBackgroundColor()

Color tgui::ListBoxRenderer::getSelectedBackgroundColor ( ) const

Returns the background color of the selected item.

Returns
Selected item background color

§ getSelectedBackgroundColorHover()

Color tgui::ListBoxRenderer::getSelectedBackgroundColorHover ( ) const

Returns the background color used for the selected item when the mouse hovers over it.

Returns
Background color of selected item in hover state

§ getSelectedTextColor()

Color tgui::ListBoxRenderer::getSelectedTextColor ( ) const

Returns the color of the text from the selected item.

Returns
Selected text color

§ getSelectedTextColorHover()

Color tgui::ListBoxRenderer::getSelectedTextColorHover ( ) const

Returns the color of the text of the selected item when it is below the mouse.

Returns
Hover text color

§ getSelectedTextStyle()

TextStyle tgui::ListBoxRenderer::getSelectedTextStyle ( ) const

Returns text style of the selected item.

Returns
Style of the text

§ getTextColor()

Color tgui::ListBoxRenderer::getTextColor ( ) const

Returns the color of the text.

Returns
Text color

§ getTextColorHover()

Color tgui::ListBoxRenderer::getTextColorHover ( ) const

Returns the color of the text of the item below the mouse.

Returns
Hover text color

§ getTextStyle()

TextStyle tgui::ListBoxRenderer::getTextStyle ( ) const

Returns text style.

Returns
Style of the text

§ getTextureBackground()

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

Returns the background image of the list box.

Returns
Background texture

§ setBackgroundColor()

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

Changes the background color of the list box.

Parameters
backgroundColorThe new background color

§ setBackgroundColorHover()

void tgui::ListBoxRenderer::setBackgroundColorHover ( Color  backgroundColor)

Changes the background color used for the item below the mouse.

Parameters
backgroundColorThe new hover background color

§ setBorderColor()

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

Changes the color of the borders.

Parameters
borderColorThe new border color

§ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

§ setPadding()

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

Changes the padding of the list box.

Parameters
paddingThe padding width and height

§ setScrollbar()

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

Sets the renderer data of the scrollbar.

Parameters
scrollbarRendererDataData about how the scrollbar should look

§ setSelectedBackgroundColor()

void tgui::ListBoxRenderer::setSelectedBackgroundColor ( Color  backgroundColor)

Changes the background color of the selected item.

Parameters
backgroundColorThe new selected item background color

§ setSelectedBackgroundColorHover()

void tgui::ListBoxRenderer::setSelectedBackgroundColorHover ( Color  backgroundColor)

Changes the background color used for the selected item when the mouse hovers over it.

Parameters
backgroundColorThe new selected hover background color

§ setSelectedTextColor()

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

Changes the color of the text from the selected item.

Parameters
textColorThe new selected text color

§ setSelectedTextColorHover()

void tgui::ListBoxRenderer::setSelectedTextColorHover ( Color  textColor)

Changes the color of the text of the selected item when it is below the mouse.

Parameters
textColorThe new hover text color

§ setSelectedTextStyle()

void tgui::ListBoxRenderer::setSelectedTextStyle ( TextStyle  style)

Changes the text style of the selected item.

Parameters
styleNew text style

§ setTextColor()

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

Changes the color of the text.

Parameters
textColorThe new text color

§ setTextColorHover()

void tgui::ListBoxRenderer::setTextColorHover ( Color  textColor)

Changes the color of the text of the item below the mouse.

Parameters
textColorThe new hover text color

§ setTextStyle()

void tgui::ListBoxRenderer::setTextStyle ( TextStyle  style)

Changes the text style.

Parameters
styleNew text style

§ setTextureBackground()

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

Changes the background image of the list box.

Parameters
textureThe background texture

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


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