DWFCore::DWFXMLSerializableBase Class Reference

#include "dwfcore/XML.h"

Collaboration diagram for DWFCore::DWFXMLSerializableBase:

Collaboration graph
[legend]
List of all members.

Detailed Description

This interface is used to indicate those classes that can be written as XML into a stream.

Since:
7.4

Definition at line 406 of file XML.h.

Public Member Functions

virtual _DWFCORE_API ~DWFXMLSerializableBase () throw ()
virtual _DWFCORE_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags)=0 throw ( DWFException )
virtual _DWFCORE_API DWFString namespaceXML (unsigned int nFlags) const =0 throw ()
virtual _DWFCORE_API void setDefaultNamespace (const DWFString &zDefaultNamespace) throw ( DWFException )
virtual _DWFCORE_API const
DWFXMLNamespaceBase
addNamespace (const DWFString &, const DWFString &) throw ( DWFException )

Protected Member Functions

_DWFCORE_API DWFXMLSerializableBase (const DWFString &zDefaultNamespace=L"") throw ()

Protected Attributes

DWFString _zDefaultNamespace


Constructor & Destructor Documentation

virtual _DWFCORE_API DWFCore::DWFXMLSerializableBase::~DWFXMLSerializableBase  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 417 of file XML.h.

_DWFCORE_API DWFCore::DWFXMLSerializableBase::DWFXMLSerializableBase const DWFString zDefaultNamespace = L""  )  throw () [protected]
 

Constructor

Parameters:
zDefaultNamespace An optional string that can be used as the namespace prefix when none has been explicitly defined; DWFXML::kzNamespace_DWF is used by default.
Exceptions:
None 


Member Function Documentation

virtual _DWFCORE_API const DWFXMLNamespaceBase& DWFCore::DWFXMLSerializableBase::addNamespace const DWFString ,
const DWFString
throw ( DWFException ) [inline, virtual]
 

May be used to add a namespace to a DWF XML document in order to extend/add elements and/or attributes.

Note:
The default implementation of this method will throw a DWFNotImplementedException. This method is only supported by some of the DWF XML document classes.
Parameters:
zNamespace The namespace (prefix) excluding the colon (:). This parameter is required and may not be any of the known DWF namespaces.
zXMLNS The namespace URI with version. This parameter is required.
Returns:
A reference to the namespace object. This must be used in order to extend any known element.
Exceptions:
DWFException 

Definition at line 476 of file XML.h.

virtual _DWFCORE_API DWFString DWFCore::DWFXMLSerializableBase::namespaceXML unsigned int  nFlags  )  const throw () [pure virtual]
 

This method can be used to determine the namespace to use during serialization.

Parameters:
nFlags These options should match those passed to serializeXML().
Exceptions:
None 

virtual _DWFCORE_API void DWFCore::DWFXMLSerializableBase::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [pure virtual]
 

Writes an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
nFlags An implementation-defined set of options for altering the serialization process of this object.

virtual _DWFCORE_API void DWFCore::DWFXMLSerializableBase::setDefaultNamespace const DWFString zDefaultNamespace  )  throw ( DWFException ) [inline, virtual]
 

Assigns an optional string that can be used as the namespace prefix when none has been explicitly defined; DWFXML::kzNamespace_DWF is used by default.

Parameters:
zDefaultNamespace The namespace prefix.
Exceptions:
DWFException 

Definition at line 452 of file XML.h.


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