gf::Widget Class Reference

The widgets abstract class. More...

#include <gf/Widget.h>

Inheritance diagram for gf::Widget:

Public Member Functions
	Widget ()
	Constructor. More...
virtual	~Widget ()
	Destructor. More...
virtual void	render (RenderTarget &target, const RenderStates &states)=0
	Render the widget on the target. More...
virtual bool	contains (Vector2f coords)=0
	Check if the widget contains the coordinates. More...
void	setDisabled ()
	Disable the widget. More...
bool	isDisabled () const noexcept
	Check if the widget is disabled. More...
void	setDefault ()
	Set the widget to it's default state. More...
bool	isDefault () const noexcept
	Check if the widget is in default state. More...
void	setSelected ()
	Select the widget. More...
bool	isSelected () const
	Check if the widget is selected. More...
void	setState (WidgetState state)
	Set the state of the widget directly. More...
WidgetState	getState () const noexcept
	Get the state of the widget. More...
void	setCallback (std::function< void()> callback)
	Set the callback of the widget. More...
void	triggerCallback ()
	Execute the callback function. More...

Protected Member Functions
virtual void	triggered ()
	Function called when the callback is triggered. More...

Detailed Description

The widgets abstract class.

Constructor & Destructor Documentation

Widget()

gf::Widget::Widget

(

)

Constructor.

The widget is in the default state.

~Widget()

virtual gf::Widget::~Widget ( )

virtual

Destructor.

Member Function Documentation

contains()

virtual bool gf::Widget::contains ( Vector2f  coords )

pure virtual

Check if the widget contains the coordinates.

Parameters

coords

The coordinates to check

Returns

True if the coordinates are inside the widget

Implemented in gf::SpriteWidget, gf::TextShapeWidget, and gf::TextWidget.

getState()

WidgetState gf::Widget::getState ( ) const

inlinenoexcept

Get the state of the widget.

Returns

The current state of the widget

isDefault()

bool gf::Widget::isDefault ( ) const

inlinenoexcept

Check if the widget is in default state.

Returns

True if the widget is in default state

isDisabled()

bool gf::Widget::isDisabled ( ) const

inlinenoexcept

Check if the widget is disabled.

Returns

True if the widget is disabled

isSelected()

bool gf::Widget::isSelected ( ) const

inline

Check if the widget is selected.

Returns

True if the widget is selected

render()

virtual void gf::Widget::render ( RenderTarget &  target, const RenderStates &  states  )

pure virtual

Render the widget on the target.

Parameters

target	The render target
states	The render states to use for drawing

Implemented in gf::SpriteWidget, gf::TextShapeWidget, and gf::TextWidget.

setCallback()

void gf::Widget::setCallback

(

std::function< void()>

callback

)

Set the callback of the widget.

Parameters

callback

The function that will be execute when the widget will be triggered.

See also

triggerCallback()

setDefault()

void gf::Widget::setDefault

(

)

Set the widget to it's default state.

setDisabled()

void gf::Widget::setDisabled

(

)

Disable the widget.

setSelected()

void gf::Widget::setSelected

(

)

Select the widget.

setState()

void gf::Widget::setState

(

WidgetState

state

)

Set the state of the widget directly.

Parameters

state

The new state

See also

setDisabled(), setDefault(), setSelected()

triggerCallback()

void gf::Widget::triggerCallback

(

)

Execute the callback function.

See also

setCallback()

triggered()

virtual void gf::Widget::triggered ( )

protectedvirtual

Function called when the callback is triggered.

This function is called before the callback.

Reimplemented in gf::ChoiceSpriteWidget.