DWFToolkit::XPSFixedDocument Interface Reference

#include "dwf/xps/FixedDocument.h"

Inheritance diagram for DWFToolkit::XPSFixedDocument:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class provides the interface to a FixedDocument as defined in the XPS specification.

Since:
7.4.0

Definition at line 50 of file xps/FixedDocument.h.

Public Types

typedef DWFOrderedVector<
XPSFixedDocument * > 
tList
 This type defines a list of XPSFixedDocument pointers.
typedef DWFStringKeySkipList<
XPSFixedDocument * > 
tMap
 This type defines a mapped collection of XPSFixedDocument pointers.
typedef DWFCachingIterator<
XPSFixedDocument * > 
tCachingIterator
 This type defines a caching iterator on a collection of XPSFixedDocument pointers. The iterator caches the pointers in its own container.
typedef DWFIterator< XPSFixedDocument * > tIterator
 This type defines a basic iterator on a collection of XPSFixedDocument pointers.
typedef DWFConstIterator<
XPSFixedDocument * > 
tConstIterator
 This type defines a basic const iterator on a collection of XPSFixedDocument pointers.

Public Member Functions

_DWFTK_API XPSFixedDocument () throw ()
virtual _DWFTK_API ~XPSFixedDocument () throw ()
virtual _DWFTK_API bool addFixedPage (XPSFixedPage *pFixedPage, bool bOwn=true) throw ()
virtual _DWFTK_API bool insertFixedPage (XPSFixedPage *pFixedPage, XPSFixedPage *pAfterPage, bool bOwn=true) throw ()
virtual _DWFTK_API bool removeFixedPage (XPSFixedPage *pFixedPage) throw ()
_DWFTK_API XPSFixedPage *const fixedPage (const DWFString &zURI) const throw ()
_DWFTK_API XPSFixedPage::tConstIteratorfixedPages () const throw ()
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::XPSFixedDocument::XPSFixedDocument  )  throw ()
 

Constructor

Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API bool DWFToolkit::XPSFixedDocument::addFixedPage XPSFixedPage pFixedPage,
bool  bOwn = true
throw () [virtual]
 

Add a fixed page to the document. This will take ownership of the page unless otherwise mentioned.

Parameters:
pFixedPage The XPS fixed oage to be added to the document.
bOwn Take ownership of the page if true, otherwise observe it.
Returns:
True if it is added, false otherwise
Exceptions:
None 

_DWFTK_API XPSFixedPage* const DWFToolkit::XPSFixedDocument::fixedPage const DWFString zURI  )  const throw ()
 

Find the fixed page with the given URI.

Parameters:
zURI The URI of the page.
Returns:
Pointer to the page, NULL if it is not found.
Exceptions:
None 

_DWFTK_API XPSFixedPage::tConstIterator* DWFToolkit::XPSFixedDocument::fixedPages  )  const throw () [inline]
 

Get an iterator over all the pages in the document.

Returns:
An iterator that must be deleted using DWFCORE_FREE_OBJECT. The iterator maybe NULL. throw None

Definition at line 169 of file xps/FixedDocument.h.

virtual _DWFTK_API bool DWFToolkit::XPSFixedDocument::insertFixedPage XPSFixedPage pFixedPage,
XPSFixedPage pAfterPage,
bool  bOwn = true
throw () [virtual]
 

Insert a fixed page into the document at a position after that of the provided page. If the pAfterPage argument is NULL, the new page will be inserted at the beginning. If the argument is not NULL, but it does not exist in the document, the new page will not be inserted, and the method will return false.

Parameters:
pFixedPage The XPS fixed page to be inserted into the document.
pAfterPage The fixed page after which the new [age will be inserted.
bOwn Take ownership of the document if true, otherwise observe it.
Returns:
True if it is inserted, false otherwise.
Exceptions:
None 

virtual _DWFTK_API bool DWFToolkit::XPSFixedDocument::removeFixedPage XPSFixedPage pFixedPage  )  throw () [virtual]
 

Remove a fixed page from the document. This does not delete the page. The caller must manage the lifetime of the removed page.

Parameters:
pFixedPage The XPS fixed page to be removed.
Returns:
True if it is found and removed, false otherwise.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::XPSFixedDocument::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::OPCXMLPart.


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