DWFToolkit::XPSFixedDocumentSequence Interface Reference

#include "dwf/xps/FixedDocumentSequence.h"

Inheritance diagram for DWFToolkit::XPSFixedDocumentSequence:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Since:
7.4.0
The class provides the interfece for a FixedDocumentSequence as defined in the XPS specification. It manages the lifetime and logical order the order of the fixed documents that will be serialized into the associated XPSPackage.

Definition at line 55 of file xps/FixedDocumentSequence.h.

Public Member Functions

_DWFTK_API XPSFixedDocumentSequence () throw ()
virtual _DWFTK_API ~XPSFixedDocumentSequence () throw ()
virtual _DWFTK_API bool addFixedDocument (XPSFixedDocument *pFixedDocument, bool bOwn=true) throw ()
virtual _DWFTK_API bool insertFixedDocument (XPSFixedDocument *pFixedDocument, XPSFixedDocument *pAfterDocument, bool bOwn=true) throw ()
virtual _DWFTK_API bool removeFixedDocument (XPSFixedDocument *pFixedDoc) throw ()
_DWFTK_API XPSFixedDocument
*const 
fixedDocument (const DWFString &zURI) const throw ()
_DWFTK_API XPSFixedDocument::tConstIteratorfixedDocuments () const throw ()
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::XPSFixedDocumentSequence::XPSFixedDocumentSequence  )  throw ()
 

Constructor

Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API bool DWFToolkit::XPSFixedDocumentSequence::addFixedDocument XPSFixedDocument pFixedDocument,
bool  bOwn = true
throw () [virtual]
 

Add a fixed document to the sequence of documents. This will take ownership of the document unless requested.

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

_DWFTK_API XPSFixedDocument* const DWFToolkit::XPSFixedDocumentSequence::fixedDocument const DWFString zURI  )  const throw ()
 

Find the fixed document with the given URI.

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

_DWFTK_API XPSFixedDocument::tConstIterator* DWFToolkit::XPSFixedDocumentSequence::fixedDocuments  )  const throw () [inline]
 

Get an iterator over all the documents in the document sequence.

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

Definition at line 149 of file xps/FixedDocumentSequence.h.

virtual _DWFTK_API bool DWFToolkit::XPSFixedDocumentSequence::insertFixedDocument XPSFixedDocument pFixedDocument,
XPSFixedDocument pAfterDocument,
bool  bOwn = true
throw () [virtual]
 

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

Parameters:
pFixedDocument The XPS fixed document to be inserted into the sequence.
pAfterDocument The fixed document after which the new document 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::XPSFixedDocumentSequence::removeFixedDocument XPSFixedDocument pFixedDoc  )  throw () [virtual]
 

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

Parameters:
pFixedDoc The XPS fixed document to be removed from the sequence.
Returns:
True if it is found and removed, false otherwise.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::XPSFixedDocumentSequence::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