gd::MultipleInstructionMetadata Class Reference

A "composite" metadata that can be used to easily declare both an expression and a related condition (and a related action) without writing manually the three of them. More...

#include <MultipleInstructionMetadata.h>

Inherits gd::AbstractFunctionMetadata.

Public Member Functions
MultipleInstructionMetadata &	AddParameter (const gd::String &type, const gd::String &label, const gd::String &supplementaryInformation="", bool parameterIsOptional=false) override
MultipleInstructionMetadata &	AddCodeOnlyParameter (const gd::String &type, const gd::String &supplementaryInformation) override
MultipleInstructionMetadata &	SetDefaultValue (const gd::String &defaultValue) override
MultipleInstructionMetadata &	SetParameterExtraInfo (const gd::String &defaultValue) override
MultipleInstructionMetadata &	SetParameterLongDescription (const gd::String &longDescription) override
MultipleInstructionMetadata &	SetParameterHint (const gd::String &hint) override
MultipleInstructionMetadata &	SetHidden () override
MultipleInstructionMetadata &	SetDeprecationMessage (const gd::String &message) override
	Set the deprecation message that explains why the instruction is deprecated and what to use instead.
MultipleInstructionMetadata &	SetRequiresBaseObjectCapability (const gd::String &capability)
MultipleInstructionMetadata &	UseStandardParameters (const gd::String &type, const ParameterOptions &options)
MultipleInstructionMetadata &	SetFunctionName (const gd::String &functionName) override
	Set the function that should be called when generating the source code from events. More...
MultipleInstructionMetadata &	SetGetter (const gd::String &getter)
MultipleInstructionMetadata &	SetIncludeFile (const gd::String &includeFile) override
MultipleInstructionMetadata &	AddIncludeFile (const gd::String &includeFile) override
	Add a file to the already existing include files.
const std::vector< gd::String > &	GetIncludeFiles () const override
	Get the files that must be included to use the instruction.
MultipleInstructionMetadata &	SetPrivate () override
MultipleInstructionMetadata &	SetHelpPath (const gd::String &path)
MultipleInstructionMetadata &	MarkAsSimple ()
MultipleInstructionMetadata &	MarkAsAdvanced ()
MultipleInstructionMetadata &	MarkAsComplex ()
MultipleInstructionMetadata &	SetRelevantForLayoutEventsOnly () override
MultipleInstructionMetadata &	SetRelevantForFunctionEventsOnly () override
MultipleInstructionMetadata &	SetRelevantForAsynchronousFunctionEventsOnly () override
MultipleInstructionMetadata &	SetRelevantForCustomObjectEventsOnly () override
	MultipleInstructionMetadata ()
	Don't use, only here to fulfill Emscripten bindings requirements.

Static Public Member Functions
static MultipleInstructionMetadata	WithExpressionAndCondition (gd::ExpressionMetadata &expression, gd::InstructionMetadata &condition)
static MultipleInstructionMetadata	WithExpressionAndConditionAndAction (gd::ExpressionMetadata &expression, gd::InstructionMetadata &condition, gd::InstructionMetadata &action)
static MultipleInstructionMetadata	WithConditionAndAction (gd::InstructionMetadata &condition, gd::InstructionMetadata &action)

Detailed Description

A "composite" metadata that can be used to easily declare both an expression and a related condition (and a related action) without writing manually the three of them.

Member Function Documentation

AddCodeOnlyParameter()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::AddCodeOnlyParameter ( const gd::String &  type, const gd::String &  supplementaryInformation  )

inlineoverridevirtual

See also

gd::InstructionMetadata::AddCodeOnlyParameter

Implements gd::AbstractFunctionMetadata.

AddParameter()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::AddParameter ( const gd::String &  type, const gd::String &  label, const gd::String &  supplementaryInformation = "", bool  parameterIsOptional = false  )

inlineoverridevirtual

See also

gd::InstructionMetadata::AddParameter

Implements gd::AbstractFunctionMetadata.

MarkAsAdvanced()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::MarkAsAdvanced ( )

inline

See also

gd::InstructionMetadata::MarkAsAdvanced

MarkAsComplex()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::MarkAsComplex ( )

inline

See also

gd::InstructionMetadata::MarkAsComplex

MarkAsSimple()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::MarkAsSimple ( )

inline

See also

gd::InstructionMetadata::MarkAsSimple

SetDefaultValue()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetDefaultValue ( const gd::String &  defaultValue )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetDefaultValue

Implements gd::AbstractFunctionMetadata.

SetFunctionName()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetFunctionName ( const gd::String &  functionName )

inlineoverridevirtual

Set the function that should be called when generating the source code from events.

Parameters

functionName

the name of the function to call

Note

Shortcut for codeExtraInformation.SetFunctionName.

Implements gd::AbstractFunctionMetadata.

SetHelpPath()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetHelpPath ( const gd::String &  path )

inline

See also

gd::InstructionMetadata::SetHelpPath

SetHidden()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetHidden ( )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetHidden

Implements gd::AbstractFunctionMetadata.

SetIncludeFile()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetIncludeFile ( const gd::String &  includeFile )

inlineoverridevirtual

Deprecated:

Use AddIncludeFile instead as clearing the list is more error prone.

Implements gd::AbstractFunctionMetadata.

SetParameterExtraInfo()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetParameterExtraInfo ( const gd::String &  defaultValue )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetParameterExtraInfo

Implements gd::AbstractFunctionMetadata.

SetParameterHint()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetParameterHint ( const gd::String &  hint )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetParameterHint

Implements gd::AbstractFunctionMetadata.

SetParameterLongDescription()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetParameterLongDescription ( const gd::String &  longDescription )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetParameterLongDescription

Implements gd::AbstractFunctionMetadata.

SetPrivate()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetPrivate ( )

inlineoverridevirtual

See also

gd::InstructionMetadata::SetPrivate

Implements gd::AbstractFunctionMetadata.

SetRelevantForAsynchronousFunctionEventsOnly()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetRelevantForAsynchronousFunctionEventsOnly ( )

inlineoverridevirtual

Set that the instruction can be used in asynchronous function events.

Implements gd::AbstractFunctionMetadata.

SetRelevantForCustomObjectEventsOnly()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetRelevantForCustomObjectEventsOnly ( )

inlineoverridevirtual

Set that the instruction can be used in custom object events.

Implements gd::AbstractFunctionMetadata.

SetRelevantForFunctionEventsOnly()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetRelevantForFunctionEventsOnly ( )

inlineoverridevirtual

Set that the instruction can be used in function events.

Implements gd::AbstractFunctionMetadata.

SetRelevantForLayoutEventsOnly()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetRelevantForLayoutEventsOnly ( )

inlineoverridevirtual

Set that the instruction can be used in layouts or external events.

Implements gd::AbstractFunctionMetadata.

SetRequiresBaseObjectCapability()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::SetRequiresBaseObjectCapability ( const gd::String &  capability )

inline

See also

gd::InstructionMetadata::SetRequiresBaseObjectCapability

UseStandardParameters()

MultipleInstructionMetadata& gd::MultipleInstructionMetadata::UseStandardParameters ( const gd::String &  type, const ParameterOptions &  options  )

inline

See also

gd::InstructionMetadata::UseStandardOperatorParameters

gd::InstructionMetadata::UseStandardRelationalOperatorParameters

---

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

• MultipleInstructionMetadata.h