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

DWFToolkit::DWFPackageVersionTypeInfoExtension Class Reference
[DWF Package API]

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

Inheritance diagram for DWFToolkit::DWFPackageVersionTypeInfoExtension:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This is the DWF 6.01 File Format plug-in for the DWFPackageWriter.
Since:
7.0.1.

DWF 6.01 introduced the TYPEINFO file into the DWF File Format.

TYPEINFO

This file must appear immediately after the 12 byte DWF header. This file must always be named as uuid.TYPEINFO where uuid matches a section interface ID (see DWFInterface.) Actually, the section interface uuid just happened to be convenient to use for the document type (that is, the document type information, hence, type info -> TYPEINFO.) To reinforce that concept, the class defines document type strings to use at construction time; though they exactly match the section interface uuids as mentioned above.
For example, 75E513A9-6C41-4C91-BAA6-81E593FAAC10.TYPEINFO indicates that this package contains a single EModel section only. There may be custom section types but there will be no EPlot sections. All of the first 3D DWF files were of this type and had this particular file.

Definition at line 60 of file extensions/6.01/PackageVersionExtension.h.

Public Member Functions

_DWFTK_API DWFPackageVersionTypeInfoExtension (const DWFString &zDocumentType) throw ()
virtual _DWFTK_API ~DWFPackageVersionTypeInfoExtension () throw ()
_DWFTK_API unsigned short major () throw ()
_DWFTK_API unsigned short minor () throw ()
virtual _DWFTK_API bool addSection (DWFSection *pSection, DWFInterface *pInterface) throw ( DWFException )
virtual _DWFTK_API bool addGlobalSection (DWFGlobalSection *pSection) throw ( DWFException )
virtual _DWFTK_API bool write (const DWFString &zSourceProductVendor, const DWFString &zSourceProductName, const DWFString &zSourceProductVersion, const DWFString &zDWFProductVendor, const DWFString &zDWFProductVersion, DWFZipFileDescriptor::teFileMode eCompressionMode) throw ( DWFException )
virtual _DWFTK_API void prewriteManifest (DWFPackageWriter &rPackageWriter, DWFPackageFileDescriptor &rPackageDescriptor, DWFXMLSerializer &rXMLSerializer, const DWFString &zPackagePassword) throw ( DWFException )
virtual _DWFTK_API void postwriteManifest (DWFPackageWriter &rPackageWriter, DWFPackageFileDescriptor &rPackageDescriptor, DWFXMLSerializer &rXMLSerializer, const DWFString &zPackagePassword) throw ( DWFException )
virtual _DWFTK_API void postwriteSections (DWFPackageWriter &rPackageWriter, DWFPackageFileDescriptor &rPackageDescriptor, DWFXMLSerializer &rXMLSerializer, const DWFString &zPackagePassword) throw ( DWFException )

Static Public Attributes

static const wchar_t *const kzDocumentType_EPlot
static const wchar_t *const kzDocumentType_EModel


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPackageVersionTypeInfoExtension::DWFPackageVersionTypeInfoExtension const DWFString zDocumentType  )  throw ()
 

Constructor

Parameters:
zDocumentType Used to name the TYPEINFO file.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API bool DWFToolkit::DWFPackageVersionTypeInfoExtension::addGlobalSection DWFGlobalSection pSection  )  throw ( DWFException ) [virtual]
 

Adds a type global section to the DWF package.

Parameters:
pSection The global section to publish into the package. Ownership of this section pointer will be claimed automatically. This means that, left as is, the pointer will be deleted once the package is published. In order to prevent this, the caller can explicitly reclaim ownership of the section by calling DWFSection::own().
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.

virtual _DWFTK_API bool DWFToolkit::DWFPackageVersionTypeInfoExtension::addSection DWFSection pSection,
DWFInterface pInterface
throw ( DWFException ) [virtual]
 

Adds a section to the DWF package.

Parameters:
pSection The section to publish into the package. Ownership of this section pointer will be claimed automatically. This means that, left as is, the pointer will be deleted once the package is published. In order to prevent this, the caller can explicitly reclaim ownership of the section by calling DWFSection::own().
pInterface This object should be provided if pSection is a custom type that should be declared in the manifest (it will be ignored for known types.) Note that the DWF Specification dictates that at least one interface be declared in the manifest. If none exist, an exception will be thrown at write time. This pointer will be deleted with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.

_DWFTK_API unsigned short DWFToolkit::DWFPackageVersionTypeInfoExtension::major  )  throw () [inline, virtual]
 

Returns the DWF File Format major version for this extension.

Returns:
The integer value of the major format version.
Exceptions:
None 

Implements DWFToolkit::DWFPackageVersionExtension.

Definition at line 102 of file extensions/6.01/PackageVersionExtension.h.

_DWFTK_API unsigned short DWFToolkit::DWFPackageVersionTypeInfoExtension::minor  )  throw () [inline, virtual]
 

Returns the DWF File Format minor version for this extension.

Returns:
The integer value of the minor format version.
Exceptions:
None 

Implements DWFToolkit::DWFPackageVersionExtension.

Definition at line 112 of file extensions/6.01/PackageVersionExtension.h.

virtual _DWFTK_API void DWFToolkit::DWFPackageVersionTypeInfoExtension::postwriteManifest DWFPackageWriter rPackageWriter,
DWFPackageFileDescriptor rPackageDescriptor,
DWFXMLSerializer rXMLSerializer,
const DWFString zPackagePassword
throw ( DWFException ) [virtual]
 

Hook provided after the manifest.xml document is created and published.

Parameters:
rPackageWriter The object managing the creation of the DWF package file.
rPackageDescriptor The file descriptor of the DWF package file being created.
rXMLSerializer The object being used to create the XML data.
zPackagePassword If the entire package is being password protected or if this extension is adding a password protected file, this password will be used.
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.

virtual _DWFTK_API void DWFToolkit::DWFPackageVersionTypeInfoExtension::postwriteSections DWFPackageWriter rPackageWriter,
DWFPackageFileDescriptor rPackageDescriptor,
DWFXMLSerializer rXMLSerializer,
const DWFString zPackagePassword
throw ( DWFException ) [virtual]
 

Hook provided after all sections have been published.

Parameters:
rPackageWriter The object managing the creation of the DWF package file.
rPackageDescriptor The file descriptor of the DWF package file being created.
rXMLSerializer The object being used to create the XML data.
zPackagePassword If the entire package is being password protected or if this extension is adding a password protected file, this password will be used.
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.

virtual _DWFTK_API void DWFToolkit::DWFPackageVersionTypeInfoExtension::prewriteManifest DWFPackageWriter rPackageWriter,
DWFPackageFileDescriptor rPackageDescriptor,
DWFXMLSerializer rXMLSerializer,
const DWFString zPackagePassword
throw ( DWFException ) [virtual]
 

Hook provided just before the manifest.xml document is created and published.

Parameters:
rPackageWriter The object managing the creation of the DWF package file.
rPackageDescriptor The file descriptor of the DWF package file being created.
rXMLSerializer The object being used to create the XML data.
zPackagePassword If the entire package is being password protected or if this extension is adding a password protected file, this password will be used.
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.

virtual _DWFTK_API bool DWFToolkit::DWFPackageVersionTypeInfoExtension::write const DWFString zSourceProductVendor,
const DWFString zSourceProductName,
const DWFString zSourceProductVersion,
const DWFString zDWFProductVendor,
const DWFString zDWFProductVersion,
DWFZipFileDescriptor::teFileMode  eCompressionMode
throw ( DWFException ) [virtual]
 

Writes out the DWF package.

Any sections and other objects owned by the writer and/or internal manifest will be deleted at the completion of this method. Be sure to claim ownership of any such objects that are necessary to survive after this call.

This method exposes the standard DWF package properties directly. It is highly recommended that at DWF publishers set these correctly with as much detail as possible.

Setting standard DWF package properties:

                Autodesk DWF Writer is a printer driver DLL that is used to generate DWF packages
                through the Windows printing system, it is a component that another application
                would use (indirectly) to publish the DWF.  The following is an example of how
                it might populate these properties when printing from Microsoft Word:
       
                zSourceProductVendor    = L"Microsoft Corporation"          <--- from Word 2003
                zSourceProductName      = L"Microsoft Office 2003"          <--- from Word 2003
                zSourceProductVersion   = L"11.0.5604"                      <--- from Word 2003
                zDWFProductVendor       = L"Autodesk, Inc."                 <--- from DWF Writer 2
                zDWFProductVersion      = L"2.0.4.0"                        <--- from DWF Writer 2

Parameters:
zSourceProductVendor A standard property detailing the vendor of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zSourceProductName A standard property detailing the name of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zSourceProductVersion A standard property detailing the version of the software that the produced the original content and used the DWF product in order to produce the DWF package.
zDWFProductVendor A standard property that details the vendor of the software component that was used by the source product to publish the DWF package.
zDWFProductVersion A standard property that details the version of the software component that was used by the source product to publish the DWF package.
eCompressionMode An enumeration that adjusts the zip library compression options.
Exceptions:
DWFException 

Implements DWFToolkit::DWFPackageVersionExtension.


Member Data Documentation

const wchar_t* const DWFToolkit::DWFPackageVersionTypeInfoExtension::kzDocumentType_EModel [static]
 

See DWFInterface::kzEModel_ID

Definition at line 75 of file extensions/6.01/PackageVersionExtension.h.

const wchar_t* const DWFToolkit::DWFPackageVersionTypeInfoExtension::kzDocumentType_EPlot [static]
 

See DWFInterface::kzEPlot_ID

Definition at line 70 of file extensions/6.01/PackageVersionExtension.h.


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