DWFToolkit::DWFCustomSection Class Reference
[DWF Package API]

#include "dwf/package/CustomSection.h"

List of all members.


Detailed Description

This class can be used to extend DWF with user-defined sections and content.

Since:
7.0.1
Examples:

GlobalSectionWriter/GlobalSectionWriter.cpp.

Definition at line 44 of file CustomSection.h.

Public Types

typedef DWFWCharKeySkipList<
DWFCustomSection * > 
tMap
 This type defines a mapped collection of DWFCustomSection pointers.
typedef std::multimap< const
wchar_t *, DWFCustomSection *,
tDWFWCharCompareLess
tMultiMap
 This type defines a multi-valued mapped collection of DWFCustomSection pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFCustomSection *) tList
 This type defines a list of DWFCustomSection pointers.
_DWFTK_API DWFCustomSection (DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFCustomSection (const DWFString &zType, const DWFString &zName, const DWFString &zTitle, DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFCustomSection (const DWFString &zType, const DWFString &zTitle, const DWFString &zObjectID, double nVersion, double nPlotOrder, const DWFSource &rSource) throw ()
_DWFTK_API DWFCustomSection (const DWFCustomSection &rSection) throw ()
_DWFTK_API DWFCustomSectionoperator= (const DWFCustomSection &rSection) throw ()
virtual _DWFTK_API ~DWFCustomSection () throw ()

Classes

class  _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFCustomSection::DWFCustomSection DWFPackageReader pPackageReader  )  throw ()
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read section content data from the DWF package.

Parameters:
pPackageReader Provides access to section content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFCustomSection::DWFCustomSection const DWFString zType,
const DWFString zName,
const DWFString zTitle,
DWFPackageReader pPackageReader
throw ()
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read section content data from the DWF package.

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 Provides access to section content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFCustomSection::DWFCustomSection const DWFString zType,
const DWFString zTitle,
const DWFString zObjectID,
double  nVersion,
double  nPlotOrder,
const DWFSource rSource
throw ()
 

Constructor

This constructor is generally used by applications and publishers for creating new section objects.

Parameters:
zType The section type identifier.
zTitle The descriptive and display friendly title text.
zObjectID Uniquely identifies the section.
nVersion Identifies the version of the section type and/or descriptor.
nPlotOrder Indicates the initial position in the package to which the section was/will be published.
rSource Describes the original source of the data in the section (a drawing file, for example.)
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFCustomSection::DWFCustomSection const DWFCustomSection rSection  )  throw ()
 

Copy Constructor

Parameters:
rSection The source from which to construct this object.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFCustomSection& DWFToolkit::DWFCustomSection::operator= const DWFCustomSection rSection  )  throw ()
 

Assignment Operator

Parameters:
rSection The source from which to construct this object.
Exceptions:
None 


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