Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFPublishableSection Class Reference
[DWF Publisher API]

#include "dwf/publisher/Publisher.h"

Inheritance diagram for DWFToolkit::DWFPublishableSection:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for sections that can be used with the DWFPublisher.
Since:
7.0.1.

Definition at line 154 of file Publisher.h.

Public Member Functions

virtual _DWFTK_API ~DWFPublishableSection ()
virtual _DWFTK_API void publish (DWFPublisher &rPublisher)=0 throw ( DWFException )
virtual _DWFTK_API void embedFont (DWFEmbeddedFont *pFont) throw ( DWFException )
virtual _DWFTK_API void addResource (DWFPublishableResource *pResource) throw ( DWFException )
virtual _DWFTK_API DWFIterator<
DWFPublishableResource * > * 
getResources () throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFPublishableSection ()


Constructor & Destructor Documentation

virtual _DWFTK_API DWFToolkit::DWFPublishableSection::~DWFPublishableSection  )  [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 165 of file Publisher.h.

_DWFTK_API DWFToolkit::DWFPublishableSection::DWFPublishableSection  )  [inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 232 of file Publisher.h.


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::addResource DWFPublishableResource pResource  )  throw ( DWFException ) [inline, virtual]
 

Request that the resource be added to the section.

Use this method for adding thumbnails, previews, etc.

Parameters:
pResource The resource to add. This object will assume ownership of pResource and will delete it with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

Reimplemented in DWFToolkit::DWFModel.

Definition at line 202 of file Publisher.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::embedFont DWFEmbeddedFont pFont  )  throw ( DWFException ) [inline, virtual]
 

Request the provided font be embedded in the section.

Parameters:
pFont The font data object to embed. This object will assume ownership of pFont and will delete it with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

Reimplemented in DWFToolkit::DWFModel.

Definition at line 185 of file Publisher.h.

virtual _DWFTK_API DWFIterator<DWFPublishableResource*>* DWFToolkit::DWFPublishableSection::getResources  )  throw ( DWFException ) [inline, virtual]
 

Returns the list of resources added to this section.

Returns:
A pointer to an iterator than will provide the resources. This pointer must be deleted by the caller with DWFCORE_FREE_OBJECT but the resource pointers themselves should not be.
Exceptions:
DWFException 

Reimplemented in DWFToolkit::DWFModel.

Definition at line 218 of file Publisher.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::publish DWFPublisher rPublisher  )  throw ( DWFException ) [pure virtual]
 

Write the section structure to rPublisher.

Parameters:
rPublisher The publisher that captures the output of the section.
Exceptions:
DWFException 

Implemented in DWFToolkit::DWFModel.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:16 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1