DWFToolkit::DWFPublishedDefinedObject Class Reference
[DWF Publisher API]

#include "dwf/publisher/impl/PublishedDefinedObject.h"

List of all members.


Detailed Description

This is an implementation of the DWFPublishedObject, to capture relationships between a graphics element and some published structure, in this case the DWFPublishedDefinedObject.

Since:
7.2.0

Definition at line 51 of file PublishedDefinedObject.h.

Public Types

typedef DWFPublishedObject::tKey tKey
 Defines the data type used for published element keys.
typedef DWFSkipList< DWFPublishedObject::tKey,
DWFPublishedDefinedObject * > 
tMap
 This type defines a mapped collection of DWFPublishedObject pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFPublishedDefinedObject *) tList
 This type defines a list of DWFPublishedObject pointers.
_DWFTK_API DWFPublishedDefinedObject (tKey nKey, const DWFString &zName) throw ()
virtual _DWFTK_API ~DWFPublishedDefinedObject () throw ()
virtual _DWFTK_API void addPropertyContainer (DWFPropertyContainer *pContainer) throw ( DWFException )
virtual _DWFTK_API void referencePropertyContainer (const DWFPropertyContainer &rContainer) throw ( DWFException )

Classes

class  Factory
class  Visitor


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPublishedDefinedObject::DWFPublishedDefinedObject tKey  nKey,
const DWFString zName
throw ()
 

Constructor

Parameters:
nKey Unique identifier for the object.
zName Descriptive name for the object.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFPublishedDefinedObject::addPropertyContainer DWFPropertyContainer pContainer  )  throw ( DWFException ) [virtual]
 

Inserts another property container directly into the container.

Use this method to create sets of properties within a larger property [container] context. Inner containers will be serialized as inner sets. To publish set references, use the referencePropertyContainer() method.

Parameters:
pContainer The container to add to this container (must not be NULL). This pointer will be owned by this container and deleted using the DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPublishedDefinedObject::referencePropertyContainer const DWFPropertyContainer rContainer  )  throw ( DWFException ) [virtual]
 

Inserts another property container by reference into the container.

Use this method to create references to other sets of properties within a larger property [container] context. Inner containers will be serialized as reference IDs. To publish inlined inner sets, use the addPropertyContainer() method.

Parameters:
rContainer The container to add to this container as a reference.
Exceptions:
DWFException 


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