A Panel widget renderer. More...

#include <PanelRenderer.h>

Inheritance diagram for ime::ui::PanelRenderer:

Public Types
using	Ptr = std::unique_ptr< PanelRenderer >
	Unique renderer pointer. More...

Public Member Functions
void	setBorders (const Borders &borders)
	Change the size of the widget borders. More...

Borders	getBorders () const
	Get the ize of the widgets borders. More...

void	setBorderColour (Colour colour)
	Set the border colour. More...

Colour	getBorderColour () const
	Get the border colour. More...

void	setBackgroundColour (Colour colour)
	Set the background colour of the button. More...

Colour	getBackgroundColour () const
	Get the background colour of button. More...

void	setRoundedBorderRadius (float radius)
	Set the radius for the rounded corners. More...

float	getRoundedBorderRadius () const
	Get the radius of the rounded corners. More...

void	setBackgroundTexture (const std::string &texture)
	Set the background image of the panel. More...

void	setOpacity (float opacity) override
	Set the opacity of the widget. More...

float	getOpacity () const override
	Get the opacity of the widget. More...

void	setOpacityDisabled (float opacity) override
	Set the opacity of the widget when it is disabled. More...

float	getOpacityDisabled () const override
	Get the opacity of the widget when it is disabled. More...

void	setFont (const std::string &filename) override
	Change the widgets font. More...

void	ignoreTransparentTexture (bool ignoreTransparentParts) override
	Set whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...

bool	isTransparentTextureIgnored () const override
	Check if mouse events are ignored on transparent parts of the texture or not. More...

IWidgetRenderer::Ptr	clone () const override
	Create a copy of the render. More...

void	setInternalPtr (tgui::WidgetRenderer *renderer) override

tgui::WidgetRenderer *	getInternalPtr () override

	~PanelRenderer () override
	Destructor. More...

Detailed Description

A Panel widget renderer.

This class allows you to manipulate the render properties of a Panel

Definition at line 43 of file PanelRenderer.h.

Member Typedef Documentation

◆ Ptr

using ime::ui::PanelRenderer::Ptr = std::unique_ptr<PanelRenderer>

Unique renderer pointer.

Definition at line 45 of file PanelRenderer.h.

Constructor & Destructor Documentation

◆ ~PanelRenderer()

ime::ui::PanelRenderer::~PanelRenderer ( )

override

Destructor.

Member Function Documentation

◆ clone()

IWidgetRenderer::Ptr ime::ui::PanelRenderer::clone ( ) const

overridevirtual

Create a copy of the render.

Returns: A copy of the render

Implements ime::ui::IWidgetRenderer.

◆ getBackgroundColour()

Colour ime::ui::PanelRenderer::getBackgroundColour ( ) const

Get the background colour of button.

Returns: The background colour of the button

◆ getBorderColour()

Colour ime::ui::PanelRenderer::getBorderColour ( ) const

Get the border colour.

Returns: The border colour

◆ getBorders()

Borders ime::ui::PanelRenderer::getBorders ( ) const

Get the ize of the widgets borders.

Returns: The size of the widgets borders

◆ getInternalPtr()

tgui::WidgetRenderer * ime::ui::PanelRenderer::getInternalPtr ( )

overridevirtual

Implements ime::ui::IWidgetRenderer.

◆ getOpacity()

float ime::ui::PanelRenderer::getOpacity ( ) const

overridevirtual

Get the opacity of the widget.

Returns: The opacity of the widget

Implements ime::ui::IWidgetRenderer.

◆ getOpacityDisabled()

float ime::ui::PanelRenderer::getOpacityDisabled ( ) const

overridevirtual

Get the opacity of the widget when it is disabled.

Returns: The opacity of the widget in disabled state

This function will return -1 if the widget uses the same opacity as the enabled state when it is disabled

Implements ime::ui::IWidgetRenderer.

◆ getRoundedBorderRadius()

float ime::ui::PanelRenderer::getRoundedBorderRadius ( ) const

Get the radius of the rounded corners.

Returns: The radius of the rounded corners

See also: setRoundedBorderRadius

◆ ignoreTransparentTexture()

void ime::ui::PanelRenderer::ignoreTransparentTexture ( bool ignoreTransparentParts )

overridevirtual

Set whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.

Parameters

ignoreTransparentParts True to ignore mouse events on transparent parts of the texture, otherwise false

When mouse events are ignored, they are passed to a widget behind the widget. By default, mouse events are NOT ignored and the widget will receive mouse events even on transparent texture parts. This property does nothing if the widget doesn't use textures

Implements ime::ui::IWidgetRenderer.

◆ isTransparentTextureIgnored()

bool ime::ui::PanelRenderer::isTransparentTextureIgnored ( ) const

overridevirtual

Check if mouse events are ignored on transparent parts of the texture or not.

Returns: True if mouse events are ignored, otherwise false

See also: ignoreTransparentTexture

Implements ime::ui::IWidgetRenderer.

◆ setBackgroundColour()

void ime::ui::PanelRenderer::setBackgroundColour ( Colour colour )

Set the background colour of the button.

Parameters

colour The background colour to set

Note: that this colour is ignored when you set a background image

◆ setBackgroundTexture()

void ime::ui::PanelRenderer::setBackgroundTexture ( const std::string & texture )

Set the background image of the panel.

Parameters

texture The new background image

When this image is set then the background colour property will be ignored

◆ setBorderColour()

void ime::ui::PanelRenderer::setBorderColour ( Colour colour )

Set the border colour.

Parameters

colour The border colour to set

◆ setBorders()

void ime::ui::PanelRenderer::setBorders ( const Borders & borders )

Change the size of the widget borders.

Parameters

borders The size of the borders

◆ setFont()

void ime::ui::PanelRenderer::setFont ( const std::string & filename )

overridevirtual

Change the widgets font.

Parameters

filename Filename of the new font

Exceptions

FileNotFoundException If the font cannot be found on the disk

Implements ime::ui::IWidgetRenderer.

◆ setInternalPtr()

void ime::ui::PanelRenderer::setInternalPtr ( tgui::WidgetRenderer * renderer )

overridevirtual

Implements ime::ui::IWidgetRenderer.

◆ setOpacity()

void ime::ui::PanelRenderer::setOpacity ( float opacity )

overridevirtual

Set the opacity of the widget.

Parameters

opacity The new opacity of the widget in between 0 and 1

0 means completely transparent, while 1 (default) means fully opaque

Implements ime::ui::IWidgetRenderer.

◆ setOpacityDisabled()

void ime::ui::PanelRenderer::setOpacityDisabled ( float opacity )

overridevirtual

Set the opacity of the widget when it is disabled.

Parameters

opacity Opacity to set between 0 and 1

0 means completely transparent, while 1 (default) means fully opaque. Set to -1 (default) to use the normal opacity value even when the widget is disabled.

Implements ime::ui::IWidgetRenderer.

◆ setRoundedBorderRadius()

void ime::ui::PanelRenderer::setRoundedBorderRadius ( float radius )

Set the radius for the rounded corners.

Parameters

radius Radius of the corners

This function will round the corners of the panel, radius controls how much rounding is applied to the borders of the panel.

By default the radius is 0, meaning the panel is not rounded

Warning: This property is ignored when textures are used as background

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

PanelRenderer.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~PanelRenderer()

Member Function Documentation

◆ clone()

◆ getBackgroundColour()

◆ getBorderColour()

◆ getBorders()

◆ getInternalPtr()

◆ getOpacity()

◆ getOpacityDisabled()

◆ getRoundedBorderRadius()

◆ ignoreTransparentTexture()

◆ isTransparentTextureIgnored()

◆ setBackgroundColour()

◆ setBackgroundTexture()

◆ setBorderColour()

◆ setBorders()

◆ setFont()

◆ setInternalPtr()

◆ setOpacity()

◆ setOpacityDisabled()

◆ setRoundedBorderRadius()