DWFToolkit::DWFContentPresentationDocument Class Reference

#include "dwf/presentation/ContentPresentationDocument.h"

Inheritance diagram for DWFToolkit::DWFContentPresentationDocument:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents the content presentation document.

Since:
7.3

Definition at line 44 of file ContentPresentationDocument.h.

Public Member Functions

_DWFTK_API DWFContentPresentationDocument (DWFPackageReader *pPackageReader) throw ()
_DWFTK_API DWFContentPresentationDocument () throw ()
virtual _DWFTK_API ~DWFContentPresentationDocument () throw ()
virtual _DWFTK_API DWFContentPresentationNode::tList::IteratorgetNodes ()
virtual _DWFTK_API DWFContentPresentationNodegetNode (const DWFString &zID)
virtual _DWFTK_API DWFContentPresentationViewgetView (const DWFString &zID)
virtual _DWFTK_API double provideVersion (double nVersion) throw ()
virtual _DWFTK_API DWFContentPresentationprovidePresentation (DWFContentPresentation *pPresentation) throw ()
virtual _DWFTK_API DWFContentPresentationViewprovideView (DWFContentPresentationView *pView) throw ()
virtual _DWFTK_API DWFPropertyReferenceprovidePropertyReference (DWFPropertyReference *pPropertyReference) throw ()
virtual _DWFTK_API DWFContentPresentationNodeprovideNode (DWFContentPresentationNode *pNode) throw ()
virtual _DWFTK_API DWFContentPresentationReferenceNodeprovideReferenceNode (DWFContentPresentationReferenceNode *pReferenceNode) throw ()
virtual _DWFTK_API DWFContentPresentationModelViewNodeprovideModelViewNode (DWFContentPresentationModelViewNode *pModelViewNode) throw ()
DWFXMLSerializablegetSerializable () const throw ()

Friends

class _Serializer


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContentPresentationDocument::DWFContentPresentationDocument DWFPackageReader pPackageReader  )  throw ()
 

Constructor

This constructor is generally only used by the parsing process when the DWFPackageReader associated with (and providing read access to) the DWF package file is available. The subsequent binding makes it possible to read resource content data from the DWF package.

Parameters:
pPackageReader Provides access to resource content in the DWF package.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFContentPresentationDocument::DWFContentPresentationDocument  )  throw ()
 

Constructor

Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API DWFContentPresentationNode* DWFToolkit::DWFContentPresentationDocument::getNode const DWFString zID  )  [inline, virtual]
 

Given an ID, search for a node with that ID.

Parameters:
zID The ID of the node to search for.
Returns:
The found node, or NULL.

Definition at line 109 of file ContentPresentationDocument.h.

virtual _DWFTK_API DWFContentPresentationNode::tList::Iterator* DWFToolkit::DWFContentPresentationDocument::getNodes  )  [inline, virtual]
 

Gets an iterator to the presentations that were processed from the presentation document

Returns:
A pointer to an iterator for enumerating the presentations (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Presentations returned from the iterator are owned by this class and must not be deleted by the caller.

Definition at line 95 of file ContentPresentationDocument.h.

DWFXMLSerializable& DWFToolkit::DWFContentPresentationDocument::getSerializable  )  const throw () [inline]
 

Returns an interface with which the container can be serialized into an XML document.

Returns:
A reference to a serialization inteface.
Exceptions:
None 

Reimplemented from DWFToolkit::DWFContentPresentationContainer.

Definition at line 200 of file ContentPresentationDocument.h.

virtual _DWFTK_API DWFContentPresentationView* DWFToolkit::DWFContentPresentationDocument::getView const DWFString zID  )  [inline, virtual]
 

Given an ID, search for a view with that ID.

Parameters:
zID The ID of the view to search for.
Returns:
The found view, or NULL.

Definition at line 131 of file ContentPresentationDocument.h.

virtual _DWFTK_API DWFContentPresentationModelViewNode* DWFToolkit::DWFContentPresentationDocument::provideModelViewNode DWFContentPresentationModelViewNode pModelViewNode  )  throw () [virtual]
 

Accepts presentation model view nodes.

Parameters:
pModelViewNode The new presentation model view node. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered presentation model view node.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationNode* DWFToolkit::DWFContentPresentationDocument::provideNode DWFContentPresentationNode pNode  )  throw () [virtual]
 

Accepts presentation nodes.

Parameters:
pNode The new presentation node. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered presentation node.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentation* DWFToolkit::DWFContentPresentationDocument::providePresentation DWFContentPresentation pPresentation  )  throw () [virtual]
 

Accepts presentations.

Parameters:
pPresentation The new presentation. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered presentation.
Exceptions:
None 

virtual _DWFTK_API DWFPropertyReference* DWFToolkit::DWFContentPresentationDocument::providePropertyReference DWFPropertyReference pPropertyReference  )  throw () [virtual]
 

Accepts property references.

Parameters:
pPropertyReference The new property reference. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered property reference.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationReferenceNode* DWFToolkit::DWFContentPresentationDocument::provideReferenceNode DWFContentPresentationReferenceNode pReferenceNode  )  throw () [virtual]
 

Accepts presentation reference nodes.

Parameters:
pReferenceNode The new presentation reference node. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered presentation reference node.
Exceptions:
None 

virtual _DWFTK_API double DWFToolkit::DWFContentPresentationDocument::provideVersion double  nVersion  )  throw () [virtual]
 

Accepts the object definition document version number attribute.

Parameters:
nVersion The document version.
Returns:
The filtered document version.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationView* DWFToolkit::DWFContentPresentationDocument::provideView DWFContentPresentationView pView  )  throw () [virtual]
 

Accepts presentation views.

Parameters:
pView The new presentation view. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered presentation view.
Exceptions:
None 


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