tgui::WidgetRenderer Class Reference

Base class for all renderer classes. More...

#include <TGUI/Widget.hpp>

Inheritance diagram for tgui::WidgetRenderer:

Public Member Functions
virtual	~WidgetRenderer ()
	Virtual destructor.
virtual void	setProperty (std::string property, const std::string &value)
	Change a property of the renderer. More...
virtual void	setProperty (std::string property, ObjectConverter &&value)
	Change a property of the renderer. More...
virtual ObjectConverter	getProperty (std::string property) const
	Retrieve the value of a certain property. More...
virtual std::map< std::string, ObjectConverter >	getPropertyValuePairs () const
	Get a map with all properties and their values. More...

Detailed Description

Base class for all renderer classes.

Member Function Documentation

getProperty()

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

virtual

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 in tgui::ButtonRenderer, tgui::ChatBoxRenderer, tgui::ChildWindowRenderer, tgui::ComboBoxRenderer, tgui::EditBoxRenderer, tgui::KnobRenderer, tgui::LabelRenderer, tgui::ListBoxRenderer, tgui::MenuBarRenderer, tgui::MessageBoxRenderer, tgui::PanelRenderer, tgui::ProgressBarRenderer, tgui::RadioButtonRenderer, tgui::ScrollbarRenderer, tgui::SliderRenderer, tgui::SpinButtonRenderer, tgui::TabRenderer, and tgui::TextBoxRenderer.

getPropertyValuePairs()

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

virtual

Get a map with all properties and their values.

Returns

Property-value pairs of the renderer

Reimplemented in tgui::ButtonRenderer, tgui::ChatBoxRenderer, tgui::ChildWindowRenderer, tgui::ComboBoxRenderer, tgui::EditBoxRenderer, tgui::KnobRenderer, tgui::LabelRenderer, tgui::ListBoxRenderer, tgui::MenuBarRenderer, tgui::MessageBoxRenderer, tgui::PanelRenderer, tgui::ProgressBarRenderer, tgui::RadioButtonRenderer, tgui::ScrollbarRenderer, tgui::SliderRenderer, tgui::SpinButtonRenderer, tgui::TabRenderer, and tgui::TextBoxRenderer.

setProperty() [1/2]

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

virtual

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 in tgui::ButtonRenderer, tgui::ChatBoxRenderer, tgui::ChildWindowRenderer, tgui::ComboBoxRenderer, tgui::EditBoxRenderer, tgui::KnobRenderer, tgui::LabelRenderer, tgui::ListBoxRenderer, tgui::MenuBarRenderer, tgui::MessageBoxRenderer, tgui::PanelRenderer, tgui::ProgressBarRenderer, tgui::RadioButtonRenderer, tgui::ScrollbarRenderer, tgui::SliderRenderer, tgui::SpinButtonRenderer, tgui::TabRenderer, and tgui::TextBoxRenderer.

setProperty() [2/2]

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

virtual

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 in tgui::ButtonRenderer, tgui::ChatBoxRenderer, tgui::ChildWindowRenderer, tgui::ComboBoxRenderer, tgui::EditBoxRenderer, tgui::KnobRenderer, tgui::LabelRenderer, tgui::ListBoxRenderer, tgui::MenuBarRenderer, tgui::MessageBoxRenderer, tgui::PanelRenderer, tgui::ProgressBarRenderer, tgui::RadioButtonRenderer, tgui::ScrollbarRenderer, tgui::SliderRenderer, tgui::SpinButtonRenderer, tgui::TabRenderer, and tgui::TextBoxRenderer.

---

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

• include/TGUI/Widget.hpp