gd::AbstractFunctionMetadata Class Reference

Describe user-friendly information about an expression or an instruction (action or condition), its parameters and the function name as well as other information for code generation. More...

#include <AbstractFunctionMetadata.h>

Inherited by gd::ExpressionMetadata, gd::InstructionMetadata, and gd::MultipleInstructionMetadata.

Public Member Functions
virtual AbstractFunctionMetadata &	AddParameter (const gd::String &type, const gd::String &label, const gd::String &supplementaryInformation="", bool parameterIsOptional=false)=0
virtual AbstractFunctionMetadata &	AddCodeOnlyParameter (const gd::String &type, const gd::String &supplementaryInformation)=0
virtual AbstractFunctionMetadata &	SetDefaultValue (const gd::String &defaultValue)=0
virtual AbstractFunctionMetadata &	SetParameterExtraInfo (const gd::String &defaultValue)=0
virtual AbstractFunctionMetadata &	SetParameterLongDescription (const gd::String &longDescription)=0
virtual AbstractFunctionMetadata &	SetParameterHint (const gd::String &hint)=0
virtual AbstractFunctionMetadata &	SetHidden ()=0
virtual AbstractFunctionMetadata &	SetDeprecationMessage (const gd::String &message)=0
	Set the deprecation message that explains why the function is deprecated and what to use instead.
virtual AbstractFunctionMetadata &	SetPrivate ()=0
virtual AbstractFunctionMetadata &	SetRelevantForLayoutEventsOnly ()=0
virtual AbstractFunctionMetadata &	SetRelevantForFunctionEventsOnly ()=0
virtual AbstractFunctionMetadata &	SetRelevantForAsynchronousFunctionEventsOnly ()=0
virtual AbstractFunctionMetadata &	SetRelevantForCustomObjectEventsOnly ()=0
virtual AbstractFunctionMetadata &	SetFunctionName (const gd::String &functionName)=0
	Set the function that should be called when generating the source code from events. More...
virtual AbstractFunctionMetadata &	SetIncludeFile (const gd::String &includeFile)=0
	Erase any existing include file and add the specified include. More...
virtual AbstractFunctionMetadata &	AddIncludeFile (const gd::String &includeFile)=0
	Add a file to the already existing include files.
virtual const std::vector< gd::String > &	GetIncludeFiles () const =0
	Get the files that must be included to use the instruction.

Detailed Description

Describe user-friendly information about an expression or an instruction (action or condition), its parameters and the function name as well as other information for code generation.

Member Function Documentation

AddCodeOnlyParameter()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::AddCodeOnlyParameter ( const gd::String &  type, const gd::String &  supplementaryInformation  )

pure virtual

See also

gd::InstructionMetadata::AddCodeOnlyParameter

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

AddParameter()

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

pure virtual

See also

gd::InstructionMetadata::AddParameter

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetDefaultValue()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetDefaultValue ( const gd::String &  defaultValue )

pure virtual

See also

gd::InstructionMetadata::SetDefaultValue

Implemented in gd::InstructionMetadata, gd::MultipleInstructionMetadata, and gd::ExpressionMetadata.

SetFunctionName()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetFunctionName ( const gd::String &  functionName )

pure virtual

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.

Implemented in gd::InstructionMetadata, gd::MultipleInstructionMetadata, and gd::ExpressionMetadata.

SetHidden()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetHidden ( )

pure virtual

See also

gd::InstructionMetadata::SetHidden

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetIncludeFile()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetIncludeFile ( const gd::String &  includeFile )

pure virtual

Erase any existing include file and add the specified include.

Deprecated:

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

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetParameterExtraInfo()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetParameterExtraInfo ( const gd::String &  defaultValue )

pure virtual

See also

gd::InstructionMetadata::SetParameterExtraInfo

Implemented in gd::InstructionMetadata, gd::ExpressionMetadata, and gd::MultipleInstructionMetadata.

SetParameterHint()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetParameterHint ( const gd::String &  hint )

pure virtual

See also

gd::InstructionMetadata::SetParameterHint

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetParameterLongDescription()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetParameterLongDescription ( const gd::String &  longDescription )

pure virtual

See also

gd::InstructionMetadata::SetParameterLongDescription

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetPrivate()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetPrivate ( )

pure virtual

Set that the instruction is private - it can't be used outside of the object/ behavior that it is attached too.

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetRelevantForAsynchronousFunctionEventsOnly()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetRelevantForAsynchronousFunctionEventsOnly ( )

pure virtual

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

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetRelevantForCustomObjectEventsOnly()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetRelevantForCustomObjectEventsOnly ( )

pure virtual

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

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetRelevantForFunctionEventsOnly()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetRelevantForFunctionEventsOnly ( )

pure virtual

Set that the instruction can be used in function events.

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

SetRelevantForLayoutEventsOnly()

virtual AbstractFunctionMetadata& gd::AbstractFunctionMetadata::SetRelevantForLayoutEventsOnly ( )

pure virtual

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

Implemented in gd::MultipleInstructionMetadata, gd::InstructionMetadata, and gd::ExpressionMetadata.

---

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

• AbstractFunctionMetadata.h