TGUI  0.8-dev
tgui::PanelRenderer Class Reference
Inheritance diagram for tgui::PanelRenderer:
tgui::GroupRenderer tgui::WidgetRenderer tgui::ScrollablePanelRenderer

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 setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setBackgroundColor (Color color)
 Changes the background color of the panel. More...
 
Color getBackgroundColor () const
 Returns the background color of the panel. More...
 
- Public Member Functions inherited from tgui::GroupRenderer
void setPadding (const Padding &padding)
 Changes the size of the padding. More...
 
Padding getPadding () const
 Returns the size of the padding. 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 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, 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::PanelRenderer::getBackgroundColor ( ) const

Returns the background color of the panel.

Returns
Background color

◆ getBorderColor()

Color tgui::PanelRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::PanelRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ setBackgroundColor()

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

Changes the background color of the panel.

Parameters
colorNew background color

The background color is transparent by default.

When auto-size is enabled (default), then the background is just as big as the text. When a manual size is set, the background will fill this whole area.

◆ setBorderColor()

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

Changes the color of the borders.

Parameters
colorNew border color

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

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