Event repeated for each every child of a structure variable. More...

#include <ForEachChildVariableEvent.h>

Public Member Functions
virtual gd::ForEachChildVariableEvent *	Clone () const

virtual bool	IsExecutable () const

virtual bool	CanHaveSubEvents () const

virtual const gd::EventsList &	GetSubEvents () const

virtual gd::EventsList &	GetSubEvents ()

const gd::InstructionsList &	GetConditions () const

gd::InstructionsList &	GetConditions ()

const gd::InstructionsList &	GetActions () const

gd::InstructionsList &	GetActions ()

const gd::String &	GetIterableVariableName () const
	Get the iterable variable name attached to the event. More...

void	SetIterableVariableName (gd::String newName)
	Set the iterable variable name attached to the event. More...

const gd::String &	GetValueIteratorVariableName () const
	Get the value iterator variable attached to the event. More...

void	SetValueIteratorVariableName (gd::String newName)
	Set the value iterator variable attached to the event. More...

const gd::String &	GetKeyIteratorVariableName () const
	Get the key iterator variable attached to the event. More...

void	SetKeyIteratorVariableName (gd::String newName)
	Set the key iterator variable attached to the event. More...

virtual std::vector< const gd::InstructionsList * >	GetAllConditionsVectors () const

virtual std::vector< const gd::InstructionsList * >	GetAllActionsVectors () const

virtual std::vector< gd::InstructionsList * >	GetAllConditionsVectors ()
	Return a list of all conditions of the event. More...

virtual std::vector< gd::InstructionsList * >	GetAllActionsVectors ()
	Return a list of all actions of the event. More...

virtual std::vector< std::pair< const gd::Expression *, const gd::ParameterMetadata > >	GetAllExpressionsWithMetadata () const

virtual std::vector< std::pair< gd::Expression *, gd::ParameterMetadata > >	GetAllExpressionsWithMetadata ()
	Return a list of all expressions of the event, each with their associated metadata. More...

virtual void	SerializeTo (SerializerElement &element) const
	Serialize event.

virtual void	UnserializeFrom (gd::Project &project, const SerializerElement &element)
	Unserialize the event.

Public Member Functions inherited from gd::BaseEvent
bool	HasSubEvents () const
	Return true if the events has sub events. More...

virtual bool	CanHaveVariables () const

virtual const gd::VariablesContainer &	GetVariables () const

virtual gd::VariablesContainer &	GetVariables ()

bool	HasVariables () const
	Return true if the events has local variables. More...

virtual std::vector< gd::String >	GetAllSearchableStrings () const
	Return a list of all strings of the event. More...

virtual bool	ReplaceAllSearchableStrings (std::vector< gd::String > newSearchableString)

virtual const std::vector< gd::String > &	GetSourceFileDependencies () const
	Returns the dependencies on source files of the project. More...

virtual const gd::String &	GetAssociatedGDManagedSourceFile (gd::Project &project) const
	Returns the name of the source file associated with the event. More...

virtual gd::String	GenerateEventCode (gd::EventsCodeGenerator &codeGenerator, gd::EventsCodeGenerationContext &context)
	Generate the code event: the platform provided by codeGenerator is asked for the EventMetadata associated to the event, which is then used to generate the code event. More...

virtual void	Preprocess (gd::EventsCodeGenerator &codeGenerator, gd::EventsList &eventList, std::size_t indexOfTheEventInThisList)

void	PreprocessAsyncActions (const gd::Platform &platform)

virtual bool	MustBePreprocessed ()
	If MustBePreprocessed is redefined to return true, the gd::EventMetadata::preprocessing associated to the event will be called to preprocess the event. More...

virtual bool	AcceptVisitor (gd::EventVisitor &eventVisitor)

virtual void	AcceptVisitor (gd::ReadOnlyEventVisitor &eventVisitor) const

const gd::String &	GetType () const
	Return the event type.

void	SetType (gd::String type_)
	Change the event type.

void	SetDisabled (bool disable=true)
	Set if the event if disabled or not.

bool	IsDisabled () const
	True if event is disabled.

void	SetFolded (bool fold=true)
	Set if the event must be folded (i.e: sub events must be hidden in the events editor).

bool	IsFolded () const
	True if the event should be folded in the events editor.

Additional Inherited Members
Public Attributes inherited from gd::BaseEvent
std::weak_ptr< gd::BaseEvent >	originalEvent

signed long long	totalTimeDuringLastSession

float	percentDuringLastSession

Detailed Description

Event repeated for each every child of a structure variable.

Member Function Documentation

◆ CanHaveSubEvents()

virtual bool gd::ForEachChildVariableEvent::CanHaveSubEvents ( ) const

inlinevirtual

Derived class have to redefine this function, so as to return true, if they have sub events.

Reimplemented from gd::BaseEvent.

◆ Clone()

virtual gd::ForEachChildVariableEvent* gd::ForEachChildVariableEvent::Clone ( ) const

inlinevirtual

Must return a pointer to a copy of the event. A such method is needed as the IDE may want to store copies of some events and so need a way to do polymorphic copies.

Typical implementation example:

return new MyEventClass(*this);

Reimplemented from gd::BaseEvent.

◆ GetAllActionsVectors()

vector< gd::InstructionsList * > gd::ForEachChildVariableEvent::GetAllActionsVectors ( )

virtual

Return a list of all actions of the event.

Note: Used to preprocess or search in the actions.

Reimplemented from gd::BaseEvent.

◆ GetAllConditionsVectors()

vector< gd::InstructionsList * > gd::ForEachChildVariableEvent::GetAllConditionsVectors ( )

virtual

Return a list of all conditions of the event.

Note: Used to preprocess or search in the conditions.

Reimplemented from gd::BaseEvent.

◆ GetAllExpressionsWithMetadata()

vector< pair< gd::Expression *, gd::ParameterMetadata > > gd::ForEachChildVariableEvent::GetAllExpressionsWithMetadata ( )

virtual

Return a list of all expressions of the event, each with their associated metadata.

Note: Used to preprocess or search in the expressions of the event.

Reimplemented from gd::BaseEvent.

◆ GetIterableVariableName()

const gd::String& gd::ForEachChildVariableEvent::GetIterableVariableName ( ) const

inline

Get the iterable variable name attached to the event.

It is the structure variable that will be iterated on.

◆ GetKeyIteratorVariableName()

const gd::String& gd::ForEachChildVariableEvent::GetKeyIteratorVariableName ( ) const

inline

Get the key iterator variable attached to the event.

It is the variable that will contain the name of the iterable's child being iterated on.

◆ GetSubEvents() [1/2]

virtual gd::EventsList& gd::ForEachChildVariableEvent::GetSubEvents ( )

inlinevirtual

Return the sub events, if applicable.

Reimplemented from gd::BaseEvent.

◆ GetSubEvents() [2/2]

virtual const gd::EventsList& gd::ForEachChildVariableEvent::GetSubEvents ( ) const

inlinevirtual

Return the sub events, if applicable.

Reimplemented from gd::BaseEvent.

◆ GetValueIteratorVariableName()

const gd::String& gd::ForEachChildVariableEvent::GetValueIteratorVariableName ( ) const

inline

Get the value iterator variable attached to the event.

It is the variable that will contain the value of the iterable's child being iterated on.

◆ IsExecutable()

virtual bool gd::ForEachChildVariableEvent::IsExecutable ( ) const

inlinevirtual

Derived class have to redefine this function, so as to return true, if they are executable.

Reimplemented from gd::BaseEvent.

◆ SetIterableVariableName()

void gd::ForEachChildVariableEvent::SetIterableVariableName ( gd::String newName )

inline

Set the iterable variable name attached to the event.

It is the structure variable that will be iterated on.

◆ SetKeyIteratorVariableName()

void gd::ForEachChildVariableEvent::SetKeyIteratorVariableName ( gd::String newName )

inline

Set the key iterator variable attached to the event.

It is the variable that will contain the name of the iterable's child being iterated on.

◆ SetValueIteratorVariableName()

void gd::ForEachChildVariableEvent::SetValueIteratorVariableName ( gd::String newName )

inline

Set the value iterator variable attached to the event.

It is the variable that will contain the value of the iterable's child being iterated on.

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

ForEachChildVariableEvent.h
ForEachChildVariableEvent.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanHaveSubEvents()

◆ Clone()

◆ GetAllActionsVectors()

◆ GetAllConditionsVectors()

◆ GetAllExpressionsWithMetadata()

◆ GetIterableVariableName()

◆ GetKeyIteratorVariableName()

◆ GetSubEvents() [1/2]

◆ GetSubEvents() [2/2]

◆ GetValueIteratorVariableName()

◆ IsExecutable()

◆ SetIterableVariableName()

◆ SetKeyIteratorVariableName()

◆ SetValueIteratorVariableName()