Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFXMLSerializer Class Reference
[DWF Package API]

#include "dwf/package/writer/DWFXMLSerializer.h"

Inheritance diagram for DWFToolkit::DWFXMLSerializer:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

An object that facilitates the publishing of toolkit data objects into XML.
Since:
7.0.1.

Definition at line 54 of file DWFXMLSerializer.h.

Public Types

enum  teFlags
 Named enumerations for use during the serialization.

Public Member Functions

_DWFTK_API DWFXMLSerializer (DWFUUID &rUUID) throw ()
virtual _DWFTK_API ~DWFXMLSerializer () throw ()
_DWFTK_API void attach (DWFOutputStream &rStream) throw ( DWFException )
_DWFTK_API void detach () throw ( DWFException )
_DWFTK_API const DWFStringnextUUID (bool bSquash) throw ()
_DWFTK_API void startElement (const DWFString &zName, const DWFString &zNamespace=L"") throw ( DWFException )
_DWFTK_API void addAttribute (const DWFString &zName, const DWFString &zValue, const DWFString &zNamespace=L"") throw ( DWFException )
_DWFTK_API void addCData (const DWFString &zCData) throw ( DWFException )
_DWFTK_API void endElement () throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFXMLSerializer::DWFXMLSerializer DWFUUID rUUID  )  throw ()
 

Constructor

Parameters:
rUUID A unique identifier generator that is available to consumers of the serializer.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFXMLSerializer::addAttribute const DWFString zName,
const DWFString zValue,
const DWFString zNamespace = L""
throw ( DWFException )
 

Inserts a new attribute into an open element.

Parameters:
zName The name of the attribute.
zValue The value of the attribute.
zNamespace An optional namespace to add to the attribute.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXMLSerializer::addCData const DWFString zCData  )  throw ( DWFException )
 

Insert a block of CDATA to the XML data stream.

Parameters:
zCData The CDATA text to add.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXMLSerializer::attach DWFOutputStream rStream  )  throw ( DWFException )
 

Binds a new output stream to the serializer.

All subsequent output will be written to rStream.

Parameters:
rStream The XML destination stream.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXMLSerializer::detach  )  throw ( DWFException )
 

Unbinds an output stream from the serializer.

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXMLSerializer::endElement  )  throw ( DWFException )
 

Closes an open element in the XML data stream.

Exceptions:
DWFException 

_DWFTK_API const DWFString& DWFToolkit::DWFXMLSerializer::nextUUID bool  bSquash  )  throw ()
 

Helper utility that provides a unique but sequential UUID that can be used by client code for object IDs, etc.

Sequential IDs are preferred as the compress better resulting in smaller DWF package files.

Parameters:
bSquash If true, the 128-bit uuid will be Base64 encoded into a short form string representation, otherwise the standard form string representation will be returned. The encoding used for the short form string will be non RFC 1521 compliant as detailed in DWFString::EncodeBase64().
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFXMLSerializer::startElement const DWFString zName,
const DWFString zNamespace = L""
throw ( DWFException )
 

Opens a new element tag in the XML data stream.

Parameters:
zName The name of the element.
zNamespace An optional namespace to add to the element.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:10 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1