DWFToolkit::DWFPropertyReference Class Reference

Inheritance diagram for DWFToolkit::DWFPropertyReference:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFPropertyReference:

Collaboration graph
[legend]
List of all members.

Detailed Description

The DWFPropertyReference class allows definition of references to properties.

Since:
7.2
The DWFPropertyReference class allows definition of references to properties.

Definition at line 54 of file PropertyReference.h.

Public Types

typedef DWFOrderedVector<
DWFPropertyReference * > 
tList
 This type defines a list of DWFPropertyReference pointers.

Public Member Functions

_DWFTK_API DWFPropertyReference (const DWFString &zID=L"") throw ()
virtual _DWFTK_API ~DWFPropertyReference () throw ()
virtual _DWFTK_API void setID (const DWFString &zID) throw ()
virtual _DWFTK_API const DWFStringid () const throw ()
virtual _DWFTK_API void setReference (const DWFString &zName, const DWFString &zCategory=L"", const DWFString &zLabel=L"") throw ( DWFException )
virtual _DWFTK_API void setReferenceWithSetID (const DWFString &zPropertySetID, const DWFString &zName, const DWFString &zCategory=L"", const DWFString &zLabel=L"") throw ( DWFException )
virtual _DWFTK_API void setReferenceWithSchemaID (const DWFString &zPropertySchemaID, const DWFString &zName, const DWFString &zCategory=L"", const DWFString &zLabel=L"") throw ( DWFException )
virtual _DWFTK_API const DWFStringname () const throw ()
virtual _DWFTK_API const DWFStringcategory () const throw ()
virtual _DWFTK_API const DWFStringpropertySetID () const throw ()
virtual _DWFTK_API const DWFStringpropertySchemaID () const throw ()
virtual _DWFTK_API const DWFStringlabel () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPropertyReference::DWFPropertyReference const DWFString zID = L""  )  throw ()
 

Constructor

Parameters:
zID A unique string identifying this property reference. If not provided, one will be assigned.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFPropertyReference::~DWFPropertyReference  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::category  )  const throw () [inline, virtual]
 

Exceptions:
None 

Definition at line 202 of file PropertyReference.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::id  )  const throw () [inline, virtual]
 

Returns the ID for this node.

Returns:
The id for this node
Exceptions:
None 

Definition at line 108 of file PropertyReference.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::label  )  const throw () [inline, virtual]
 

Returns the label for this property reference. If this is null the property name should be used as the label.

Returns:
The label to be used for this property
Exceptions:
None 

Definition at line 248 of file PropertyReference.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::name  )  const throw () [inline, virtual]
 

Returns the name of the property being referenced

Returns:
The name of the property being referenced
Exceptions:
None 

Definition at line 187 of file PropertyReference.h.

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLBuildable.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::propertySchemaID  )  const throw () [inline, virtual]
 

Returns the identifier for the schema of the property set to which the property being referenced belongs to. This can be null to indicate the property does not belong to a set.

Returns:
The identifier for the schema of the property set to which the property being referenced belong to.
Exceptions:
None 

Definition at line 234 of file PropertyReference.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPropertyReference::propertySetID  )  const throw () [inline, virtual]
 

Returns the identifier for the property set to which the property being referenced belongs to. This can be null to indicate the property does not belong to a set.

Returns:
The identifier for the property set to which the property being referenced belong to.
Exceptions:
None 

Definition at line 218 of file PropertyReference.h.

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::setID const DWFString zID  )  throw () [inline, virtual]
 

Sets an id for this view.

Parameters:
zID A string that specifies the id.
Exceptions:
None 

Definition at line 95 of file PropertyReference.h.

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::setReference const DWFString zName,
const DWFString zCategory = L"",
const DWFString zLabel = L""
throw ( DWFException ) [virtual]
 

Parameters:
zName A string containing the name of the property
zCategory A string containing the category to which the property belongs. If the property is not grouped under any category, this can be null
zLabel The label for this property reference. This can be null. If it is null, the property name will be used as the label.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::setReferenceWithSchemaID const DWFString zPropertySchemaID,
const DWFString zName,
const DWFString zCategory = L"",
const DWFString zLabel = L""
throw ( DWFException ) [virtual]
 

Defines the reference to a property contained in a property set that's identified by its set id.

Parameters:
zPropertySchemaID A string containing the schema ID of the property set that contains this property reference. This must not be null.
zName A string containing the name of the property
zCategory A string containing the category to which the property belongs. If the property is not grouped under any category, this can be null
zLabel The label for this property reference. This can be null. If it is null, the property name will be used as the label.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPropertyReference::setReferenceWithSetID const DWFString zPropertySetID,
const DWFString zName,
const DWFString zCategory = L"",
const DWFString zLabel = L""
throw ( DWFException ) [virtual]
 

Defines the reference to a property contained in a property set that's identified by its set id.

Parameters:
zPropertySetID A string containing the set ID of the property set that contains this property reference. This must not be null.
zName A string containing the name of the property
zCategory A string containing the category to which the property belongs. If the property is not grouped under any category, this can be null
zLabel The label for this property reference. This can be null. If it is null, the property name will be used as the label.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:43 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5