gui::event Class Reference

Contains an event informations. More...

#include <gui_event.hpp>

List of all members.

Public Member Functions
	event ()
	Default constructor.
	event (const std::string &sName, bool bOncePerFrame=false)
	Constructor.
void	set_name (const std::string &sName)
	Sets this event's name.
void	set_once_per_frame (bool bOncePerFrame)
	Sets whether this event can only be fired once per frame.
void	add (const lua::var &mValue)
	Adds a parameter to this event.
const lua::var *	get (uint uiIndex) const
	Returns a parameter of this event.
uint	get_num_param () const
	Returns the number of parameter.
const std::string &	get_name () const
	Returns the name of this event.
bool	is_once_per_frame () const
	Checks if this event should only be fired once per frame.
lua::var &	operator[] (uint uiIndex)
const lua::var &	operator[] (uint uiIndex) const

---

Detailed Description

Contains an event informations.

Definition at line 11 of file gui_event.hpp.

---

Constructor & Destructor Documentation

gui::event::event

(

)

Default constructor.

Definition at line 5 of file gui_event.cpp.

gui::event::event	(	const std::string &	sName,
		bool	bOncePerFrame = false
	)			[explicit]

Constructor.

Parameters:

	sName	The name of this event
	bOncePerFrame	'true' if you allow several events of this type to be fired during the same frame

Definition at line 9 of file gui_event.cpp.

---

Member Function Documentation

void gui::event::add

(

const lua::var &

mValue

)

Adds a parameter to this event.

Parameters:

mValue

The value

Definition at line 24 of file gui_event.cpp.

const lua::var * gui::event::get

(

uint

uiIndex

)

const

Returns a parameter of this event.

Returns:

A parameter of this event

Definition at line 29 of file gui_event.cpp.

const std::string & gui::event::get_name

(

)

const

Returns the name of this event.

Returns:

The name of this event

Definition at line 39 of file gui_event.cpp.

uint gui::event::get_num_param

(

)

const

Returns the number of parameter.

Returns:

The number of parameter

Definition at line 34 of file gui_event.cpp.

bool gui::event::is_once_per_frame

(

)

const

Checks if this event should only be fired once per frame.

Returns:

'true' if this should only be fired once per frame

Definition at line 44 of file gui_event.cpp.

const lua::var & gui::event::operator[]

(

uint

uiIndex

)

const

Definition at line 54 of file gui_event.cpp.

lua::var & gui::event::operator[]

(

uint

uiIndex

)

Definition at line 49 of file gui_event.cpp.

void gui::event::set_name

(

const std::string &

sName

)

Sets this event's name.

Parameters:

sName

The name of this event

Definition at line 14 of file gui_event.cpp.

void gui::event::set_once_per_frame

(

bool

bOncePerFrame

)

Sets whether this event can only be fired once per frame.

Parameters:

bOncePerFrame

'true' if you allow several events of this type to be fired during the same frame

Definition at line 19 of file gui_event.cpp.

---

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

• D:/Programmation/Sources/lxgui/bak/lxgui/gui/include/gui_event.hpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_event.cpp