Python Script Engine  8.0
GL Studio Editor Python Script API
Method Class Reference

Public Member Functions

 Method (String name, String type, String args)
 
 Method (String name, String type, String args, String comment, String methodBody, int protection=0)
 
String GetName ()
 
void SetName (String name)
 
String GetType ()
 
void SetType (String type)
 
String GetArguments ()
 
void SetArguments (String args)
 
String GetComment ()
 
void SetComment (String comment)
 
int GetProtection ()
 
void SetProtection (int protection)
 
String GetMethodBodyStr ()
 
void SetMethodBodyStr (String methodBodyStr)
 
bool GetMethodConst ()
 
void SetMethodConst (bool isConst)
 
bool GetShouldGenerateMethodBody ()
 
void SetShouldGenerateMethodBody (bool shouldGenerate)
 
String GetUserDefinedAttributeValue (String attributeName)
 
void SetUserDefinedAttributeValue (String attributeName, String value)
 

Detailed Description

common editor interface method

Constructor & Destructor Documentation

Method::Method ( String  name,
String  type,
String  args 
)

Creates a method with the given information set.

Parameters
nameName of new method
typeReturn type of new method
argsArguments for the new method
Method::Method ( String  name,
String  type,
String  args,
String  comment,
String  methodBody,
int  protection = 0 
)

Creates a method with the given initial values set.

Parameters
nameName of new method
typeReturn type of new method
argsArguments for the new method
commentString comment regarding the method
methodBodyString to be used as the Method body
protectionInt for protection type for method: 0 = Public, 1 = Private, 2 = Protected.
Since
protection param added in GL Studio 6.0.1

Member Function Documentation

String Method::GetArguments ( )

Retrieves the method's arguments.

Returns
String containing the arguments of the method
String Method::GetComment ( )

Retrieves the comment associated with the method.

Returns
String containing the comment
String Method::GetMethodBodyStr ( )

Retrieves the method body for the method.

Returns
String containing the method body
bool Method::GetMethodConst ( )

Indicates whether or not the method is *.

Since
GL Studio 6.0.1
String Method::GetName ( )

Retrieves the method's name.

Returns
String containing the name of the method
int Method::GetProtection ( )

Retrieves the protection mode associated with the method.

Returns
Int containing the protection mode
Since
GL Studio 6.0.1
bool Method::GetShouldGenerateMethodBody ( )

Retrieves whether the method body should be generated for the method.

Returns
Bool specifying its generation state
Since
GL Studio 6.0.1
String Method::GetType ( )

Retrieves the method's return type.

Returns
String containing the return type of the method
String Method::GetUserDefinedAttributeValue ( String  attributeName)

Gets a User Defined Attribute Value associated with the method.

Parameters
attributeNameString containing the name of the attribute value to retrieve
Returns
String containing the value of the attribute
void Method::SetArguments ( String  args)

Sets the method's arguments.

Parameters
argsNew arguments for the method
void Method::SetComment ( String  comment)

Sets the comment associated with the method.

Parameters
commentString containing the comment for the method
void Method::SetMethodBodyStr ( String  methodBodyStr)

Sets the method body for the method.

Parameters
methodBodyStrString containing the method body
void Method::SetMethodConst ( bool  isConst)

Sets whether or not the method is *.

Since
GL Studio 6.0.1
void Method::SetName ( String  name)

Sets the method's name.

Parameters
nameNew name of method
void Method::SetProtection ( int  protection)

Sets the protection mode associated with the method.

Parameters
protectionInt for protection type for method: 0 = Public, 1 = Private, 2 = Protected.
Since
GL Studio 6.0.1
void Method::SetShouldGenerateMethodBody ( bool  shouldGenerate)

Sets whether the method body should be generated for the method.

Parameters
shouldGenerateBool specifying its generation state
Since
GL Studio 6.0.1
void Method::SetType ( String  type)

Sets the method's return type.

Parameters
typeNew return type for the method
void Method::SetUserDefinedAttributeValue ( String  attributeName,
String  value 
)

Sets a User Defined Attribute Value associated with the method.

Parameters
attributeNameString containing the name of the attribute value to retrieve
valueString containing the value to ba assigned to the attribute

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