Property Class Reference

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)
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)
str	GetUserDefinedAttributeValue (str attributeName)
None	SetUserDefinedAttributeValue (str attributeName, str value)
UserDefinedValueAttributeList	GetUserDefinedAttributes ()

Detailed Description

Python extension to modify code browser properties.

Constructor & Destructor Documentation

Property() [1/2]

Property::Property	(	str	name,
		str	type,
		str	initVal
	)

Creates a property with the given initial values set.

Parameters

name	Name of new property
type	Type of new property
initVal	Initial value of new property

Property() [2/2]

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
	)

Creates a property with the given initial values set.

Parameters

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

Member Function Documentation

GetComment()

str Property::GetComment

(

)

Retrieves the comment associated with the property.

Returns

str containing the comment

GetDataRange()

str Property::GetDataRange

(

)

Retrieves the data range value(s)

Returns

string containing the data range of the property

GetFilledIn()

bool Property::GetFilledIn

(

)

Retrieves the Filled-In flag.

Returns

True if Filled-In flag is set, otherwise False

GetGetMethodBodyStr()

str Property::GetGetMethodBodyStr

(

)

Retrieves the get method body for the property.

Returns

str containing the method body

GetGetMethodName()

str Property::GetGetMethodName

(

)

Retrieves the get method name for the property.

Returns

str containing the method name

GetGetMethodUsed()

bool Property::GetGetMethodUsed

(

)

Retrieves the Get Method Used flag.

Returns

True if the flag is set, otherwise False

GetInitVal()

str Property::GetInitVal

(

)

Retrieves the property's initial value.

Returns

str containing the initial value of the property

GetMemberVarName()

str Property::GetMemberVarName

(

)

Retrieves the member variable name for the property.

Returns

str containing the member variable name

GetMemberVarUsed()

bool Property::GetMemberVarUsed

(

)

Retrieves the Member Variable Used flag.

Returns

True if the property is a member variable, otherwise False

GetName()

str Property::GetName

(

)

Retrieves the property's name.

Returns

str containing the name of the property

GetPropertyGetterMethodConst()

bool Property::GetPropertyGetterMethodConst

(

)

Indicates whether or not the property's getter method is *.

Since

GL Studio 6.0.1

GetSetMethodBodyStr()

str Property::GetSetMethodBodyStr

(

)

Retrieves the set method body for the property.

Returns

str containing the method body

GetSetMethodName()

str Property::GetSetMethodName

(

)

Retrieves the set method name for the property.

Returns

str containing the method name

GetSetMethodUsed()

bool Property::GetSetMethodUsed

(

)

Retrieves the Set Method Used flag.

Returns

True if the flag is set, otherwise False

GetType()

str Property::GetType

(

)

Retrieves the property's type.

Returns

str containing the type of the property

GetUserDefinedAttributes()

UserDefinedValueAttributeList Property::GetUserDefinedAttributes

(

)

Retrieves the user defined value attributes from the property.

Returns

UserDefinedValueAttributeList containing the user defined attributes

GetUserDefinedAttributeValue()

str Property::GetUserDefinedAttributeValue

(

str

attributeName

)

Gets a User Defined Attribute Value associated with the property.

Parameters

attributeName

str containing the name of the attribute value to retrieve

Returns

str containing the value of the attribute

SetComment()

None Property::SetComment

(

str

comment

)

Sets the comment associated with the property.

Parameters

comment

str containing the comment for the property

SetDataRange()

None Property::SetDataRange

(

str

dataRange

)

Sets the property's data range value(s)

Parameters

dataRange

New data range value(s) for the property

SetFilledIn()

None Property::SetFilledIn

(

bool

fillIn

)

Sets the property's initial value.

Parameters

fillIn

New value for the Filled-In flag for the property

SetGetMethodBodyStr()

None Property::SetGetMethodBodyStr

(

str

methodBodyStr

)

Sets the get method body for the property.

Parameters

methodBodyStr

str containing the get method body for the property

SetGetMethodName()

None Property::SetGetMethodName

(

str

methodVarName

)

Sets the get method name for the property.

Parameters

methodVarName

str containing the get method name for the property

SetGetMethodUsed()

None Property::SetGetMethodUsed

(

bool

methodUsed

)

Sets the Get Method Used flag for the property.

Parameters

methodUsed

The new value for the Get Method Used flag for the property

SetInitVal()

None Property::SetInitVal

(

str

initVal

)

Sets the property's initial value.

Parameters

initVal

New initial value for the property

SetMemberVarName()

None Property::SetMemberVarName

(

str

memberVarName

)

Sets the member variable name for the property.

Parameters

memberVarName

The new member variable name for the property

SetMemberVarUsed()

None Property::SetMemberVarUsed

(

bool

memberVarUsed

)

Sets the Member Variable Used flag for the property.

Parameters

memberVarUsed

New value for the Member Variable Used flag for the property

SetName()

None Property::SetName

(

str

name

)

Sets the property's name.

Parameters

name	New name of property

SetPropertyGetterMethodConst()

None Property::SetPropertyGetterMethodConst

(

bool

isConst

)

Sets whether or not the property's getter method is *.

Since

GL Studio 6.0.1

SetSetMethodBodyStr()

None Property::SetSetMethodBodyStr

(

str

methodBodyStr

)

Sets the set method body for the property.

Parameters

methodBodyStr

str containing the set method body for the property

SetSetMethodName()

None Property::SetSetMethodName

(

str

methodVarName

)

Sets the set method name for the property.

Parameters

methodVarName

str containing the set method name for the property

SetSetMethodUsed()

None Property::SetSetMethodUsed

(

bool

methodUsed

)

Sets the Set Method Used flag for the property.

Parameters

methodUsed

The new value for the Set Method Used flag for the property

SetType()

None Property::SetType

(

str

type

)

Sets the property's type.

Parameters

type	New type for the property

SetUserDefinedAttributeValue()

None Property::SetUserDefinedAttributeValue	(	str	attributeName,
		str	value
	)

Sets a User Defined Attribute Value associated with the property.

Parameters

attributeName	str containing the name of the attribute value to retrieve
value	str containing the value to ba assigned to the attribute

---

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

• Property.i