UserDefinedAttribute Class Reference

Public Types
enum	AttribAvailableType_e {   UNUSED_AVAILABILTY ,   OPTIONAL_AVAILABILTY ,   MANDATORY_AVAILABILTY ,   AVAILABLE_AVAILABILTY }

Public Member Functions
	UserDefinedAttribute (str name, AttribAvailableType_e methodAvail=UNUSED_AVAILABILTY, AttribAvailableType_e objAvail=UNUSED_AVAILABILTY, AttribAvailableType_e propAvail=UNUSED_AVAILABILTY)
str	GetGuid ()
str	GetName ()
None	SetName (str name)
AttribAvailableType_e	GetMethodAvailability ()
None	SetMethodAvailability (AttribAvailableType_e avail)
AttribAvailableType_e	GetObjectAvailability ()
None	SetObjectAvailability (AttribAvailableType_e avail)
AttribAvailableType_e	GetPropertyAvailability ()
None	SetPropertyAvailability (AttribAvailableType_e avail)

Detailed Description

common editor interface variable

Member Enumeration Documentation

AttribAvailableType_e

enum UserDefinedAttribute::AttribAvailableType_e

Enumerator
UNUSED_AVAILABILTY	Attribute is unavailable.
OPTIONAL_AVAILABILTY	Attribute is optional.
MANDATORY_AVAILABILTY	Attribute is mandatory.
AVAILABLE_AVAILABILTY	Attribute is available.

Constructor & Destructor Documentation

UserDefinedAttribute()

UserDefinedAttribute::UserDefinedAttribute	(	str	name,
		AttribAvailableType_e	methodAvail = UNUSED_AVAILABILTY,
		AttribAvailableType_e	objAvail = UNUSED_AVAILABILTY,
		AttribAvailableType_e	propAvail = UNUSED_AVAILABILTY
	)

Creates a User Defined Attribute with the given information set.

Parameters

name	Name of new user defined attribute
methodAvail	availablity of the attribute within methods
objAvail	availablity of the attribute within objects
propAvail	availablity of the attribute within properties

Member Function Documentation

GetGuid()

str UserDefinedAttribute::GetGuid

(

)

Retrieves the attribute's guid.

Returns

str containing the guid of the attribute

GetMethodAvailability()

AttribAvailableType_e UserDefinedAttribute::GetMethodAvailability

(

)

Retrieves the attribute's method availability.

Returns

AttribAvailableType_e containing the availability of the attribute within methods

GetName()

str UserDefinedAttribute::GetName

(

)

Retrieves the attribute's name.

Returns

str containing the name of the attribute

GetObjectAvailability()

AttribAvailableType_e UserDefinedAttribute::GetObjectAvailability

(

)

Retrieves the attribute's object availability.

Returns

AttribAvailableType_e containing the availability of the attribute within objects

GetPropertyAvailability()

AttribAvailableType_e UserDefinedAttribute::GetPropertyAvailability

(

)

Retrieves the attribute's method availability.

Returns

AttribAvailableType_e containing the name of the attribute within properties

SetMethodAvailability()

None UserDefinedAttribute::SetMethodAvailability

(

AttribAvailableType_e

avail

)

Sets the attribute's method availability.

Parameters

avail

New availability of the attribute within methods

SetName()

None UserDefinedAttribute::SetName

(

str

name

)

Sets the attribute's name.

Parameters

name	New name of attribute

SetObjectAvailability()

None UserDefinedAttribute::SetObjectAvailability

(

AttribAvailableType_e

avail

)

Sets the attribute's method availability.

Parameters

avail

New availability of the attribute within objects

SetPropertyAvailability()

None UserDefinedAttribute::SetPropertyAvailability

(

AttribAvailableType_e

avail

)

Sets the attribute's method availability.

Parameters

avail

New availability of the attribute within properties

---

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

• UserDefinedAttribute.i