DWFToolkit::DWFXPackagePublisher Class Reference
[DWF Publisher API]

#include "dwf/publisher/impl/DWFXPackagePublisher.h"

Collaboration diagram for DWFToolkit::DWFXPackagePublisher:

Collaboration graph
[legend]
List of all members.

Detailed Description

A publisher implementation for producing DWFX package files.

Since:
7.4.0
This is a reference implementation of the DWFPublisher base class for creating DWFX packages.

Due to the composite nature of the the visitors, even this class can be used to extract additional data to other output pipes during the creation of the DWF package.

Todo:
Implement a full version for composite DWF packages.
Examples:

3DPublish/3DPublish_UTF8.cpp.

Definition at line 74 of file DWFXPackagePublisher.h.

Public Types

typedef enum DWFToolkit::DWFXPackagePublisher::teProxyGraphicsRulesType teProxyGraphicsRulesType
 These enumerations are used to specify whether proxy content, if specified, is added to the package. If eAlways is specified, proxy content will always be added. If eIfNoPageOutput is specified, proxy content will only be added if no other FixedPage content would be generated. If eIfOnlyPartialPageOutput is specified, proxy content only be added if at least one section exists which provides no FixedPage content.
enum  teProxyGraphicsRulesType
 These enumerations are used to specify whether proxy content, if specified, is added to the package. If eAlways is specified, proxy content will always be added. If eIfNoPageOutput is specified, proxy content will only be added if no other FixedPage content would be generated. If eIfOnlyPartialPageOutput is specified, proxy content only be added if at least one section exists which provides no FixedPage content.

Public Member Functions

_DWFTK_API DWFXPackagePublisher (const DWFFile &rDWFFile, const DWFString &zPassword="", const DWFString &zSourceProductVendor="", const DWFString &zSourceProductName="", const DWFString &zSourceProductVersion="", const DWFString &zPublisherProductVendor="", const DWFString &zPublisherProductVersion="", bool bNoPasswordSalting=true) throw ( DWFException )
virtual _DWFTK_API ~DWFXPackagePublisher () throw ()
virtual _DWFTK_API void addProxyGraphicsSection (DWFPlot *pProxyPlot, teProxyGraphicsRulesType eRules=eAlways, bool bAsFirstPage=true) throw ( DWFException )
virtual _DWFTK_API void addProxyPage (const DWFString &zProxyPageXPSPath) throw ( DWFException )

Protected Member Functions

virtual DWFPackageWritergetPackageWriter () throw ( DWFException )
virtual DWFGraphicResourcegetGraphicResource () throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFXPackagePublisher::DWFXPackagePublisher const DWFFile rDWFFile,
const DWFString zPassword = "",
const DWFString zSourceProductVendor = "",
const DWFString zSourceProductName = "",
const DWFString zSourceProductVersion = "",
const DWFString zPublisherProductVendor = "",
const DWFString zPublisherProductVersion = "",
bool  bNoPasswordSalting = true
throw ( DWFException )
 

Exceptions:
DWFException 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFXPackagePublisher::addProxyGraphicsSection DWFPlot pProxyPlot,
teProxyGraphicsRulesType  eRules = eAlways,
bool  bAsFirstPage = true
throw ( DWFException ) [virtual]
 

This is used to pass proxy graphics content to the package publisher for serialization. The provided section should have resources that can be serialized such that valid XPS graphics are produced.

Parameters:
pProxyPlot The plot containing the proxy content resources.
eRules Values of type teProxyGraphicsRulesType, specifying in which cases the proxy content should be used.
bAsFirstPage A boolean specifying whether the proxy graphics should be the first page (true), or the last page (false).
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXPackagePublisher::addProxyPage const DWFString zProxyPageXPSPath  )  throw ( DWFException ) [virtual]
 

This is used to add default proxy page to the package from a source proxy page XPS file. The provided proxy page XPS file should be with a full path name.

Parameters:
zProxyPageXPSPath A specified culture proxy page XPS file.
Exceptions:
DWFException 


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