ime::ui::IWidgetRenderer Class Reference

Interface for widget renderers. More...

#include <IWidgetRenderer.h>

Inheritance diagram for ime::ui::IWidgetRenderer:

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

Public Member Functions
virtual void	setOpacity (float opacity)=0
	Set the opacity of the widget. More...
virtual float	getOpacity () const =0
	Get the opacity of the widget. More...
virtual void	setOpacityDisabled (float opacity)=0
	Set the opacity of the widget when it is disabled. More...
virtual float	getOpacityDisabled () const =0
	Get the opacity of the widget when it is disabled. More...
virtual void	setFont (const std::string &filename)=0
	Change the widgets font. More...
virtual void	ignoreTransparentTexture (bool ignoreTransparentParts)=0
	Set whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
virtual bool	isTransparentTextureIgnored () const =0
	Check if mouse events are ignored on transparent parts of the texture or not. More...
virtual void	setInternalPtr (tgui::WidgetRenderer *renderer)=0
virtual IWidgetRenderer::Ptr	clone () const =0
	Clone the renderer. More...
virtual tgui::WidgetRenderer *	getInternalPtr ()=0
virtual	~IWidgetRenderer ()=default
	Destructor. More...

Detailed Description

Interface for widget renderers.

Definition at line 73 of file IWidgetRenderer.h.

Member Typedef Documentation

Ptr

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

Unique renderer pointer.

Definition at line 75 of file IWidgetRenderer.h.

Constructor & Destructor Documentation

~IWidgetRenderer()

virtual ime::ui::IWidgetRenderer::~IWidgetRenderer ( )

virtualdefault

Destructor.

Member Function Documentation

clone()

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

pure virtual

Clone the renderer.

Returns

A clone of this renderer

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

getOpacity()

virtual float ime::ui::IWidgetRenderer::getOpacity ( ) const

pure virtual

Get the opacity of the widget.

Returns

The opacity of the widget

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

getOpacityDisabled()

virtual float ime::ui::IWidgetRenderer::getOpacityDisabled ( ) const

pure virtual

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

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

ignoreTransparentTexture()

virtual void ime::ui::IWidgetRenderer::ignoreTransparentTexture ( bool  ignoreTransparentParts )

pure virtual

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

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

isTransparentTextureIgnored()

virtual bool ime::ui::IWidgetRenderer::isTransparentTextureIgnored ( ) const

pure virtual

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

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

setFont()

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

pure virtual

Change the widgets font.

Parameters

filename

Filename of the new font

Exceptions

FileNotFoundException

If the font cannot be found on the disk

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

setOpacity()

virtual void ime::ui::IWidgetRenderer::setOpacity ( float  opacity )

pure virtual

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

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

setOpacityDisabled()

virtual void ime::ui::IWidgetRenderer::setOpacityDisabled ( float  opacity )

pure virtual

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.

Implemented in ime::ui::BoxLayoutRenderer, ime::ui::ButtonRenderer, ime::ui::CheckBoxRenderer, ime::ui::ChildWindowRenderer, ime::ui::EditBoxRenderer, ime::ui::LabelRenderer, ime::ui::MenuBarRenderer, ime::ui::MessageBoxRenderer, ime::ui::PanelRenderer, ime::ui::PictureRenderer, ime::ui::ProgressBarRenderer, ime::ui::RadioButtonRenderer, ime::ui::ScrollablePanelRenderer, ime::ui::SeparatorRenderer, ime::ui::SliderRenderer, ime::ui::SpinButtonRenderer, and ime::ui::TabsRenderer.

---

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

• IWidgetRenderer.h