DWFToolkit::DWFContentPresentationContainer Class Reference
[DWF Package API]

Inheritance diagram for DWFToolkit::DWFContentPresentationContainer:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

An collection utility for DWFContentPresentation objects.

Since:
7.2
This class is a content presentation owner.

Definition at line 53 of file ContentPresentationContainer.h.

Public Member Functions

_DWFTK_API DWFContentPresentationContainer () throw ()
virtual _DWFTK_API ~DWFContentPresentationContainer () throw ()
virtual _DWFTK_API void addPresentation (DWFContentPresentation *pPresentation, bool bOwnPresentation=true) throw ( DWFException )
virtual _DWFTK_API DWFContentPresentation::tList::IteratorgetPresentations () throw ()
virtual _DWFTK_API DWFContentPresentation::tList::ConstIteratorgetPresentations () const throw ()
virtual _DWFTK_API void removePresentation (DWFContentPresentation *pPresentation, bool bDeleteIfOwned) throw ( DWFException )
_DWFTK_API size_t presentationCount () const throw ()
DWFXMLSerializablegetSerializable () const throw ()
virtual _DWFTK_API void notifyOwnerChanged (DWFOwnable &rOwnable) throw ( DWFException )
virtual _DWFTK_API void notifyOwnableDeletion (DWFOwnable &rOwnable) throw ( DWFException )

Protected Types

typedef DWFStringKeySkipList<
size_t > 
IDToPostionMap

Protected Attributes

DWFContentPresentation::tList _oPresentations
 The main collection of presentations.
IDToPostionMap posMap

Friends

class _Serializer


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContentPresentationContainer::DWFContentPresentationContainer  )  throw ()
 

Constructor

Exceptions:
None 

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

Destructor

This method will delete all of the container presentations

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationContainer::addPresentation DWFContentPresentation pPresentation,
bool  bOwnPresentation = true
throw ( DWFException ) [virtual]
 

Inserts a presentation to the container.

Parameters:
pPresentation The presentation to add to the container (must not be NULL). This pointer is now owned by the container and will be released with the DWFCORE_FREE_OBJECT macro.
bOwnPresentation If true, the container will claim ownership of the presentation and delete it using the DWFCORE_FREE_OBJECT macro upon destruction of this container if it is still owned.
Exceptions:
DWFException 

virtual _DWFTK_API DWFContentPresentation::tList::ConstIterator* DWFToolkit::DWFContentPresentationContainer::getPresentations  )  const throw () [virtual]
 

Locates all presentations in the container

Returns:
A pointer to a const 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 the container and must not be deleted by the caller.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentation::tList::Iterator* DWFToolkit::DWFContentPresentationContainer::getPresentations  )  throw () [virtual]
 

Locates all presentations in the container

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 the container and must not be deleted by the caller.
Exceptions:
None 

DWFXMLSerializable& DWFToolkit::DWFContentPresentationContainer::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 in DWFToolkit::DWFContentPresentationDocument.

Definition at line 162 of file ContentPresentationContainer.h.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationContainer::notifyOwnableDeletion DWFOwnable rOwnable  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationContainer::notifyOwnerChanged DWFOwnable rOwnable  )  throw ( DWFException ) [virtual]
 

_DWFTK_API size_t DWFToolkit::DWFContentPresentationContainer::presentationCount  )  const throw () [inline]
 

Returns the number of presentations in the container.

Returns:
The presentation count.
Exceptions:
None 

Definition at line 146 of file ContentPresentationContainer.h.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationContainer::removePresentation DWFContentPresentation pPresentation,
bool  bDeleteIfOwned
throw ( DWFException ) [virtual]
 

Clears the presentation from the container.

Parameters:
pPresentation The presentation object to remove from this container.
bDeleteIfOwned If true and this container currently owns the presentation, it will be deleted; otherwise, the presentation must be tracked by the caller who must either explicitly delete it using the DWFCORE_FREE_OBJECT macro or recognize that another object has claimed ownership of it.
Exceptions:
DWFException 


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