Detailed Description

A virtual UI Window displayed inside the rendering Window. All UI widgets must belong to a UI window.

Inheritance diagram for Window:

Public Types
enum	ResizeableBorder

Public Member Functions
	Window (const Rect &rect)

void	setResizeableBorders (const uint32_t borders)

uint32_t	getResizeableBorders () const

shared_ptr< Style >	getStyle () const

void	setStyle (const shared_ptr< Style > &style)

Widget &	getWidget () const

void	setWidget (shared_ptr< Widget > child=nullptr, const string &resources="", float padding=0)

template<typename T >
auto	add (const shared_ptr< T > &child, const Widget::AlignmentType alignment, const string &resource="", const bool overlap=false) const

void	remove (const shared_ptr< Widget > &child) const

void	setFocusedWidget (const shared_ptr< Widget > &)

float	getWidth () const

float	getHeight () const

void	setRect (const Rect &newRect)

void	setWidth (float width)

void	setHeight (float height)

void	setPos (float x, float y)

void	setPos (vec2 pos)

void	setX (float x)

void	setY (float y)

const Rect &	getRect () const

bool	isVisible () const

void	setVisible (bool isVisible)

void	hide ()

void	show ()

void	setTransparency (float)

virtual void	onCreate ()

virtual void	onDestroy ()

virtual void	onShow ()

virtual void	onHide ()

virtual void	onResize ()

virtual void	onMove ()

virtual bool	onKeyDown (Key key)

virtual bool	onKeyUp (Key key)

virtual bool	onMouseDown (MouseButton button, float x, float y)

virtual bool	onMouseUp (MouseButton button, float x, float y)

virtual bool	onMouseMove (uint32_t buttonsState, float x, float y)

virtual void	onGotFocus ()

virtual void	onLostFocus ()

void	setMinimumSize (float width, float height)

void	setMaximumSize (float width, float height)

float	getMinimumWidth () const

float	getMinimumHeight () const

float	getMaximumWidth () const

float	getMaximumHeight () const

Font &	getDefaultFont () const

Public Member Functions inherited from Object
void	connect (const Signal::signal &name, const Signal::Handler &handler)

void	connect (const Signal::signal &name, const function< void ()> &handler)

void	emit (const Signal::signal &name, void *params=nullptr)

virtual string	toString () const

Member Enumeration Documentation

enum ResizeableBorder

Which Window borders can be used to resize the Window

Constructor & Destructor Documentation

Window ( const Rect & rect )

explicit

Creates a virtual UI window with a given position & size

Member Function Documentation

auto add	(	const shared_ptr< T > &	child,
		const Widget::AlignmentType	alignment,
		const string &	resource = `""`,
		const bool	overlap = `false`
	)		const

inline

Adds a child widget. Children widgets will be destroyed on parent destruction.

Parameters

child	: child widget to add
alignment	: placement
resource	: resource string
overlap	: overlap widget on top of other widgets

Font& getDefaultFont ( ) const

nodiscard

Returns the default font loaded at startup

float getHeight ( ) const

nodiscardinline

Returns the height of the client area

float getMaximumHeight ( ) const

nodiscardinline

Returns the maximum height of the Window

float getMaximumWidth ( ) const

nodiscardinline

Returns the maximum width of the Window

float getMinimumHeight ( ) const

nodiscardinline

Returns the minimum height of the Window

float getMinimumWidth ( ) const

nodiscardinline

Returns the minimum width of the Window

const Rect& getRect ( ) const

nodiscardinline

Returns the size & position of the widget

uint32_t getResizeableBorders ( ) const

nodiscardinline

Returns the borders that can be used to resize the Window

shared_ptr<Style> getStyle ( ) const

nodiscard

Returns the current style layout or null

Widget& getWidget ( ) const

nodiscard

Returns the main widget . This is the widget that covers the entire Window and is the parent of all the widgets in the Window.

float getWidth ( ) const

nodiscardinline

Returns the width of the client area

void hide ( )

Hides the Window. The change will be effective at the start of the next frame : it needs to be called before adding the Window to the manager if you want the Window to be hidden at startup

bool isVisible ( ) const

nodiscardinline

Returns true if Window is currently visible

virtual void onCreate ( )

inlinevirtual

Event called after Window creation (by the Window manager)

virtual void onDestroy ( )

inlinevirtual

Event called after Window destruction (by the Window manager)

virtual void onGotFocus ( )

inlinevirtual

Event called when the Window got the keyboard focus

virtual void onHide ( )

inlinevirtual

Event called when (after) the Window manager need to hide the Window

virtual bool onKeyDown ( Key key )

inlinevirtual

Event called when a key was pressed

virtual bool onKeyUp ( Key key )

inlinevirtual

Event called when a key was released

virtual void onLostFocus ( )

inlinevirtual

Event called when the Window lost the keyboard focus

virtual bool onMouseDown	(	MouseButton	button,
		float	x,
		float	y
	)

inlinevirtual

Event called when a mouse button was pressed inside the Window

virtual bool onMouseMove	(	uint32_t	buttonsState,
		float	x,
		float	y
	)

inlinevirtual

Event called when mouse is moved above the Window client area

virtual bool onMouseUp	(	MouseButton	button,
		float	x,
		float	y
	)

inlinevirtual

Event called when a mouse button was released inside the Window

virtual void onMove ( )

inlinevirtual

Event called after a position change

virtual void onResize ( )

inlinevirtual

Event called after a size change

virtual void onShow ( )

inlinevirtual

Event called when (before) the Window manager need to show the Window

void remove ( const shared_ptr< Widget > & child ) const

inline

Removes a child widget

void setFocusedWidget ( const shared_ptr< Widget > & )

Changes the focus

void setHeight ( float height )

Sets the height of the client area

void setMaximumSize	(	float	width,
		float	height
	)

Sets the maximum size of the Window (default to VECTOR_SCALE)

void setMinimumSize	(	float	width,
		float	height
	)

Sets the minimum size of the Window (default to {2.0f, 2.0f})

void setPos	(	float	x,
		float	y
	)

Sets the position of the Window, bottom-left

void setPos ( vec2 pos )

Sets the position of the Window, bottom-left

void setRect ( const Rect & newRect )

Sets the client area position & size

void setResizeableBorders ( const uint32_t borders )

inline

Sets the borders that can be used to resize the Window

void setStyle ( const shared_ptr< Style > & style )

Sets the current style layout. If null, installs a default layout

void setTransparency ( float )

Sets the alpha value for transparency

void setVisible ( bool isVisible )

Sets the Window visibility. The change will be effective at the start of the next frame

void setWidget	(	shared_ptr< Widget >	child = `nullptr`,
		const string &	resources = `""`,
		float	padding = `0`
	)

Sets the main widget with optional resource string. Call SetLayout(nullptr) if no layout have been set previously

Parameters

child	: child widget to add
resources	placement
padding	: new widget padding

void setWidth ( float width )

Sets the width of the client area

void setX ( float x )

Sets the X position of the Window, bottom-left

void setY ( float y )

Sets the Y position of the Window, bottom-left

void show ( )

Shows the Window. The change will be effective at the start of the next frame

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation