i6e::api::GUIFacade Class Reference

This class manages the GUIWindows and provides some general API methods that aren't related to a special window. More...

#include <D:/Projekte/i6engine/libs/i6engine-modules/include/i6engine/api/facades/GUIFacade.h>

Public Member Functions
	GUIFacade ()
	~GUIFacade ()
void	startGUI (const std::string &strScheme, const std::string &strFont, const std::string &strDefaultFont, const std::string &strDefaultMouseImageSet, const std::string &strDefaultMouseImageName) const
	Creates the GUI. This function has to be called before you can start creating windows ect. More...
void	addToRootWindow (const std::string &child_window) const
	Add the child_window to the RootWindow. More...
void	setMouseVisibility (const bool visibility) const
	Sets the MouseVisibility. More...
void	clearAllWindows () const
	Delete all windows. Should be used when shutting down. More...
void	subscribeEvent (const std::string &windowname, const std::string &eventType, const boost::function< void(void)> &ptrEventMethod) const
	Subscribes for an event (Mouse-Click). More...
void	changeEvent (const std::string &windowname, bool b) const
	Enable and Disable Events of Windows. More...
void	setMouseCursorImage (const std::string &image) const
	sets image for mouse cursor More...
void	addImageset (const std::string &imageset) const
	adds given imageset so it can be used with own graphics More...
void	loadCanvas (const std::string &name, const std::string &file) const
	loads a canvas file More...
void	addPrint (const std::string &name, const std::string &type, const double x, const double y, const std::string &message, gui::Alignment alignment, const int64_t lifetime=-1) const
	Adds a new Text to the screen. More...
void	addProgressBar (const std::string &name, const std::string &type, const double x, const double y, const double w, const double h) const
	Adds a new ProgressBar to the screen. More...
void	addEditbox (const std::string &name, const std::string &type, double x, double y, double w, double h, const std::string &defaultText, const std::function< void(std::string)> &enterCallback) const
	Adds a new Editbox to the screen. More...
void	addTextButton (const std::string &name, const std::string &type, double x, double y, double w, double h, const std::string &text) const
	Adds a new TextButton to the screen. More...
void	addImageButton (const std::string &name, const std::string &type, double x, double y, double w, double h, const std::string &normalImage, const std::string &hoverImage, const std::string &pushedImage) const
	Adds a new ImageButton to the screen. More...
void	addToggleButton (const std::string &name, const std::string &type, double x, double y, double w, double h, bool selected, const std::function< void(bool)> &selectedCallback) const
	Adds a new ToggleButton to the screen. More...
void	addStatusList (const std::string &name, const std::string &type, const double x, const double y, const int64_t lifetime) const
	Creates a StatusList-GuiWidget. More...
void	addImage (const std::string &name, const std::string &type, const std::string &imageSetName, const std::string &imageName, const double x, const double y, const double w, const double h) const
	Adds a new Image to the screen. More...
void	addMultiColumnList (const std::string &name, const std::string &type, const double x, const double y, const double w, const double h) const
	Adds a MultiColumnList to the screen. More...
void	addComboBox (const std::string &name, const std::string &type, const double x, const double y, const double w, const double h, const std::function< void(std::string)> &selectedCallback) const
	Adds a ComboBox to the screen. More...
void	addChat (const std::string &name, const std::string &type, const double x, const double y, const double w, const double h, const std::function< std::string(std::string)> &acceptedCallback) const
	Adds a Chat to the screen. More...
void	setText (const std::string &name, const std::string &text) const
	Set a text to an specified object. More...
void	setPosition (const std::string &name, const double x, const double y) const
	Sets the Position of an specified object. More...
void	setSize (const std::string &name, const double w, const double h) const
	Sets the Size of an specified object. More...
void	setVisibility (const std::string &windowname, const bool visibility) const
	Sets visibility of a window. More...
void	setAmount (const std::string &name, const uint32_t amount) const
	Sets the amount of items of an specified object. More...
void	setColour (const std::string &name, double alpha, double red, double green, double blue) const
	Sets the Colour of specified. More...
void	setFont (const std::string &name, const std::string &font) const
	Sets the Font of an specified object. More...
void	setLifetime (const std::string &name, const int64_t time) const
	Sets the remaining lifetime of a specified object. More...
void	setAlignment (const std::string &name, gui::Alignment alignment) const
	Set an aligment to an specified object. More...
void	enableDropTarget (const std::string &name, bool target, const std::function< bool(std::string)> &func) const
	Enables or disables Widget as drop target. More...
void	setDragable (const std::string &name, bool enabled) const
	Enables or disables Widget being dragable. More...
void	setDropCallback (const std::string &name, const std::function< void(const std::string &, const std::string &)> &callback) const
	Sets callback being called when the dragable widget is dropped. More...
void	setProgress (const std::string &name, const double progress) const
	Sets the Progress of a bar. More...
void	addRowToList (const std::string &name) const
	Adding a Row to a List. More...
void	addRowEntry (const std::string &name, const uint32_t row, const uint32_t column, const std::string &entry) const
	quite self-explanatory. See addRowToList. More...
void	addColumn (const std::string &name, const std::string &columnHeader, uint32_t column, double width) const
	Adding a column to a List. More...
void	clearWidget (const std::string &name) const
	Clears all data in a Widget. More...
void	setImage (const std::string &name, const std::string &imageSetName, const std::string &imageSet) const
	Sets the Image. More...
void	setEnterTextCallback (const std::string &name, const std::function< void(std::string)> &enterCallback) const
	Sets a enter callback to an Editbox. More...
void	setProperty (const std::string &name, const std::string &prop, const std::string &value) const
	Sets a widgets property. More...
void	setSelected (const std::string &name, bool selected) const
	Sets a selection state of widget. More...
void	setSelectedCallback (const std::string &name, const std::function< void(bool)> &selectedCallback) const
	Sets a selected callback to a ToggleButton. More...
void	setAcceptedTextCallback (const std::string &name, const std::function< std::string(std::string)> &acceptedCallback) const
	Sets a accepted callback to a chat. More...
void	setTooltip (const std::string &name, const std::string &tooltip) const
	sets tooltip for a widget More...
void	addTextToWidget (const std::string &name, const std::string &text) const
	Adds a text to a widget. The specific behavior depends on the widget. More...
void	setSelectedStringCallback (const std::string &name, const std::function< void(std::string)> &selectedCallback) const
	Sets a selected callback to a ComboBox/Listbox. More...
void	playAnimation (const std::string &name, const std::string &animation) const
	plays given animation More...
void	stopAnimation (const std::string &name, const std::string &animation) const
	stops given animation, is deleted More...
void	pauseAnimation (const std::string &name, const std::string &animation) const
	pauses given animation, to run again use unpauseAnimation More...
void	unpauseAnimation (const std::string &name, const std::string &animation) const
	unpauses an animation paused before using unpauseAnimation More...
void	setAutoLineBreak (const std::string &name, bool enabled) const
	sets automatic line break to the widget (currently only implemtend for Statuslist) More...
void	registerWidgetTemplate (const std::string &name, const boost::function< api::GUIWidget *(const std::string &name, const std::string &style)> &createFunc) const
	Registers a new Widget-template. More...
void	createWidget (const std::string &name, const std::string &type, const std::string &style) const
	Creates a new Widget. More...
void	deleteWidget (const std::string &name) const
	Deletes a specified object. More...
void	addTicker (GUIWidget *widget)
	adds a GUIWidget to be ticked More...
void	removeTicker (GUIWidget *widget)
	removes a GUIWidget from being ticked More...
void	registerAddTickerCallback (const boost::function< void(GUIWidget *)> &func)
	registers the callback for addTicker, call only by GUI subsystem More...
void	registerRemoveTickerCallback (const boost::function< void(GUIWidget *)> &func)
	registers the callback for removeTicker, call only by GUI subsystem More...
void	resetSubSystem ()
	resets the subsystem to it's defaults More...
void	setInputCaptured (bool captured)
	called only by GUI subsystem setting state whether input is captured or not call this only from within GUIManager More...
bool	getInputCaptured () const
	returns true, if the input is captured in a GUI widget More...
void	setOnWindow (bool onWindow)
	sets whether mouse in on a GUI window or not call this only from within GUIManager More...
bool	getOnWindow () const
	returns true if mouse is above a visible GUI widget element transparent GUI parts aren't recognized More...
void	setDefaultFont (const std::string &font) const
	sets default font to be used More...
void	addWidgetAsChildTo (const std::string &child, const std::string &parent) const
	adds a widget as child of another one More...

Detailed Description

This class manages the GUIWindows and provides some general API methods that aren't related to a special window.

The Application shall only use methods from this class and get them via GetSingleton() GUIFacede creates Messages of type GUIMessageType and sends them. GUIMailbox will read this Messages and calls wanted Methods from GUIManager

Definition at line 49 of file GUIFacade.h.

Constructor & Destructor Documentation

i6e::api::GUIFacade::GUIFacade

(

)

i6e::api::GUIFacade::~GUIFacade ( )

inline

Definition at line 53 of file GUIFacade.h.

Member Function Documentation

void i6e::api::GUIFacade::addChat	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const double	w,
		const double	h,
		const std::function< std::string(std::string)> &	acceptedCallback
	)		const

Adds a Chat to the screen.

Parameters

name	(Unique) Name of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the image
h	Height of the image
acceptedCallback	called when entered text is accepted

void i6e::api::GUIFacade::addColumn	(	const std::string &	name,
		const std::string &	columnHeader,
		uint32_t	column,
		double	width
	)		const

Adding a column to a List.

Parameters

name	the name of the window
columnHeader	header text of the column
column	index of the column
width	width of this column

void i6e::api::GUIFacade::addComboBox	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const double	w,
		const double	h,
		const std::function< void(std::string)> &	selectedCallback
	)		const

Adds a ComboBox to the screen.

Parameters

name	(Unique) Name of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the image
h	Height of the image
selectedCallback	called when selection in ComboBox changes

void i6e::api::GUIFacade::addEditbox	(	const std::string &	name,
		const std::string &	type,
		double	x,
		double	y,
		double	w,
		double	h,
		const std::string &	defaultText,
		const std::function< void(std::string)> &	enterCallback
	)		const

Adds a new Editbox to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the Editbox
h	Height of the Editbox
text	default text of the Editbox
enterCallback	callback to be called when text changed

void i6e::api::GUIFacade::addImage	(	const std::string &	name,
		const std::string &	type,
		const std::string &	imageSetName,
		const std::string &	imageName,
		const double	x,
		const double	y,
		const double	w,
		const double	h
	)		const

Adds a new Image to the screen.

Parameters

name	(Unique) Name of the new object.
imageSetName	imageSet
imageName	image
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the image
h	Height of the image

void i6e::api::GUIFacade::addImageButton	(	const std::string &	name,
		const std::string &	type,
		double	x,
		double	y,
		double	w,
		double	h,
		const std::string &	normalImage,
		const std::string &	hoverImage,
		const std::string &	pushedImage
	)		const

Adds a new ImageButton to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the TextButton
h	Height of the TextButton
normalImage	normal image of the button
hoverImage	image of the button when hovered
pushedImage	image of the button when pushed

void i6e::api::GUIFacade::addImageset

(

const std::string &

imageset

)

const

adds given imageset so it can be used with own graphics

void i6e::api::GUIFacade::addMultiColumnList	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const double	w,
		const double	h
	)		const

Adds a MultiColumnList to the screen.

Parameters

name	(Unique) Name of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the image
h	Height of the image

void i6e::api::GUIFacade::addPrint	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const std::string &	message,
		gui::Alignment	alignment,
		const int64_t	lifetime = -1
	)		const

Adds a new Text to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
message	Message to be printed.
lifetime	Lifetime of the object or -1 for infinite lifetime (default = -1), time in microseconds.

void i6e::api::GUIFacade::addProgressBar	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const double	w,
		const double	h
	)		const

Adds a new ProgressBar to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the Bar
h	Height of the Bar

void i6e::api::GUIFacade::addRowEntry	(	const std::string &	name,
		const uint32_t	row,
		const uint32_t	column,
		const std::string &	entry
	)		const

quite self-explanatory. See addRowToList.

void i6e::api::GUIFacade::addRowToList

(

const std::string &

name

)

const

Adding a Row to a List.

Parameters

name	the name of the window

void i6e::api::GUIFacade::addStatusList	(	const std::string &	name,
		const std::string &	type,
		const double	x,
		const double	y,
		const int64_t	lifetime
	)		const

Creates a StatusList-GuiWidget.

Parameters

CEGUI	Type i.e. "Tri6/Blanko"
position	x-coordinate
position	y-coordinate
time	before entire List hides, in microseconds

Returns

nothing

void i6e::api::GUIFacade::addTextButton	(	const std::string &	name,
		const std::string &	type,
		double	x,
		double	y,
		double	w,
		double	h,
		const std::string &	text
	)		const

Adds a new TextButton to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the TextButton
h	Height of the TextButton
text	text of the TextButton

void i6e::api::GUIFacade::addTextToWidget	(	const std::string &	name,
		const std::string &	text
	)		const

Adds a text to a widget. The specific behavior depends on the widget.

void i6e::api::GUIFacade::addTicker

(

GUIWidget *

widget

)

adds a GUIWidget to be ticked

void i6e::api::GUIFacade::addToggleButton	(	const std::string &	name,
		const std::string &	type,
		double	x,
		double	y,
		double	w,
		double	h,
		bool	selected,
		const std::function< void(bool)> &	selectedCallback
	)		const

Adds a new ToggleButton to the screen.

Parameters

name	(Unique) Name of the new object.
type	Style of the new object.
x	X-Value of the position.
y	Y-Value of the position.
w	Width of the Editbox
h	Height of the Editbox
selected	default selection of the ToggleButton
selectedCallback	callback to be called when selection changed

void i6e::api::GUIFacade::addToRootWindow

(

const std::string &

child_window

)

const

Add the child_window to the RootWindow.

The RootWindow is an invisibly full-screen window on top of your application. Adding windows to it will form your GUI-Interface Widgets are automatically added to the RootWindow, when they are created.

void i6e::api::GUIFacade::addWidgetAsChildTo	(	const std::string &	child,
		const std::string &	parent
	)		const

adds a widget as child of another one

void i6e::api::GUIFacade::changeEvent	(	const std::string &	windowname,
		bool	b
	)		const

Enable and Disable Events of Windows.

Parameters

b	true means enabled, false meands disabled

void i6e::api::GUIFacade::clearAllWindows

(

)

const

Delete all windows. Should be used when shutting down.

void i6e::api::GUIFacade::clearWidget

(

const std::string &

name

)

const

Clears all data in a Widget.

Removes for example all entries in a StatusList.

void i6e::api::GUIFacade::createWidget	(	const std::string &	name,
		const std::string &	type,
		const std::string &	style
	)		const

Creates a new Widget.

Parameters

name	Name of the Widget
type	Type of the Widget (either registered by registerWidgetTemplate, or one of the default Types)
style	Style for the Widget

void i6e::api::GUIFacade::deleteWidget

(

const std::string &

name

)

const

Deletes a specified object.

Parameters

name	Name of the object to be deleted.

void i6e::api::GUIFacade::enableDropTarget	(	const std::string &	name,
		bool	target,
		const std::function< bool(std::string)> &	func
	)		const

Enables or disables Widget as drop target.

Parameters

name	Name of the object.
target	true means Widget accepts drops

bool i6e::api::GUIFacade::getInputCaptured ( ) const

inline

returns true, if the input is captured in a GUI widget

Definition at line 520 of file GUIFacade.h.

bool i6e::api::GUIFacade::getOnWindow ( ) const

inline

returns true if mouse is above a visible GUI widget element transparent GUI parts aren't recognized

Definition at line 536 of file GUIFacade.h.

void i6e::api::GUIFacade::loadCanvas	(	const std::string &	name,
		const std::string &	file
	)		const

loads a canvas file

void i6e::api::GUIFacade::pauseAnimation	(	const std::string &	name,
		const std::string &	animation
	)		const

pauses given animation, to run again use unpauseAnimation

Parameters

name	Name of the Widget
animation	the animation to be played

void i6e::api::GUIFacade::playAnimation	(	const std::string &	name,
		const std::string &	animation
	)		const

plays given animation

Parameters

name	Name of the Widget
animation	the animation to be played

void i6e::api::GUIFacade::registerAddTickerCallback

(

const boost::function< void(GUIWidget *)> &

func

)

registers the callback for addTicker, call only by GUI subsystem

void i6e::api::GUIFacade::registerRemoveTickerCallback

(

const boost::function< void(GUIWidget *)> &

func

)

registers the callback for removeTicker, call only by GUI subsystem

void i6e::api::GUIFacade::registerWidgetTemplate	(	const std::string &	name,
		const boost::function< api::GUIWidget *(const std::string &name, const std::string &style)> &	createFunc
	)		const

Registers a new Widget-template.

Parameters

name	Name of the Widget-type
createFunc	A function to create a widget. It gets a string for the name and a string for the style. Tip: You can use boost::factory to give it a GUIWidget constructor

void i6e::api::GUIFacade::removeTicker

(

GUIWidget *

widget

)

removes a GUIWidget from being ticked

void i6e::api::GUIFacade::resetSubSystem

(

)

resets the subsystem to it's defaults

void i6e::api::GUIFacade::setAcceptedTextCallback	(	const std::string &	name,
		const std::function< std::string(std::string)> &	acceptedCallback
	)		const

Sets a accepted callback to a chat.

Parameters

name	Name of the Widget
acceptedCallback	callback to be called when entered text is accepted

void i6e::api::GUIFacade::setAlignment	(	const std::string &	name,
		gui::Alignment	alignment
	)		const

Set an aligment to an specified object.

Parameters

name	Name of the object.
alignment	the alignment of the text

void i6e::api::GUIFacade::setAmount	(	const std::string &	name,
		const uint32_t	amount
	)		const

Sets the amount of items of an specified object.

Parameters

name	Name of the object.
amount	Amount of items

void i6e::api::GUIFacade::setAutoLineBreak	(	const std::string &	name,
		bool	enabled
	)		const

sets automatic line break to the widget (currently only implemtend for Statuslist)

void i6e::api::GUIFacade::setColour	(	const std::string &	name,
		double	alpha,
		double	red,
		double	green,
		double	blue
	)		const

Sets the Colour of specified.

Parameters

name	Name of the object.
alpha	Alpha value.
red	Red value.
green	Green value.
blue	Blue value.

void i6e::api::GUIFacade::setDefaultFont

(

const std::string &

font

)

const

sets default font to be used

void i6e::api::GUIFacade::setDragable	(	const std::string &	name,
		bool	enabled
	)		const

Enables or disables Widget being dragable.

Parameters

name	Name of the object.
enabled	defines whether the Widget is dragable or not

void i6e::api::GUIFacade::setDropCallback	(	const std::string &	name,
		const std::function< void(const std::string &, const std::string &)> &	callback
	)		const

Sets callback being called when the dragable widget is dropped.

Parameters

name	Name of the object.
callback	the method to be called on drop

void i6e::api::GUIFacade::setEnterTextCallback	(	const std::string &	name,
		const std::function< void(std::string)> &	enterCallback
	)		const

Sets a enter callback to an Editbox.

Parameters

name	Name of the Widget
enterCallback	callback to be called when text changes

void i6e::api::GUIFacade::setFont	(	const std::string &	name,
		const std::string &	font
	)		const

Sets the Font of an specified object.

Parameters

name	Name of the object.
font	Font to be set.

void i6e::api::GUIFacade::setImage	(	const std::string &	name,
		const std::string &	imageSetName,
		const std::string &	imageSet
	)		const

Sets the Image.

Parameters

name	Name of the Widget
imageSetName	imageSet
imageName	image

void i6e::api::GUIFacade::setInputCaptured ( bool  captured )

inline

called only by GUI subsystem setting state whether input is captured or not call this only from within GUIManager

Definition at line 513 of file GUIFacade.h.

void i6e::api::GUIFacade::setLifetime	(	const std::string &	name,
		const int64_t	time
	)		const

Sets the remaining lifetime of a specified object.

Parameters

name	Name of the object.
time	Remaining lifetime of the Object, in microseconds

void i6e::api::GUIFacade::setMouseCursorImage

(

const std::string &

image

)

const

sets image for mouse cursor

void i6e::api::GUIFacade::setMouseVisibility

(

const bool

visibility

)

const

Sets the MouseVisibility.

Parameters

visibility

True to display the mouse, False to hide it.

void i6e::api::GUIFacade::setOnWindow ( bool  onWindow )

inline

sets whether mouse in on a GUI window or not call this only from within GUIManager

Definition at line 528 of file GUIFacade.h.

void i6e::api::GUIFacade::setPosition	(	const std::string &	name,
		const double	x,
		const double	y
	)		const

Sets the Position of an specified object.

Parameters

name	Name of the object.
x	X-Value of the position.
y	Y-Value of the position.

void i6e::api::GUIFacade::setProgress	(	const std::string &	name,
		const double	progress
	)		const

Sets the Progress of a bar.

Parameters

name	Name of the Widget
progress	Percentage to set (between 0 and 1)

void i6e::api::GUIFacade::setProperty	(	const std::string &	name,
		const std::string &	prop,
		const std::string &	value
	)		const

Sets a widgets property.

Parameters

name	Name of the Widget
prop	property to be set
value	new value of the property

void i6e::api::GUIFacade::setSelected	(	const std::string &	name,
		bool	selected
	)		const

Sets a selection state of widget.

Parameters

name	Name of the Widget
selected	true if widget is selected

void i6e::api::GUIFacade::setSelectedCallback	(	const std::string &	name,
		const std::function< void(bool)> &	selectedCallback
	)		const

Sets a selected callback to a ToggleButton.

Parameters

name	Name of the Widget
selectedCallback	callback to be called when selection changes

void i6e::api::GUIFacade::setSelectedStringCallback	(	const std::string &	name,
		const std::function< void(std::string)> &	selectedCallback
	)		const

Sets a selected callback to a ComboBox/Listbox.

Parameters

name	Name of the Widget
selectedCallback	callback to be called when selection changes

void i6e::api::GUIFacade::setSize	(	const std::string &	name,
		const double	w,
		const double	h
	)		const

Sets the Size of an specified object.

Parameters

name	Name of the object.
w	Width
h	Height

void i6e::api::GUIFacade::setText	(	const std::string &	name,
		const std::string &	text
	)		const

Set a text to an specified object.

Parameters

name	Name of the object.
text	Text to be set.

void i6e::api::GUIFacade::setTooltip	(	const std::string &	name,
		const std::string &	tooltip
	)		const

sets tooltip for a widget

Parameters

name	Name of the Widget
tooltip	the tooltip text... for multilines use ~ as delimiter

void i6e::api::GUIFacade::setVisibility	(	const std::string &	windowname,
		const bool	visibility
	)		const

Sets visibility of a window.

Parameters

windowname	name of the window
visibilty

void i6e::api::GUIFacade::startGUI	(	const std::string &	strScheme,
		const std::string &	strFont,
		const std::string &	strDefaultFont,
		const std::string &	strDefaultMouseImageSet,
		const std::string &	strDefaultMouseImageName
	)		const

Creates the GUI. This function has to be called before you can start creating windows ect.

Parameters

strScheme	The Scheme filename which should be loaded (.scheme / XML)
strFont	The default font set (can be empty)
strDefaultFont	The default font (out of the set, can be empty)
strDefaultMouseImageSet	The mouse image set
strDefaultMouseImageName	The name out of the mouseimageset

void i6e::api::GUIFacade::stopAnimation	(	const std::string &	name,
		const std::string &	animation
	)		const

stops given animation, is deleted

Parameters

name	Name of the Widget
animation	the animation to be played

void i6e::api::GUIFacade::subscribeEvent	(	const std::string &	windowname,
		const std::string &	eventType,
		const boost::function< void(void)> &	ptrEventMethod
	)		const

Subscribes for an event (Mouse-Click).

Parameters

windowname	The name of the window to be connected for an event. This can be either a manually created window or the name of a window specified in the .layout file
eventType	Type of the event. Note that the window type (e.g. PushButton) has to support this type of event. At the moment there's only one event type namely "Clicked"
ptrEventMethod	Everytime the Event occurs on this window, the Method leading to this pointer will be called

void i6e::api::GUIFacade::unpauseAnimation	(	const std::string &	name,
		const std::string &	animation
	)		const

unpauses an animation paused before using unpauseAnimation

Parameters

name	Name of the Widget
animation	the animation to be played

---

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

• GUIFacade.h