![]() |
Python Script Engine
8.3
GL Studio Editor Python Script API
|
Public Member Functions | |
Method (str name, str type, str args) | |
Method (str name, str type, str args, str comment, str methodBody, int protection=0) | |
str | GetName () |
None | SetName (str name) |
str | GetType () |
None | SetType (str type) |
str | GetArguments () |
None | SetArguments (str args) |
str | GetComment () |
None | SetComment (str comment) |
int | GetProtection () |
None | SetProtection (int protection) |
str | GetMethodBodyStr () |
None | SetMethodBodyStr (str methodBodyStr) |
bool | GetMethodConst () |
None | SetMethodConst (bool isConst) |
bool | GetShouldGenerateMethodBody () |
None | SetShouldGenerateMethodBody (bool shouldGenerate) |
str | GetUserDefinedAttributeValue (str attributeName) |
None | SetUserDefinedAttributeValue (str attributeName, str value) |
UserDefinedValueAttributeList | GetUserDefinedAttributes () |
common editor interface method
Method::Method | ( | str | name, |
str | type, | ||
str | args | ||
) |
Creates a method with the given information set.
name | Name of new method |
type | Return type of new method |
args | Arguments for the new method |
Method::Method | ( | str | name, |
str | type, | ||
str | args, | ||
str | comment, | ||
str | methodBody, | ||
int | protection = 0 |
||
) |
Creates a method with the given initial values set.
name | Name of new method |
type | Return type of new method |
args | Arguments for the new method |
comment | str comment regarding the method |
methodBody | str to be used as the Method body |
protection | Int for protection type for method: 0 = Public, 1 = Private, 2 = Protected. |
protection
param added in GL Studio 6.0.1 str Method::GetArguments | ( | ) |
Retrieves the method's arguments.
str Method::GetComment | ( | ) |
Retrieves the comment associated with the method.
str Method::GetMethodBodyStr | ( | ) |
Retrieves the method body for the method.
bool Method::GetMethodConst | ( | ) |
Indicates whether or not the method is *.
str Method::GetName | ( | ) |
Retrieves the method's name.
int Method::GetProtection | ( | ) |
Retrieves the protection mode associated with the method.
bool Method::GetShouldGenerateMethodBody | ( | ) |
Retrieves whether the method body should be generated for the method.
str Method::GetType | ( | ) |
Retrieves the method's return type.
UserDefinedValueAttributeList Method::GetUserDefinedAttributes | ( | ) |
Retrieves the user defined value attributes from the method.
str Method::GetUserDefinedAttributeValue | ( | str | attributeName | ) |
Gets a User Defined Attribute Value associated with the method.
attributeName | str containing the name of the attribute value to retrieve |
None Method::SetArguments | ( | str | args | ) |
Sets the method's arguments.
args | New arguments for the method |
None Method::SetComment | ( | str | comment | ) |
Sets the comment associated with the method.
comment | str containing the comment for the method |
None Method::SetMethodBodyStr | ( | str | methodBodyStr | ) |
Sets the method body for the method.
methodBodyStr | str containing the method body |
None Method::SetMethodConst | ( | bool | isConst | ) |
Sets whether or not the method is *.
None Method::SetName | ( | str | name | ) |
Sets the method's name.
name | New name of method |
None Method::SetProtection | ( | int | protection | ) |
Sets the protection mode associated with the method.
protection | Int for protection type for method: 0 = Public, 1 = Private, 2 = Protected. |
None Method::SetShouldGenerateMethodBody | ( | bool | shouldGenerate | ) |
Sets whether the method body should be generated for the method.
shouldGenerate | Bool specifying its generation state |
None Method::SetType | ( | str | type | ) |
Sets the method's return type.
type | New return type for the method |
None Method::SetUserDefinedAttributeValue | ( | str | attributeName, |
str | value | ||
) |
Sets a User Defined Attribute Value associated with the method.
attributeName | str containing the name of the attribute value to retrieve |
value | str containing the value to ba assigned to the attribute |