|
Python Script Engine
9.0
GL Studio Editor Python Script API
|
Public Member Functions | |
| Property (str name, str type, str initVal) | |
| Property (str name, str type, str initVal, bool fillIn, bool memberVarUsed, str memberVarName, bool setMethodUsed, str setMethodName, str setMethodBodyStr, bool getMethodUsed, str getMethodName, str getMethodBodyStr, bool generateBodies, str comment, bool isSetMethodOverride=false, bool isGetMethodOverride=false) | |
| str | GetName () |
| None | SetName (str name) |
| str | GetType () |
| None | SetType (str type) |
| str | GetInitVal () |
| None | SetInitVal (str initVal) |
| bool | GetFilledIn () |
| None | SetFilledIn (bool fillIn) |
| str | GetDataRange () |
| None | SetDataRange (str dataRange) |
| bool | GetMemberVarUsed () |
| None | SetMemberVarUsed (bool memberVarUsed) |
| str | GetMemberVarName () |
| None | SetMemberVarName (str memberVarName) |
| bool | GetGetMethodUsed () |
| None | SetGetMethodUsed (bool methodUsed) |
| str | GetGetMethodName () |
| None | SetGetMethodName (str methodVarName) |
| str | GetGetMethodBodyStr () |
| None | SetGetMethodBodyStr (str methodBodyStr) |
| bool | GetSetMethodUsed () |
| None | SetSetMethodUsed (bool methodUsed) |
| str | GetSetMethodName () |
| None | SetSetMethodName (str methodVarName) |
| str | GetSetMethodBodyStr () |
| None | SetSetMethodBodyStr (str methodBodyStr) |
| bool | GetPropertyGetterMethodConst () |
| None | SetPropertyGetterMethodConst (bool isConst) |
| str | GetComment () |
| None | SetComment (str comment) |
| bool | GetIsSetMethodOverride () |
| None | SetIsSetMethodOverride (bool isSetMethodOverride) |
| bool | GetIsGetMethodOverride () |
| None | SetIsGetMethodOverride (bool isGetMethodOverride) |
| str | GetUserDefinedAttributeValue (str attributeName) |
| None | SetUserDefinedAttributeValue (str attributeName, str value) |
| UserDefinedValueAttributeList | GetUserDefinedAttributes () |
Python extension to modify code browser properties.
| Property::Property | ( | str | name, |
| str | type, | ||
| str | initVal | ||
| ) |
Creates a property with the given initial values set.
| name | Name of new property |
| type | Type of new property |
| initVal | Initial value of new property |
| Property::Property | ( | str | name, |
| str | type, | ||
| str | initVal, | ||
| bool | fillIn, | ||
| bool | memberVarUsed, | ||
| str | memberVarName, | ||
| bool | setMethodUsed, | ||
| str | setMethodName, | ||
| str | setMethodBodyStr, | ||
| bool | getMethodUsed, | ||
| str | getMethodName, | ||
| str | getMethodBodyStr, | ||
| bool | generateBodies, | ||
| str | comment, | ||
| bool | isSetMethodOverride = false, |
||
| bool | isGetMethodOverride = false |
||
| ) |
Creates a property with the given initial values set.
| name | Name of new property |
| type | Type of new property |
| initVal | Initial value of new property |
| fillIn | Flag to auto-fill in property details |
| memberVarUsed | Flag to show if property is a member variable |
| memberVarName | Member variable name to use |
| setMethodUsed | Flag to show if the set method is used |
| setMethodName | Name of the set method |
| setMethodBodyStr | str containing code for the set method |
| getMethodUsed | Flag to show if the get method is used |
| getMethodName | Name of the get method |
| getMethodBodyStr | str containing code for the get method |
| generateBodies | Flag to show if method bodies are generated |
| comment | string Comment regarding the property |
| isSetMethodOverride | flag to set if the property set method overrides a base class method |
| isGetMethodOverride | flag to set if the property get method overrides a base class method |
| str Property::GetComment | ( | ) |
Retrieves the comment associated with the property.
| str Property::GetDataRange | ( | ) |
Retrieves the data range value(s)
| bool Property::GetFilledIn | ( | ) |
Retrieves the Filled-In flag.
| str Property::GetGetMethodBodyStr | ( | ) |
Retrieves the get method body for the property.
| str Property::GetGetMethodName | ( | ) |
Retrieves the get method name for the property.
| bool Property::GetGetMethodUsed | ( | ) |
Retrieves the Get Method Used flag.
| str Property::GetInitVal | ( | ) |
Retrieves the property's initial value.
| bool Property::GetIsGetMethodOverride | ( | ) |
Indicates whether or not the property's getter overrides a base class method.
| bool Property::GetIsSetMethodOverride | ( | ) |
Indicates whether or not the property's setter overrides a base class method.
| str Property::GetMemberVarName | ( | ) |
Retrieves the member variable name for the property.
| bool Property::GetMemberVarUsed | ( | ) |
Retrieves the Member Variable Used flag.
| str Property::GetName | ( | ) |
Retrieves the property's name.
| bool Property::GetPropertyGetterMethodConst | ( | ) |
Indicates whether or not the property's getter method is *.
| str Property::GetSetMethodBodyStr | ( | ) |
Retrieves the set method body for the property.
| str Property::GetSetMethodName | ( | ) |
Retrieves the set method name for the property.
| bool Property::GetSetMethodUsed | ( | ) |
Retrieves the Set Method Used flag.
| str Property::GetType | ( | ) |
Retrieves the property's type.
| UserDefinedValueAttributeList Property::GetUserDefinedAttributes | ( | ) |
Retrieves the user defined value attributes from the property.
| str Property::GetUserDefinedAttributeValue | ( | str | attributeName | ) |
Gets a User Defined Attribute Value associated with the property.
| attributeName | str containing the name of the attribute value to retrieve |
| None Property::SetComment | ( | str | comment | ) |
Sets the comment associated with the property.
| comment | str containing the comment for the property |
| None Property::SetDataRange | ( | str | dataRange | ) |
Sets the property's data range value(s)
| dataRange | New data range value(s) for the property |
| None Property::SetFilledIn | ( | bool | fillIn | ) |
Sets the property's initial value.
| fillIn | New value for the Filled-In flag for the property |
| None Property::SetGetMethodBodyStr | ( | str | methodBodyStr | ) |
Sets the get method body for the property.
| methodBodyStr | str containing the get method body for the property |
| None Property::SetGetMethodName | ( | str | methodVarName | ) |
Sets the get method name for the property.
| methodVarName | str containing the get method name for the property |
| None Property::SetGetMethodUsed | ( | bool | methodUsed | ) |
| None Property::SetInitVal | ( | str | initVal | ) |
Sets the property's initial value.
| initVal | New initial value for the property |
| None Property::SetIsGetMethodOverride | ( | bool | isGetMethodOverride | ) |
Sets whether the property's getter overrides a base class method.
| isGetMethodOverride | The new value to set the property getter's override flag to |
| None Property::SetIsSetMethodOverride | ( | bool | isSetMethodOverride | ) |
Sets whether the property's setter overrides a base class method.
| isSetMethodOverride | The new value to set the property setter's override flag to |
| None Property::SetMemberVarName | ( | str | memberVarName | ) |
Sets the member variable name for the property.
| memberVarName | The new member variable name for the property |
| None Property::SetMemberVarUsed | ( | bool | memberVarUsed | ) |
| None Property::SetName | ( | str | name | ) |
Sets the property's name.
| name | New name of property |
| None Property::SetPropertyGetterMethodConst | ( | bool | isConst | ) |
Sets whether or not the property's getter method is *.
| None Property::SetSetMethodBodyStr | ( | str | methodBodyStr | ) |
Sets the set method body for the property.
| methodBodyStr | str containing the set method body for the property |
| None Property::SetSetMethodName | ( | str | methodVarName | ) |
Sets the set method name for the property.
| methodVarName | str containing the set method name for the property |
| None Property::SetSetMethodUsed | ( | bool | methodUsed | ) |
| None Property::SetType | ( | str | type | ) |
Sets the property's type.
| type | New type for the property |
| None Property::SetUserDefinedAttributeValue | ( | str | attributeName, |
| str | value | ||
| ) |
Sets a User Defined Attribute Value associated with the property.
| attributeName | str containing the name of the attribute value to retrieve |
| value | str containing the value to ba assigned to the attribute |