TGUI  0.8-dev
tgui::ChildWindowRenderer Class Reference
Inheritance diagram for tgui::ChildWindowRenderer:
tgui::WidgetRenderer tgui::MessageBoxRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setTitleBarHeight (float height)
 Changes the height of the title bar. More...
 
float getTitleBarHeight () const
 Returns the height of the title bar. More...
 
void setTitleBarColor (Color color)
 Changes the color of the title bar. More...
 
Color getTitleBarColor () const
 Returns the color of the title bar. More...
 
void setTitleColor (Color color)
 Changes the color of the title that is displayed in the title bar of the child window. More...
 
Color getTitleColor () const
 Returns the color of the title that is displayed in the title bar of the child window. More...
 
void setBackgroundColor (Color color)
 Changes the color of the background. More...
 
Color getBackgroundColor () const
 Returns the color of the background. More...
 
void setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setDistanceToSide (float distanceToSide)
 Changes the distance of the title or close button from the side of the title bar. More...
 
float getDistanceToSide () const
 Returns the distance of the title or close button from the side of the title bar. More...
 
void setPaddingBetweenButtons (float padding)
 Changes the distance between the title buttons if multiple exist. More...
 
float getPaddingBetweenButtons () const
 Returns the distance between the title buttons if multiple exist. More...
 
void setTextureTitleBar (const Texture &texture)
 Changes the image of the title bar. More...
 
TexturegetTextureTitleBar () const
 Returns the image of the title bar. More...
 
void setCloseButton (std::shared_ptr< RendererData > rendererData)
 Sets the renderer data of the optional close button. More...
 
std::shared_ptr< RendererDatagetCloseButton () const
 Returns the renderer data of the close button. More...
 
void setMaximizeButton (std::shared_ptr< RendererData > rendererData)
 Sets the renderer data of the optional maximize button. More...
 
std::shared_ptr< RendererDatagetMaximizeButton () const
 Returns the renderer data of the maximize button. More...
 
void setMinimizeButton (std::shared_ptr< RendererData > rendererData)
 Sets the renderer data of the optional minimize button. More...
 
std::shared_ptr< RendererDatagetMinimizeButton () const
 Returns the renderer data of the minimize button. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getBackgroundColor()

Color tgui::ChildWindowRenderer::getBackgroundColor ( ) const

Returns the color of the background.

Returns
Background color

◆ getBorderColor()

Color tgui::ChildWindowRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
border color

◆ getBorders()

Borders tgui::ChildWindowRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getCloseButton()

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

Returns the renderer data of the close button.

Returns
Data about how the close button looks

◆ getDistanceToSide()

float tgui::ChildWindowRenderer::getDistanceToSide ( ) const

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

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

Returns the renderer data of the minimize button.

Returns
Data about how the minimize button looks

◆ getPaddingBetweenButtons()

float tgui::ChildWindowRenderer::getPaddingBetweenButtons ( ) const

Returns the distance between the title buttons if multiple exist.

Returns
Distance between the title buttons

◆ getTextureTitleBar()

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

Returns the image of the title bar.

Returns
title bar texture

◆ getTitleBarColor()

Color tgui::ChildWindowRenderer::getTitleBarColor ( ) const

Returns the color of the title bar.

Returns
Title bar color

◆ getTitleBarHeight()

float tgui::ChildWindowRenderer::getTitleBarHeight ( ) const

Returns the height of the title bar.

Returns
Title bar height

◆ getTitleColor()

Color tgui::ChildWindowRenderer::getTitleColor ( ) const

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
colorNew background color

◆ setBorderColor()

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

Changes the color of the borders.

Parameters
colorNew border color

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setCloseButton()

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

Sets the renderer data of the optional close button.

Parameters
rendererDataData 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
distanceToSideDistance 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
rendererDataData 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
rendererDataData about how the minimize button should look

◆ setPaddingBetweenButtons()

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

Changes the distance between the title buttons if multiple exist.

Parameters
paddingDistance between the title buttons

◆ setTextureTitleBar()

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

Changes the image of the title bar.

Parameters
textureNew 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
colorNew 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
heightNew 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
colorNew title color for the child window

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