Class used by bindings to implement custom widgets withing these bindings (e.g. a custom C# widget in TGUI.Net) More...

#include <TGUI/CustomWidgetForBindings.hpp>

Inheritance diagram for tgui::CustomWidgetForBindings:

Public Types
typedef std::shared_ptr< CustomWidgetForBindings >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const CustomWidgetForBindings >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	CustomWidgetForBindings (const char *typeName="CustomWidget", bool initRenderer=true)

void	setPosition (const Layout2d &position) override
	sets the position of the widget

void	setSize (const Layout2d &size) override
	Changes the size of the widget.

Vector2f	getFullSize () const override
	Returns the entire size that the widget is using.

Vector2f	getAbsolutePosition () const override
	Get the absolute position of the widget instead of the relative position to its parent.

Vector2f	getWidgetOffset () const override
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setVisible (bool visible) override
	Shows or hides a widget.

void	setEnabled (bool enabled) override
	Enables or disables the widget.

void	setFocused (bool focused) override
	Focus or unfocus the widget.

bool	canGainFocus () const override
	Returns whether the widget can gain focus.

bool	updateTime (Duration elapsedTime) override

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	leftMousePressed (Vector2f pos) override

void	leftMouseReleased (Vector2f pos) override

void	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

void	keyPressed (const Event::KeyEvent &event) override

void	textEntered (char32_t key) override

bool	mouseWheelScrolled (float delta, Vector2f pos) override

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getSharedRenderer () const

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getRenderer () const

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

bool	isVisible () const
	Returns true when the widget is visible.

bool	isEnabled () const
	Returns true when the widget is enabled.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename T >
T	getUserData () const
	Returns data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

virtual void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual Signal &	getSignal (String signalName)
	Retrieves a signal based on its name.

virtual void	setParent (Container *parent)

virtual void	mousePressed (Event::MouseButton button, Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	rightMouseButtonNoLongerDown ()

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Static Public Member Functions
static CustomWidgetForBindings::Ptr	create ()
	Creates a new widget.

Public Attributes
std::function< void(Vector2f)>	implPositionChanged

std::function< void(Vector2f)>	implSizeChanged

std::function< void(bool)>	implVisibleChanged

std::function< void(bool)>	implEnableChanged

std::function< void(bool)>	implFocusChanged

std::function< bool()>	implCanGainFocus

std::function< Vector2f()>	implGetFullSize

std::function< Vector2f()>	implGetAbsolutePosition

std::function< Vector2f()>	implGetWidgetOffset

std::function< bool(Duration)>	implUpdateTimeFunction

std::function< bool(Vector2f)>	implMouseOnWidget

std::function< void(Vector2f)>	implLeftMousePressed

std::function< void(Vector2f)>	implLeftMouseReleased

std::function< void(Vector2f)>	implRightMousePressed

std::function< void(Vector2f)>	implRightMouseReleased

std::function< void(Vector2f)>	implMouseMoved

std::function< void(const Event::KeyEvent &)>	implKeyPressed

std::function< void(char32_t)>	implTextEntered

std::function< bool(float, Vector2f)>	implMouseWheelScrolled

std::function< void()>	implMouseNoLongerOnWidget

std::function< void()>	implLeftMouseButtonNoLongerDown

std::function< void()>	implMouseEnteredWidget

std::function< void()>	implMouseLeftWidget

std::function< bool(const String &)>	implRendererChanged

std::function< void(BackendRenderTargetBase &, RenderStates)>	implDrawFunction

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalShowEffect	onAnimationFinish = {"AnimationFinished"}

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

void	mouseEnteredWidget () override
	This function is called when the mouse enters the widget.

void	mouseLeftWidget () override
	This function is called when the mouse leaves the widget.

Protected Member Functions inherited from tgui::Widget
virtual std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const
	Saves the widget as a tree node in order to save it to a file.

virtual void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
	Loads the widget from a tree of nodes.

Additional Inherited Members
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >

using	LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position

Layout2d	m_size

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true

bool	m_visible = true

Container *	m_parent = nullptr

GuiBase *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

Duration	m_animationTimeElapsed

bool	m_draggableWidget = false

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

Detailed Description

Class used by bindings to implement custom widgets withing these bindings (e.g. a custom C# widget in TGUI.Net)

Member Function Documentation

◆ canGainFocus()

bool tgui::CustomWidgetForBindings::canGainFocus ( ) const

overridevirtual

Returns whether the widget can gain focus.

Returns: Can the widget be focused?

Reimplemented from tgui::Widget.

◆ clone()

Widget::Ptr tgui::CustomWidgetForBindings::clone ( ) const

inlineoverridevirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns: Copy of the widget

Warning: This function should not be used as it won't function correctly because the binding object isn't changed.

Implements tgui::Widget.

◆ create()

static CustomWidgetForBindings::Ptr tgui::CustomWidgetForBindings::create ( )

static

Creates a new widget.

Returns: The new widget

◆ draw()

void tgui::CustomWidgetForBindings::draw	(	BackendRenderTargetBase &	target,
		RenderStates	states
	)		const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

◆ getAbsolutePosition()

Vector2f tgui::CustomWidgetForBindings::getAbsolutePosition ( ) const

overridevirtual

Get the absolute position of the widget instead of the relative position to its parent.

Returns: Absolute position of the widget

Reimplemented from tgui::Widget.

◆ getFullSize()

Vector2f tgui::CustomWidgetForBindings::getFullSize ( ) const

overridevirtual

Returns the entire size that the widget is using.

This function will return a value equal or greater than what getSize returns. If the widget would e.g. have borders around it then this function will return the size, including these borders.

Returns: Full size of the widget

Reimplemented from tgui::Widget.

◆ getWidgetOffset()

Vector2f tgui::CustomWidgetForBindings::getWidgetOffset ( ) const

overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

The offset is (0,0) for almost all widgets.

Returns: Offset of the widget

Reimplemented from tgui::Widget.

◆ isMouseOnWidget()

bool tgui::CustomWidgetForBindings::isMouseOnWidget ( Vector2f pos ) const

overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Implements tgui::Widget.

◆ keyPressed()

void tgui::CustomWidgetForBindings::keyPressed ( const Event::KeyEvent & event )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::CustomWidgetForBindings::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

void tgui::CustomWidgetForBindings::leftMousePressed ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::CustomWidgetForBindings::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseEnteredWidget()

void tgui::CustomWidgetForBindings::mouseEnteredWidget ( )

overrideprotectedvirtual

This function is called when the mouse enters the widget.

Reimplemented from tgui::Widget.

◆ mouseLeftWidget()

void tgui::CustomWidgetForBindings::mouseLeftWidget ( )

overrideprotectedvirtual

This function is called when the mouse leaves the widget.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::CustomWidgetForBindings::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::CustomWidgetForBindings::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseWheelScrolled()

bool tgui::CustomWidgetForBindings::mouseWheelScrolled	(	float	delta,
		Vector2f	pos
	)

overridevirtual

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::CustomWidgetForBindings::rendererChanged ( const String & property )

overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ rightMousePressed()

void tgui::CustomWidgetForBindings::rightMousePressed ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ rightMouseReleased()

void tgui::CustomWidgetForBindings::rightMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ setEnabled()

void tgui::CustomWidgetForBindings::setEnabled ( bool enabled )

overridevirtual

Enables or disables the widget.

Parameters

enabled Is the widget enabled?

The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ setFocused()

void tgui::CustomWidgetForBindings::setFocused ( bool focused )

overridevirtual

Focus or unfocus the widget.

Parameters

focused Is the widget focused?

When a widget is focused, the previously focused widget will be unfocused.

Warning: This function only works properly when the widget was already added to its parent (e.g. the Gui).

Reimplemented from tgui::Widget.

◆ setPosition()

void tgui::CustomWidgetForBindings::setPosition ( const Layout2d & position )

overridevirtual

sets the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget relative to the size of its parent
widget->setPosition({"5%", "10%"});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize()

void tgui::CustomWidgetForBindings::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setVisible()

void tgui::CustomWidgetForBindings::setVisible ( bool visible )

overridevirtual

Shows or hides a widget.

Parameters

visible Is the widget visible?

The widget won't receive events (and thus won't send callbacks) nor will it be drawn when hidden. The widget is visible by default.

Reimplemented from tgui::Widget.

◆ textEntered()

void tgui::CustomWidgetForBindings::textEntered ( char32_t key )

overridevirtual

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::CustomWidgetForBindings::updateTime ( Duration elapsedTime )

overridevirtual

Reimplemented from tgui::Widget.

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

include/TGUI/CustomWidgetForBindings.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canGainFocus()

◆ clone()

◆ create()

◆ draw()

◆ getAbsolutePosition()

◆ getFullSize()

◆ getWidgetOffset()

◆ isMouseOnWidget()

◆ keyPressed()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ mouseEnteredWidget()

◆ mouseLeftWidget()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ mouseWheelScrolled()

◆ rendererChanged()

◆ rightMousePressed()

◆ rightMouseReleased()

◆ setEnabled()

◆ setFocused()

◆ setPosition()

◆ setSize()

◆ setVisible()

◆ textEntered()

◆ updateTime()