Inheritance diagram for tgui::ChildWindowRenderer:

Public Member Functions
	ChildWindowRenderer (ChildWindow *childWindow)
	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	setTitleBarColor (const Color &color)
	Changes the color of the title bar. More...

void	setTitleBarHeight (float height)
	Change the height of the title bar. More...

void	setTitleColor (const Color &color)
	Changes the color of the title that is displayed in the title bar of the child window. More...

void	setBorderColor (const Color &borderColor)
	Set the border color. More...

virtual void	setBorders (const Borders &borders) override
	Changes the size of the borders. More...

void	setDistanceToSide (float distanceToSide)
	Changes the distance between the title and the side of the title bar. More...

void	setPaddingBetweenButtons (float paddingBetweenButtons)
	Changes the distance between the title buttons if multiple exist. More...

void	setBackgroundColor (const Color &backgroundColor)
	Changes the background color of the child window. More...

void	setTitleBarTexture (const Texture &texture)
	Change the image of the title bar. More...

std::shared_ptr< ButtonRenderer >	getCloseButton () const
	Returns the renderer of the close button. More...

std::shared_ptr< ButtonRenderer >	getMinimizeButton () const
	Returns the renderer of the minimize button. More...

std::shared_ptr< ButtonRenderer >	getMaximizeButton () const
	Returns the renderer of the maximize button. More...

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...

Public Member Functions inherited from tgui::WidgetRenderer
virtual	~WidgetRenderer ()
	Virtual destructor.

Public Member Functions inherited from tgui::WidgetBorders
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

◆ ChildWindowRenderer()

tgui::ChildWindowRenderer::ChildWindowRenderer ( ChildWindow * childWindow )

inline

Constructor.

Parameters

childWindow The child window that is connected to the renderer

Member Function Documentation

◆ getCloseButton()

std::shared_ptr< ButtonRenderer > tgui::ChildWindowRenderer::getCloseButton ( ) const

Returns the renderer of the close button.

Returns: The close button renderer

◆ getMaximizeButton()

std::shared_ptr< ButtonRenderer > tgui::ChildWindowRenderer::getMaximizeButton ( ) const

Returns the renderer of the maximize button.

Returns: The maximize button renderer

◆ getMinimizeButton()

std::shared_ptr< ButtonRenderer > tgui::ChildWindowRenderer::getMinimizeButton ( ) const

Returns the renderer of the minimize button.

Returns: The minimize button renderer

◆ getProperty()

virtual ObjectConverter tgui::ChildWindowRenderer::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.

Reimplemented in tgui::MessageBoxRenderer.

◆ getPropertyValuePairs()

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

overridevirtual

Get a map with all properties and their values.

Returns: Property-value pairs of the renderer

Reimplemented from tgui::WidgetRenderer.

Reimplemented in tgui::MessageBoxRenderer.

◆ setBackgroundColor()

void tgui::ChildWindowRenderer::setBackgroundColor ( const Color & backgroundColor )

Changes the background color of the child window.

Parameters

backgroundColor New background color

◆ setBorderColor()

void tgui::ChildWindowRenderer::setBorderColor ( const Color & borderColor )

Set the border color.

Parameters

borderColor The color of the borders

◆ setBorders() [1/4]

virtual void tgui::WidgetBorders::setBorders ( const Borders & borders )

inlinevirtual

Changes the size of the borders.

Parameters

borders Size of the borders

Reimplemented from tgui::WidgetBorders.

◆ setBorders() [2/4]

virtual void tgui::ChildWindowRenderer::setBorders ( const Borders & borders )

overridevirtual

Changes the size of the borders.

Parameters

borders The size of the borders

Reimplemented from tgui::WidgetBorders.

◆ setBorders() [3/4]

void tgui::WidgetBorders::setBorders	(	float	leftBorder,
		float	topBorder,
		float	rightBorder,
		float	bottomBorder
	)

inline

Changes the size of the borders.

Parameters

leftBorder	Width of the left border
topBorder	Height of the top border
rightBorder	Width of the right border
bottomBorder	Height of the bottom border

◆ setBorders() [4/4]

void tgui::WidgetBorders::setBorders	(	float	width,
		float	height
	)

inline

Changes the size of the borders.

Parameters

width	Width of the left and right borders
height	Height of the top and bottom borders

◆ setDistanceToSide()

void tgui::ChildWindowRenderer::setDistanceToSide ( float distanceToSide )

Changes the distance between the title and the side of the title bar.

Parameters

distanceToSide distance between the title and the side of the title bar

◆ setPaddingBetweenButtons()

void tgui::ChildWindowRenderer::setPaddingBetweenButtons ( float paddingBetweenButtons )

Changes the distance between the title buttons if multiple exist.

Parameters

paddingBetweenButtons distance between the title and the side of the title bar

◆ setProperty() [1/2]

virtual void tgui::ChildWindowRenderer::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.
Exception	when loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

Reimplemented in tgui::MessageBoxRenderer.

◆ setProperty() [2/2]

virtual void tgui::ChildWindowRenderer::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.
Exception	when loading scrollbar fails with the theme connected to the list box

Reimplemented from tgui::WidgetRenderer.

Reimplemented in tgui::MessageBoxRenderer.

◆ setTitleBarColor()

void tgui::ChildWindowRenderer::setTitleBarColor ( const Color & color )

Changes the color of the title bar.

Parameters

color New title bar color

Note that this color is ignored when you set an image as title bar.

◆ setTitleBarHeight()

void tgui::ChildWindowRenderer::setTitleBarHeight ( float height )

Change the height of the title bar.

Parameters

height New height of the title bar

◆ setTitleBarTexture()

void tgui::ChildWindowRenderer::setTitleBarTexture ( const Texture & texture )

Change the image of the title bar.

Parameters

texture New title bar texture

When this image is set, the title bar color property will be ignored. Pass an empty string to unset the image, in this case the title bar color property will be used again.

◆ setTitleColor()

void tgui::ChildWindowRenderer::setTitleColor ( const Color & color )

Changes the color of the title that is displayed in the title bar of the child window.

Parameters

color New title color for the child window

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

include/TGUI/Widgets/ChildWindow.hpp

TGUI

Public Member Functions

Constructor & Destructor Documentation

◆ ChildWindowRenderer()

Member Function Documentation

◆ getCloseButton()

◆ getMaximizeButton()

◆ getMinimizeButton()

◆ getProperty()

◆ getPropertyValuePairs()

◆ setBackgroundColor()

◆ setBorderColor()

◆ setBorders() [1/4]

◆ setBorders() [2/4]

◆ setBorders() [3/4]

◆ setBorders() [4/4]

◆ setDistanceToSide()

◆ setPaddingBetweenButtons()

◆ setProperty() [1/2]

◆ setProperty() [2/2]

◆ setTitleBarColor()

◆ setTitleBarHeight()

◆ setTitleBarTexture()

◆ setTitleColor()