A list of events. More...

#include <EventsList.h>

Public Member Functions
	EventsList (const EventsList &)

EventsList &	operator= (const EventsList &rhs)

gd::BaseEvent &	InsertEvent (const gd::BaseEvent &event, size_t position=(size_t) -1)
	Insert the specified event to the list. More...

void	InsertEvent (std::shared_ptr< gd::BaseEvent > event, size_t position=(size_t) -1)
	Insert the specified event to the list. More...

gd::BaseEvent &	InsertNewEvent (gd::Project &project, const gd::String &eventType, size_t position=(size_t) -1)
	Insert a new event to the list. More...

void	InsertEvents (const EventsList &otherEvents, size_t begin, size_t end, size_t position=(size_t) -1)
	Copy events from another list.

size_t	GetEventsCount () const
	Return the number of events.

std::shared_ptr< BaseEvent >	GetEventSmartPtr (size_t index)
	Return the smart pointer to the event at position index in the events list.

std::shared_ptr< const BaseEvent >	GetEventSmartPtr (size_t index) const
	Return the smart pointer to the event at position index in the events list.

gd::BaseEvent &	GetEvent (size_t index)
	Return a reference to the event at position index in the events list.

const gd::BaseEvent &	GetEvent (size_t index) const
	Return a reference to the event at position index in the events list.

void	RemoveEvent (const gd::BaseEvent &event)
	Remove the specified event.

void	RemoveEvent (size_t index)
	Remove the event at the specified index in the list.

bool	IsEmpty () const
	Return true if there isn't any event in the list.

void	Clear ()
	Clear the list of events.

Utilities
Utility methods
bool	Contains (const gd::BaseEvent &eventToSearch, bool recursive=true) const

bool	MoveEventToAnotherEventsList (const gd::BaseEvent &eventToMove, gd::EventsList &newEventsList, std::size_t newPosition)

std::vector API compatibility
These functions ensure that the class can be used just like a std::vector.
size_t	size () const
	Alias for GetEventsCount() More...

gd::BaseEvent &	operator[] (size_t index)
	Alias for GetEvent() More...

const gd::BaseEvent &	operator[] (size_t index) const
	Alias for GetEvent() More...

Saving and loading
Members functions related to saving and loading the events list.
void	SerializeTo (SerializerElement &element) const
	Serialize the events to the specified element. More...

void	UnserializeFrom (gd::Project &project, const SerializerElement &element)
	Load the events from the specified element. More...

Detailed Description

A list of events.

See also: BaseEvent

Member Function Documentation

◆ Contains()

bool gd::EventsList::Contains	(	const gd::BaseEvent &	eventToSearch,
		bool	recursive = `true`
	)		const

Return true if the specified event exists in the list.

Parameters

event	The event to searched for
recursive	Set it to false to prevent sub events to be inspected.

◆ InsertEvent() [1/2]

gd::BaseEvent & gd::EventsList::InsertEvent	(	const gd::BaseEvent &	event,
		size_t	position = `(size_t)-1`
	)

Insert the specified event to the list.

Note: The event passed by parameter is copied.

Parameters

event	The event that must be copied and inserted into the list
position	Insertion position. If the position is invalid, the object is inserted at the end of the objects list.

Returns: A reference to the event in the list

◆ InsertEvent() [2/2]

void gd::EventsList::InsertEvent	(	std::shared_ptr< gd::BaseEvent >	event,
		size_t	position = `(size_t)-1`
	)

Insert the specified event to the list.

Note: The event passed by parameter is not copied.

Parameters

event	The smart pointer to the event that must be inserted into the list
position	Insertion position. If the position is invalid, the object is inserted at the end of the objects list.

◆ InsertNewEvent()

gd::BaseEvent & gd::EventsList::InsertNewEvent	(	gd::Project &	project,
		const gd::String &	eventType,
		size_t	position = `(size_t)-1`
	)

Insert a new event to the list.

Note: The event is created using the project current platform.

Parameters

project	The project the events list belongs to.
eventType	The type of the event
position	Insertion position. If the position is invalid, the object is inserted at the end of the objects list.

◆ MoveEventToAnotherEventsList()

bool gd::EventsList::MoveEventToAnotherEventsList	(	const gd::BaseEvent &	eventToMove,
		gd::EventsList &	newEventsList,
		std::size_t	newPosition
	)

Move the specified event, that must be in the events list, to another events list without invalidating the event (i.e: without destroying/cloning it) in memory.

Warning: newEventsList is supposed not to be contained inside the event (you should not try to move an event inside one of its children/grand children events).

Parameters