ime::ui::PictureRenderer Class Reference

A Picture widget renderer. More...

#include <PictureRenderer.h>

Inheritance diagram for ime::ui::PictureRenderer:

Public Types
using	Ptr = std::shared_ptr< PictureRenderer >
	Shared renderer pointer. More...

Public Member Functions
void	setTexture (const std::string &filename)
	Change the image that is displayed. 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...
void	setInternalPtr (tgui::WidgetRenderer *renderer) override
tgui::WidgetRenderer *	getInternalPtr () override
	~PictureRenderer () override
	Destructor. More...

Detailed Description

A Picture widget renderer.

This class allows you to manipulate the render properties of a Picture widget

Definition at line 43 of file PictureRenderer.h.

Member Typedef Documentation

Ptr

using ime::ui::PictureRenderer::Ptr = std::shared_ptr<PictureRenderer>

Shared renderer pointer.

Definition at line 45 of file PictureRenderer.h.

Constructor & Destructor Documentation

~PictureRenderer()

ime::ui::PictureRenderer::~PictureRenderer ( )

override

Destructor.

Member Function Documentation

getOpacity()

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

overridevirtual

Get the opacity of the widget.

Returns

The opacity of the widget

Implements ime::ui::IWidgetRenderer.

getOpacityDisabled()

float ime::ui::PictureRenderer::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.

ignoreTransparentTexture()

void ime::ui::PictureRenderer::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::PictureRenderer::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.

setFont()

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

overridevirtual

Change the widgets font.

Parameters

filename

Filename of the new font

Exceptions

FileNotFound

If the font cannot be found on the disk

Implements ime::ui::IWidgetRenderer.

setOpacity()

void ime::ui::PictureRenderer::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::PictureRenderer::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.

setTexture()

void ime::ui::PictureRenderer::setTexture

(

const std::string &

filename

)

Change the image that is displayed.

Parameters

filename

Filename of the new texture

Exceptions

FileNotFound

if the image cannot be found on the disk

The filename must be relative to the executable path

---

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

• PictureRenderer.h