DWFToolkit::DWFXCustomProperties Class Reference

Inheritance diagram for DWFToolkit::DWFXCustomProperties:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 36 of file CustomProperties.h.

Public Member Functions

_DWFTK_API DWFXCustomProperties () throw ( DWFException )
virtual _DWFTK_API ~DWFXCustomProperties () throw ()
_DWFTK_API void addProperty (DWFProperty *pProperty, bool bOwnProperty) throw ( DWFException )
_DWFTK_API DWFPropertyaddProperty (const DWFString &zName, const DWFString &zValue, const DWFString &zCategory=L"", const DWFString &zType=L"", const DWFString &zUnits=L"") throw ( DWFException )
_DWFTK_API void removeProperty (DWFProperty *pProperty, bool bDeleteIfOwned=true) throw ( DWFException )
_DWFTK_API const DWFProperty
*const 
findProperty (const DWFString &zName, const DWFString &zCategory=L"") throw ()
_DWFTK_API DWFProperty::tMap::Iterator * getProperties (const DWFString &zCategory=L"") throw ()
_DWFTK_API DWFPropertySetgetPropertySet () throw ()
virtual _DWFTK_API DWFPropertyprovideProperty (DWFProperty *pProperty) throw ()
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ( DWFException )

Static Public Attributes

static const char *const kzName
 "CustomProperties.xml"


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFXCustomProperties::DWFXCustomProperties  )  throw ( DWFException )
 

Constructor

Exceptions:
DWFException 

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

Destructor


Member Function Documentation

_DWFTK_API DWFProperty* DWFToolkit::DWFXCustomProperties::addProperty const DWFString zName,
const DWFString zValue,
const DWFString zCategory = L"",
const DWFString zType = L"",
const DWFString zUnits = L""
throw ( DWFException )
 

Create and directly add a property to the property set owned by the class. The container will own the property.

Parameters:
zName Identifies the property within its zCategory.
zValue The data associated with the property.
zCategory An optional grouping of properties.
zType An optional type defining the data.
zUnits An optional type defining the data.
Returns:
A pointer to the created property.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXCustomProperties::addProperty DWFProperty pProperty,
bool  bOwnProperty
throw ( DWFException )
 

Inserts a property to the property set owned by this class.

Parameters:
pProperty The property to add to the container (must not be NULL).
bOwnProperty If true, the container will claim ownership of the property and delete it using the DWFCORE_FREE_OBJECT macro upon destruction of this container if it is still owned. If false a copy of the property is created.
Exceptions:
DWFException 

_DWFTK_API const DWFProperty* const DWFToolkit::DWFXCustomProperties::findProperty const DWFString zName,
const DWFString zCategory = L""
throw ()
 

Locates a property in the property set of this class.

Parameters:
zName The name of the property to look up (required.)
zCategory The category of the property to look up (optional.)
Returns:
A pointer to the property (may be NULL). This object is owned by the container by default and must not be deleted by the caller without first explicitly claiming ownership.
Exceptions:
None 

_DWFTK_API DWFProperty::tMap::Iterator* DWFToolkit::DWFXCustomProperties::getProperties const DWFString zCategory = L""  )  throw ()
 

Locates all properties in the container that share a category. If the category is empty, all properties are returned.

Parameters:
zCategory The property category to search by.
Returns:
A pointer to an iterator for enumerating the properties (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Properties returned from the iterator are owned by the container by default and must not be deleted by the caller without first explicitly claiming ownership.
Exceptions:
None 

_DWFTK_API DWFPropertySet* DWFToolkit::DWFXCustomProperties::getPropertySet  )  throw () [inline]
 

Return a PropertySet of this object's properties.

Returns:
..
Exceptions:
None 

Definition at line 153 of file CustomProperties.h.

virtual _DWFTK_API DWFProperty* DWFToolkit::DWFXCustomProperties::provideProperty DWFProperty pProperty  )  throw () [virtual]
 

Accept the property.

Parameters:
pProperty The new property.
Returns:
The filtered property.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFXCustomPropertiesReader.

_DWFTK_API void DWFToolkit::DWFXCustomProperties::removeProperty DWFProperty pProperty,
bool  bDeleteIfOwned = true
throw ( DWFException )
 

Removes a property from the class' property set

Parameters:
pProperty The property to remove from the set (must not be NULL).
bDeleteIfOwned If true, and if the container owns this property, the property will be deleted.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXCustomProperties::serializeXML DWFXMLSerializer rSerializer  )  throw ( DWFException ) [virtual]
 

Write an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
Exceptions:
DWFException 

Implements DWFToolkit::OPCXMLPart.


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