DWFToolkit::DWFXDWFDocumentSequence Class Reference

Inheritance diagram for DWFToolkit::DWFXDWFDocumentSequence:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 37 of file DWFDocumentSequence.h.

Public Member Functions

_DWFTK_API bool addDWFDocument (DWFXDWFDocument *pDWFDocument, bool bOwn=true) throw ()
_DWFTK_API bool insertDWFDocument (DWFXDWFDocument *pDWFDocument, DWFXDWFDocument *pAfterDocument, bool bOwn=true) throw ()
_DWFTK_API bool removeDWFDocument (DWFXDWFDocument *pDWFDocument) throw ()
_DWFTK_API DWFXDWFDocument::tConstIteratordwfDocuments () const throw ()
_DWFTK_API DWFOrderedVector<
DWFString >::ConstIterator * 
dwfDocumentURIs () const throw ()
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ()
virtual _DWFTK_API DWFString provideDocumentURI (const DWFString &zDocumentURI) throw ()

Static Public Attributes

static const char *const kzName
 "DWFDocumentSequence.dwfseq"


Member Function Documentation

_DWFTK_API bool DWFToolkit::DWFXDWFDocumentSequence::addDWFDocument DWFXDWFDocument pDWFDocument,
bool  bOwn = true
throw ()
 

Add a DWF document to the list of DWF documents. This will take not take ownership of the part unless requested.

Parameters:
pDWFDocument The DWF document to be added.
bOwn Take ownership of the part if true, otherwise observe it.
Returns:
True if it is added, false otherwise
Exceptions:
None 

_DWFTK_API DWFXDWFDocument::tConstIterator* DWFToolkit::DWFXDWFDocumentSequence::dwfDocuments  )  const throw () [inline]
 

Access the list of document parts via an iterator.

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

Definition at line 112 of file DWFDocumentSequence.h.

_DWFTK_API DWFOrderedVector<DWFString>::ConstIterator* DWFToolkit::DWFXDWFDocumentSequence::dwfDocumentURIs  )  const throw () [inline]
 

For internal use only.

Access the list of document URIs. This is used during when reading in the DWFDocumentSequence.

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

Definition at line 127 of file DWFDocumentSequence.h.

_DWFTK_API bool DWFToolkit::DWFXDWFDocumentSequence::insertDWFDocument DWFXDWFDocument pDWFDocument,
DWFXDWFDocument pAfterDocument,
bool  bOwn = true
throw ()
 

Insert a DWF document into the sequence of documents at a position after that of the provided one. 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:
pDWFDocument The DWF document to be inserted into the sequence.
pAfterDocument The DWF document after which the new part will be inserted.
bOwn Take ownership of the part if true, otherwise observe it.
Returns:
True if it is inserted, false otherwise.
Exceptions:
None 

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFDocumentSequence::provideDocumentURI const DWFString zDocumentURI  )  throw () [virtual]
 

Accepts URIs for documents in the document sequence.

Parameters:
zDocumentURI The document URI.
Returns:
The filtered document URI.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFXDWFDocumentSequenceReader.

_DWFTK_API bool DWFToolkit::DWFXDWFDocumentSequence::removeDWFDocument DWFXDWFDocument pDWFDocument  )  throw ()
 

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

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

virtual _DWFTK_API void DWFToolkit::DWFXDWFDocumentSequence::serializeXML DWFXMLSerializer rSerializer  )  throw () [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 class was generated from the following file:
Generated on Tue Jan 6 22:40:23 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5