tgui::PanelRenderer Class Reference

Inheritance diagram for tgui::PanelRenderer:

Public Member Functions
	PanelRenderer (Panel *panel)
	Constructor. More...
virtual void	setProperty (std::string property, const std::string &value) override
	Change a property of the renderer. More...
virtual void	setProperty (std::string property, ObjectConverter &&value) override
	Change a property of the renderer. More...
virtual ObjectConverter	getProperty (std::string property) const override
	Retrieve the value of a certain property. More...
virtual std::map< std::string, ObjectConverter >	getPropertyValuePairs () const override
	Get a map with all properties and their values. More...
void	setBackgroundColor (const Color &color)
	Changes the background color of the panel. More...
void	setBorderColor (const Color &color)
	Changes the color of the borders. More...
Public Member Functions inherited from tgui::WidgetRenderer
virtual	~WidgetRenderer ()
	Virtual destructor.
Public Member Functions inherited from tgui::WidgetBorders
virtual void	setBorders (const Borders &borders)
	Changes the size of the borders. More...
void	setBorders (float leftBorder, float topBorder, float rightBorder, float bottomBorder)
	Changes the size of the borders. More...
void	setBorders (float width, float height)
	Changes the size of the borders. More...
virtual Borders	getBorders () const
	Returns the size of the borders as a tgui::Borders. More...

Constructor & Destructor Documentation

PanelRenderer()

tgui::PanelRenderer::PanelRenderer ( Panel *  panel )

inline

Constructor.

Parameters

panel

The panel that is connected to the renderer

Member Function Documentation

getProperty()

virtual ObjectConverter tgui::PanelRenderer::getProperty ( std::string  property ) const

overridevirtual

Retrieve the value of a certain property.

Parameters

property

The property that you would like to retrieve

Returns

The value inside a ObjectConverter object which you can extract with the correct get function or an ObjectConverter object with type ObjectConverter::Type::None when the property did not exist.

Reimplemented from tgui::WidgetRenderer.

getPropertyValuePairs()

virtual std::map< std::string, ObjectConverter > tgui::PanelRenderer::getPropertyValuePairs ( ) const

overridevirtual

Get a map with all properties and their values.

Returns

Property-value pairs of the renderer

Reimplemented from tgui::WidgetRenderer.

setBackgroundColor()

void tgui::PanelRenderer::setBackgroundColor

(

const Color &

color

)

Changes the background color of the panel.

Parameters

color

New 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

(

const Color &

color

)

Changes the color of the borders.

Parameters

color

New border color

setProperty() [1/2]

virtual void tgui::PanelRenderer::setProperty ( std::string  property, const std::string &  value  )

overridevirtual

Change a property of the renderer.

Parameters

property	The property that you would like to change
value	The new serialized value that you like to assign to the property

Exceptions

Exception

when deserialization fails or when the widget does not have this property.

Reimplemented from tgui::WidgetRenderer.

setProperty() [2/2]

virtual void tgui::PanelRenderer::setProperty ( std::string  property, ObjectConverter &&  value  )

overridevirtual

Change a property of the renderer.

Parameters

property	The property that you would like to change
value	The new value that you like to assign to the property. The ObjectConverter is implicitly constructed from the possible value types.

Exceptions

Exception

for unknown properties or when value was of a wrong type.

Reimplemented from tgui::WidgetRenderer.

---

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

• include/TGUI/Widgets/Panel.hpp