DWFToolkit::DWF6PackageWriter Class Reference
[DWF Package API]

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

Collaboration diagram for DWFToolkit::DWF6PackageWriter:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to publish DWF6 package files.

Since:
7.4.0
Todo:
Add direct publishing to DWFOutputStream in addition to DWFFile respresentation.
Examples:

Aggregate/Aggregate.cpp, GlobalSectionWriter/GlobalSectionWriter.cpp, SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

Definition at line 54 of file DWF6PackageWriter.h.

Public Member Functions

_DWFTK_API DWF6PackageWriter (const DWFFile &rDWFPackageFile, const DWFString &zDWFPackagePassword=L"", DWF6PackageVersionExtension *pVersionExtension=NULL, bool bNoPasswordSalting=true) throw ()
virtual _DWFTK_API ~DWF6PackageWriter () throw ()
virtual _DWFTK_API void addSection (DWFSection *pSection, DWFInterface *pInterface=NULL) throw ( DWFException )
virtual _DWFTK_API void addGlobalSection (DWFGlobalSection *pSection) throw ( DWFException )
virtual _DWFTK_API void addSignatureRequest (DWFSignatureRequest *pSignatureRequest) throw ( DWFException )
virtual _DWFTK_API void setCoreProperties (DWFPropertySet *pSet) throw ( DWFException )
virtual _DWFTK_API void setDWFProperties (DWFPropertySet *pSet) throw ( DWFException )
virtual _DWFTK_API void setCustomProperties (DWFPropertySet *pSet) throw ( DWFException )

Public Attributes

 L
const DWFStringzSourceProductName = L""
const DWFString const DWFStringzSourceProductVersion = L""
const DWFString const DWFString
const DWFString
zDWFProductVendor = L""
const DWFString const DWFString
const DWFString const DWFString
zDWFProductVersion = L""
const DWFString const DWFString
const DWFString const DWFString
DWFZipFileDescriptor::teFileMode 
eCompressionMode

Classes

class  DWF6UndeclaredResourceReceiver


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWF6PackageWriter::DWF6PackageWriter const DWFFile rDWFPackageFile,
const DWFString zDWFPackagePassword = L"",
DWF6PackageVersionExtension pVersionExtension = NULL,
bool  bNoPasswordSalting = true
throw ()
 

Constructor

Parameters:
rDWFPackageFile Identifies the DWF file to publish.
zDWFPackagePassword An optional password for protecting the DWF package file.
pVersionExtension An optional plug-in for publishing package versions different from the curent one.
bNoPasswordSalting If false, the provided password will be salted to prevent password recovery.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::addGlobalSection DWFGlobalSection pSection  )  throw ( DWFException ) [virtual]
 

Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp.

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::addSection DWFSection pSection,
DWFInterface pInterface = NULL
throw ( DWFException ) [virtual]
 

Examples:
GlobalSectionWriter/GlobalSectionWriter.cpp, SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::addSignatureRequest DWFSignatureRequest pSignatureRequest  )  throw ( DWFException ) [virtual]
 

Adds a request that a signature be generated when the DWF package is created. This pointer will be deleted with the DWFCORE_FREE_OBJECT macro.

Parameters:
pSignatureRequest A class describing the signature that is being requested.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::setCoreProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This is used to pass properties, conforming to the OPC-defined CoreProperties specification, to the package writer for serialization. For DWF files the properties get serialized into the manifest with the category set to the core properties schema ID. The provided property set must have the core properties schema ID. Any properties that that do not conform to the schema will be ignored.

Parameters:
pSet The property set containing the properties. The property set must have it's schema ID set to OPCXML::kzSchemaID_CoreProperties.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::setCustomProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This can be used to serialize all document level custom properties provided by the publisher. This is is serilized into the manifest. The provided property set should not contain nested any subsets since these will be ignored during serialization.

Parameters:
pSet The property set containing the properties.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWF6PackageWriter::setDWFProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This is used to pass properties, conforming to the DWF properties specification, to the package writer for serialization. For DWF files the properties get serialized into the manifest with the DWF properties schema ID. The provided property set must have the DWFProperties schema ID. Any properties that that do not conform to the schema will be ignored.

Parameters:
pSet The property set containing the properties. The property set must have it's schema ID set to DWFXXML::kzSchemaID_DWFProperties.
Exceptions:
DWFException 


Member Data Documentation

DWFToolkit::DWF6PackageWriter::L
 

(const DWFString& zSourceProductVendor = /*NOXLATE

Definition at line 183 of file DWF6PackageWriter.h.


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