tgui::PanelRenderer Class Reference

Inheritance diagram for tgui::PanelRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.
TGUI_NODISCARD Borders	getBorders () const
	Returns the size of the borders.
void	setBorderColor (Color color)
	Changes the color of the borders.
TGUI_NODISCARD Color	getBorderColor () const
	Returns the color of the borders.
void	setBackgroundColor (Color color)
	Changes the background color of the panel.
TGUI_NODISCARD Color	getBackgroundColor () const
	Returns the background color of the panel.
void	setTextureBackground (const Texture &texture)
	Changes the background image.
TGUI_NODISCARD const Texture &	getTextureBackground () const
	Returns the background image.
void	setRoundedBorderRadius (float radius)
	Changes the radius for the rounded corners if you want to draw a rounded rectangle as background.
TGUI_NODISCARD float	getRoundedBorderRadius () const
	Returns the radius for the rounded corners if you want to draw a rounded rectangle as background.
Public Member Functions inherited from tgui::GroupRenderer
void	setPadding (const Padding &padding)
	Changes the size of the padding.
TGUI_NODISCARD Padding	getPadding () const
	Returns the size of the padding.
	WidgetRenderer ()=default
	Default constructor.
	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.
	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.
	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.
Public Member Functions inherited from tgui::WidgetRenderer
	WidgetRenderer ()=default
	Default constructor.
	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.
	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.
WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.
WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.
	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.
virtual	~WidgetRenderer ()=default
	Virtual destructor.
void	setOpacity (float opacity)
	Changes the opacity of the widget.
TGUI_NODISCARD float	getOpacity () const
	Returns the opacity of the widget.
void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.
TGUI_NODISCARD float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled.
void	setFont (const Font &font)
	Changes the font used for the text in the widget.
TGUI_NODISCARD Font	getFont () const
	Returns the font associated with the widget (if any)
void	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.
TGUI_NODISCARD unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.
void	setTransparentTexture (bool ignoreTransparentParts)
	Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.
TGUI_NODISCARD bool	getTransparentTexture () const
	Returns whether mouse events should be ignored on transparent parts of the texture of the widget.
void	setProperty (const String &property, ObjectConverter &&value)
	Changes a property of the renderer.
TGUI_NODISCARD ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.
TGUI_NODISCARD const std::map< String, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values.
void	subscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.
void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.
void	setData (const std::shared_ptr< RendererData > &data)
TGUI_NODISCARD std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.
TGUI_NODISCARD std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

getBackgroundColor()

TGUI_NODISCARD Color tgui::PanelRenderer::getBackgroundColor

(

)

const

Returns the background color of the panel.

Returns

Background color

getBorderColor()

TGUI_NODISCARD Color tgui::PanelRenderer::getBorderColor

(

)

const

Returns the color of the borders.

Returns

Border color

getBorders()

TGUI_NODISCARD Borders tgui::PanelRenderer::getBorders

(

)

const

Returns the size of the borders.

Returns

border size

getRoundedBorderRadius()

TGUI_NODISCARD float tgui::PanelRenderer::getRoundedBorderRadius

(

)

const

Returns the radius for the rounded corners if you want to draw a rounded rectangle as background.

Returns

Radius of the corners

getTextureBackground()

TGUI_NODISCARD const Texture & tgui::PanelRenderer::getTextureBackground

(

)

const

Returns the background image.

Returns

background texture

setBackgroundColor()

void tgui::PanelRenderer::setBackgroundColor

(

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

(

Color

color

)

Changes the color of the borders.

Parameters

color

New border color

setBorders()

void tgui::PanelRenderer::setBorders

(

const Borders &

borders

)

Changes the size of the borders.

Parameters

borders

Size of the borders

setRoundedBorderRadius()

void tgui::PanelRenderer::setRoundedBorderRadius

(

float

radius

)

Changes the radius for the rounded corners if you want to draw a rounded rectangle as background.

Parameters

radius

Radius of the corners

Warning

This property is ignored when textures are used as background

setTextureBackground()

void tgui::PanelRenderer::setTextureBackground

(

const Texture &

texture

)

Changes the background image.

Parameters

texture

New 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:

• include/TGUI/Renderers/PanelRenderer.hpp