Inheritance diagram for tgui::ChildWindowRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.

Borders	getBorders () const
	Returns the size of the borders.

void	setTitleBarHeight (float height)
	Changes the height of the title bar.

float	getTitleBarHeight () const
	Returns the height of the title bar.

void	setTitleBarColor (Color color)
	Changes the color of the title bar.

Color	getTitleBarColor () const
	Returns the color of the title bar.

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

Color	getTitleColor () const
	Returns the color of the title that is displayed in the title bar of the child window.

void	setBackgroundColor (Color color)
	Changes the color of the background.

Color	getBackgroundColor () const
	Returns the color of the background.

void	setBorderColor (Color color)
	Changes the color of the borders.

Color	getBorderColor () const
	Returns the color of the borders.

void	setBorderColorFocused (Color color)
	Changes the color of the borders when the widget is focused.

Color	getBorderColorFocused () const
	Returns the color of the borders when the widget is focused.

void	setBorderBelowTitleBar (float border)
	Changes the distance between the title bar and the actual contents of the child window.

float	getBorderBelowTitleBar () const
	Returns the distance between the title bar and the actual contents of the child window.

void	setDistanceToSide (float distanceToSide)
	Changes the distance of the title or close button from the side of the title bar.

float	getDistanceToSide () const
	Returns the distance of the title or close button from the side of the title bar.

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

float	getPaddingBetweenButtons () const
	Returns the distance between the title buttons if multiple exist.

void	setMinimumResizableBorderWidth (float minimumBorderWidth)
	Changes the minimum width of the area where you can drag to resize the child window.

float	getMinimumResizableBorderWidth () const
	Returns the minimum width of the area where you can drag to resize the child window.

void	setShowTextOnTitleButtons (bool showText)
	Changes whether characters are rendered on top of the title buttons.

bool	getShowTextOnTitleButtons () const
	Returns whether characters are rendered on top of the title buttons.

void	setTextureTitleBar (const Texture &texture)
	Changes the image of the title bar.

const Texture &	getTextureTitleBar () const
	Returns the image of the title bar.

void	setTextureBackground (const Texture &texture)
	Changes the background image.

const Texture &	getTextureBackground () const
	Returns the background image.

void	setCloseButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional close button.

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

void	setMaximizeButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional maximize button.

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

void	setMinimizeButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional minimize button.

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

	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.

float	getOpacity () const
	Returns the opacity of the widget.

void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.

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.

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.

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.

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.

ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.

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 (std::shared_ptr< RendererData > data)

std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.

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()

Color tgui::ChildWindowRenderer::getBackgroundColor ( ) const

nodiscard

Returns the color of the background.

Returns: Background color

◆ getBorderBelowTitleBar()

float tgui::ChildWindowRenderer::getBorderBelowTitleBar ( ) const

nodiscard

Returns the distance between the title bar and the actual contents of the child window.

Returns: Space between title bar and child window contents

◆ getBorderColor()

Color tgui::ChildWindowRenderer::getBorderColor ( ) const

nodiscard

Returns the color of the borders.

Returns: border color

◆ getBorderColorFocused()

Color tgui::ChildWindowRenderer::getBorderColorFocused ( ) const

nodiscard

Returns the color of the borders when the widget is focused.

Returns: focused border color

◆ getBorders()

Borders tgui::ChildWindowRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns: border size

◆ getCloseButton()

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

nodiscard

Returns the renderer data of the close button.

Returns: Data about how the close button looks

◆ getDistanceToSide()

float tgui::ChildWindowRenderer::getDistanceToSide ( ) const

nodiscard

Returns the distance of the title or close button from the side of the title bar.

Returns: Distance between the title and the side of the title bar

◆ getMaximizeButton()

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

nodiscard

Returns the renderer data of the maximize button.

Returns: Data about how the maximize button looks

◆ getMinimizeButton()

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

nodiscard

Returns the renderer data of the minimize button.

Returns: Data about how the minimize button looks

◆ getMinimumResizableBorderWidth()

float tgui::ChildWindowRenderer::getMinimumResizableBorderWidth ( ) const

nodiscard

Returns the minimum width of the area where you can drag to resize the child window.

Returns: Minimum amount of pixels where the child window can be dragged to resize it

If the border is larger than this value then it has no effect. If the borders are smaller, several invisible pixels next to the border can also be used to resize the child window.

◆ getPaddingBetweenButtons()

float tgui::ChildWindowRenderer::getPaddingBetweenButtons ( ) const

nodiscard

Returns the distance between the title buttons if multiple exist.

Returns: Distance between the title buttons

◆ getShowTextOnTitleButtons()

bool tgui::ChildWindowRenderer::getShowTextOnTitleButtons ( ) const

nodiscard

Returns whether characters are rendered on top of the title buttons.

Returns: Should text be shown on the title buttons?

◆ getTextureBackground()

const Texture & tgui::ChildWindowRenderer::getTextureBackground ( ) const

nodiscard

Returns the background image.

Returns: background texture

◆ getTextureTitleBar()

const Texture & tgui::ChildWindowRenderer::getTextureTitleBar ( ) const

nodiscard

Returns the image of the title bar.

Returns: title bar texture

◆ getTitleBarColor()

Color tgui::ChildWindowRenderer::getTitleBarColor ( ) const

nodiscard

Returns the color of the title bar.

Returns: Title bar color

◆ getTitleBarHeight()

float tgui::ChildWindowRenderer::getTitleBarHeight ( ) const

nodiscard

Returns the height of the title bar.

Returns: Title bar height

◆ getTitleColor()

Color tgui::ChildWindowRenderer::getTitleColor ( ) const

nodiscard

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

Returns: Title color for the child window

◆ setBackgroundColor()

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

Changes the color of the background.

Parameters

color New background color

◆ setBorderBelowTitleBar()

void tgui::ChildWindowRenderer::setBorderBelowTitleBar ( float border )

Changes the distance between the title bar and the actual contents of the child window.

Parameters

border Space between title bar and child window contents

◆ setBorderColor()

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

Changes the color of the borders.

Parameters

color New border color

◆ setBorderColorFocused()

void tgui::ChildWindowRenderer::setBorderColorFocused ( Color color )

Changes the color of the borders when the widget is focused.

Parameters

color New focused border color

◆ setBorders()

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

Changes the size of the borders.

Parameters

borders Size of the borders

◆ setCloseButton()

void tgui::ChildWindowRenderer::setCloseButton ( std::shared_ptr< RendererData > rendererData )

Sets the renderer data of the optional close button.

Parameters

rendererData Data about how the close button should look

◆ setDistanceToSide()

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

Changes the distance of the title or close button from the side of the title bar.

Parameters

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

◆ setMaximizeButton()

void tgui::ChildWindowRenderer::setMaximizeButton ( std::shared_ptr< RendererData > rendererData )

Sets the renderer data of the optional maximize button.

Parameters

rendererData Data about how the maximize button should look

◆ setMinimizeButton()

void tgui::ChildWindowRenderer::setMinimizeButton ( std::shared_ptr< RendererData > rendererData )

Sets the renderer data of the optional minimize button.

Parameters

rendererData Data about how the minimize button should look

◆ setMinimumResizableBorderWidth()

void tgui::ChildWindowRenderer::setMinimumResizableBorderWidth ( float minimumBorderWidth )

Changes the minimum width of the area where you can drag to resize the child window.

Parameters

minimumBorderWidth Minimum amount of pixels where the child window can be dragged to resize it

If the border is larger than minimumBorderWidth then this function has no effect. If the borders are smaller, several invisible pixels next to the border can also be used to resize the child window.

◆ setPaddingBetweenButtons()

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

Changes the distance between the title buttons if multiple exist.

Parameters

padding Distance between the title buttons

◆ setShowTextOnTitleButtons()

void tgui::ChildWindowRenderer::setShowTextOnTitleButtons ( bool showText )

Changes whether characters are rendered on top of the title buttons.

Parameters

showText Should text be shown on the title buttons?

◆ setTextureBackground()

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

◆ setTextureTitleBar()

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

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

◆ setTitleBarColor()

void tgui::ChildWindowRenderer::setTitleBarColor ( 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 )

Changes the height of the title bar.

Parameters

height New height of the title bar

◆ setTitleColor()

void tgui::ChildWindowRenderer::setTitleColor ( 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

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > & data )

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

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

include/TGUI/Renderers/ChildWindowRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBorderBelowTitleBar()

◆ getBorderColor()

◆ getBorderColorFocused()

◆ getBorders()

◆ getCloseButton()

◆ getDistanceToSide()

◆ getMaximizeButton()

◆ getMinimizeButton()

◆ getMinimumResizableBorderWidth()

◆ getPaddingBetweenButtons()

◆ getShowTextOnTitleButtons()

◆ getTextureBackground()

◆ getTextureTitleBar()

◆ getTitleBarColor()

◆ getTitleBarHeight()

◆ getTitleColor()

◆ setBackgroundColor()

◆ setBorderBelowTitleBar()

◆ setBorderColor()

◆ setBorderColorFocused()

◆ setBorders()

◆ setCloseButton()

◆ setDistanceToSide()

◆ setMaximizeButton()

◆ setMinimizeButton()

◆ setMinimumResizableBorderWidth()

◆ setPaddingBetweenButtons()

◆ setShowTextOnTitleButtons()

◆ setTextureBackground()

◆ setTextureTitleBar()

◆ setTitleBarColor()

◆ setTitleBarHeight()

◆ setTitleColor()

◆ WidgetRenderer()