DWFToolkit::DWFXFixedPage Class Reference

Inheritance diagram for DWFToolkit::DWFXFixedPage:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 41 of file dwfx/FixedPage.h.

Public Member Functions

_DWFTK_API DWFSectionsection () const throw ()
_DWFTK_API void addGraphicResource (DWFGraphicResource *pResource) throw ( DWFException )
_DWFTK_API void removeGraphicResource (DWFGraphicResource *pResource) throw ( DWFException )
_DWFTK_API void addRasterPart (DWFXResourcePart *pPart) throw ( DWFException )
_DWFTK_API void removeRasterPart (DWFXResourcePart *pPart) throw ( DWFException )
_DWFTK_API void addRequiredResourcePart (DWFXResourcePart *pPart) throw ( DWFException )
_DWFTK_API void setThumbnailResourcePart (DWFXResourcePart *pPart) throw ( DWFException )
_DWFTK_API DWFGraphicResource::tIteratorgraphicResources () const throw ()
_DWFTK_API DWFXResourcePart::tIteratorrasterParts () const throw ()
_DWFTK_API DWFGraphicResource::tIteratorallResources () const throw ()
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ( DWFException )


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFXFixedPage::addGraphicResource DWFGraphicResource pResource  )  throw ( DWFException )
 

Add a graphics resource to the fixed page. If the resource is not compatible with a fixed page, i.e., its MIME-type is not DWFMIME::kzMIMEType_FIXEDPAGEXML, and if its role is not one of DWFXML::kzRole_Graphics2d, DWFXML::kzRole_Graphics2dOverlay or DWFXML::kzRole_Graphics2dMarkup, then it will not be added. Instead an exception will be thrown.

Parameters:
pResource The resource to add.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXFixedPage::addRasterPart DWFXResourcePart pPart  )  throw ( DWFException )
 

Add a resource part referencing a raster overlay or raster markup resource, to the fixed page. This will add an imagebrush element to the fixed page referencing the part. If the resource in the part is not compatible with a fixed page, i.e., its role is not DWFXML::kzRole_RasterOverlay or DWFXML::kzRole_RasterMarkup, and its MIME-type is not one of PNG, JPG or TIFF, then it will throw an exception.

Parameters:
pPart The part to add.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXFixedPage::addRequiredResourcePart DWFXResourcePart pPart  )  throw ( DWFException )
 

Add a required-resource relationship from the fixed page to the resource part

Parameters:
pPart The part to add.
Exceptions:
None 

_DWFTK_API DWFGraphicResource::tIterator* DWFToolkit::DWFXFixedPage::allResources  )  const throw ()
 

Get the all resources directly reference by the fixed page, namely, the 2D vector graphics, or referenced via resource parts for raster overlays and markups.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None. 

_DWFTK_API DWFGraphicResource::tIterator* DWFToolkit::DWFXFixedPage::graphicResources  )  const throw ()
 

Get the graphic resources with mime-type kzMIMEType_FIXEDPAGEXML, used to draw the 2D vector graphics.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None. 

_DWFTK_API DWFXResourcePart::tIterator* DWFToolkit::DWFXFixedPage::rasterParts  )  const throw ()
 

Get the parts with image resources used for raster overlays and raster markups.

Returns:
A pointer to an iterator that must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. This pointer may be NULL.
Exceptions:
None. 

_DWFTK_API void DWFToolkit::DWFXFixedPage::removeGraphicResource DWFGraphicResource pResource  )  throw ( DWFException )
 

Remove the provided graphicresource from the fixed page. If the resource is not referenced by the fixed page this will throw an exception. This does not delete the resource.

Parameters:
pResource The resource to remove.
Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFXFixedPage::removeRasterPart DWFXResourcePart pPart  )  throw ( DWFException )
 

Remove the provided resource part from the fixed page. If the part is not referenced by the fixed page this will throw an exception. This does not delete the part.

Parameters:
pResource The resource to remove.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXFixedPage::serializeXML DWFXMLSerializer rSerializer  )  throw ( DWFException ) [virtual]
 

Write an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
Exceptions:
DWFException 

Implements DWFToolkit::XPSFixedPage.

_DWFTK_API void DWFToolkit::DWFXFixedPage::setThumbnailResourcePart DWFXResourcePart pPart  )  throw ( DWFException )
 

Sets a resource part referencing a thumbnail for the fixed page. This will add a thumbnail relationship from the fixed page to this part.

Parameters:
pPart The part to add.
Exceptions:
None 


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