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

DWFToolkit::DWFSectionBuilder Class Reference
[DWF Package API]

#include "dwf/package/SectionBuilder.h"

Inheritance diagram for DWFToolkit::DWFSectionBuilder:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to create new strongly typed section objects.
Since:
7.0.1.

DWF is an extensible format; and while the toolkit knows how to process those object matching the format specification, it also allows for customization. Using this class, custom section creation can be integrated into the general package reading process.

Definition at line 51 of file SectionBuilder.h.

Public Member Functions

_DWFTK_API DWFSectionBuilder () throw ()
virtual _DWFTK_API ~DWFSectionBuilder () throw ()
_DWFTK_API DWFSection::FactoryaddFactory (DWFSection::Factory *pFactory) throw ( DWFException )
_DWFTK_API DWFSection::FactoryremoveFactory (const DWFString &zType) throw ( DWFException )
_DWFTK_API DWFSectionbuildSection (const char **ppAttributeList, DWFPackageReader *pPackageReader) throw ( DWFException )
_DWFTK_API DWFSectionbuildSection (const DWFString &zType, const DWFString &zName, const DWFString &zTitle, DWFPackageReader *pPackageReader) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSectionBuilder::DWFSectionBuilder  )  throw ()
 

Constructor

Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFSection::Factory* DWFToolkit::DWFSectionBuilder::addFactory DWFSection::Factory pFactory  )  throw ( DWFException )
 

Adds a new factory to the builder.

If the factory provided is of the same type as one already in the builder, the existing factory will be replaced and returned. The factory is keyed by DWFSection::Factory::type().

Parameters:
pFactory A pointer to the new factory (must not be NULL). If this object will not be explicitly removed from the builder, it will be deleted by the builder using the DWFCORE_FREE_OBJECT macro.
Returns:
A pointer to the previous factory for the same section type (may be NULL). The caller is responsible for freeing this pointer.
Exceptions:
DWFException 

_DWFTK_API DWFSection* DWFToolkit::DWFSectionBuilder::buildSection const DWFString zType,
const DWFString zName,
const DWFString zTitle,
DWFPackageReader pPackageReader
throw ( DWFException )
 

Allocates a new section object.

The section is created using a registered section factory or the default implementation provided by DWFSection::Factory::buildSection()

Parameters:
zType The section type identifier.
zName A string that uniquely identifies the section in the DWF package.
zTitle The descriptive and display friendly title text.
pPackageReader A package reader to bind to the section from which resource content will be extracted.
Returns:
A pointer to the new section. Caller must delete this object with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

_DWFTK_API DWFSection* DWFToolkit::DWFSectionBuilder::buildSection const char **  ppAttributeList,
DWFPackageReader pPackageReader
throw ( DWFException )
 

Allocates a new section object based on the attribute data parsed from the document.

The section is created using a registered section factory or the default implementation provided by DWFSection::Factory::buildSection()

Parameters:
ppAttributeList An array of null-terminated atribute name, value string pairs. The array itself is zero-terminated.
pPackageReader A package reader to bind to the section from which resource content will be extracted.
Returns:
A pointer to the new section. Caller must delete this object with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

_DWFTK_API DWFSection::Factory* DWFToolkit::DWFSectionBuilder::removeFactory const DWFString zType  )  throw ( DWFException )
 

Returns the factory for the specified type.

Parameters:
zType Identifies the section factory.
Returns:
A pointer to the factory that was removed from this builder (may be NULL). The caller is responsible for freeing this pointer.
Exceptions:
DWFException 


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