DWFToolkit::DWFPublishableSection Interface Reference
[DWF Publisher API]

#include "dwf/publisher/PublishableSection.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 64 of file PublishableSection.h.

Public Member Functions

virtual _DWFTK_API ~DWFPublishableSection () throw ()
virtual _DWFTK_API void publish (DWFPublisher &rPublisher)=0 throw ( DWFException )
virtual _DWFTK_API void embedFont (DWFEmbeddedFont *) throw ( DWFException )
virtual _DWFTK_API void addResource (DWFPublishableResource *) throw ( DWFException )
virtual _DWFTK_API DWFIterator<
DWFPublishableResource * > * 
getResources () throw ( DWFException )
virtual _DWFTK_API const DWFStringgetType () const throw ()
virtual _DWFTK_API const DWFStringgetTitle () const throw ()
virtual _DWFTK_API double getVersion () const =0 throw ()
virtual _DWFTK_API const DWFStringgetSource () const throw ()
virtual _DWFTK_API const DWFStringgetSourceID () const throw ()
virtual _DWFTK_API const DWFStringgetSourceHRef () const throw ()
virtual _DWFTK_API void setLabel (const DWFString &zLabel) throw ()
virtual _DWFTK_API const DWFStringgetLabel () const throw ()
virtual _DWFTK_API const DWFStringinitialURI () throw ()
virtual _DWFTK_API void setInitialURI (const DWFString &zInitialURI) throw ()
virtual _DWFTK_API DWFString href () throw ()
virtual _DWFTK_API const DWFStringname () throw ()
_DWFTK_API void addCoordinateSystem (DWFCoordinateSystem *pCS) throw ()
virtual _DWFTK_API DWFCoordinateSystem::tList::IteratorgetCoordinateSystems () throw ()
virtual _DWFTK_API void removeCoordinateSystem (DWFCoordinateSystem *pCS, bool bDelete) throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFPublishableSection (const DWFString &zSectionType, const DWFString &zSectionTitle="", const DWFString &zSectionSource="", const DWFString &zSectionSourceID="", const DWFString &zSectionSourceHRef="", const DWFString &zSectionLabel="")

Classes

class  ResourceIterator
 An iterator for retrieving resources in the model. More...


Constructor & Destructor Documentation

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

Destructor

Exceptions:
None 

Definition at line 197 of file PublishableSection.h.

_DWFTK_API DWFToolkit::DWFPublishableSection::DWFPublishableSection const DWFString zSectionType,
const DWFString zSectionTitle = "",
const DWFString zSectionSource = "",
const DWFString zSectionSourceID = "",
const DWFString zSectionSourceHRef = "",
const DWFString zSectionLabel = ""
[inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 491 of file PublishableSection.h.


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFPublishableSection::addCoordinateSystem DWFCoordinateSystem pCS  )  throw () [inline]
 

Adds a coordinate system to be used with this publishable section

Parameters:
pCS The coordinate system to be added to this publishable section (must not be NULL). This pointer is now owned by the this resource and will be released with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 

Definition at line 439 of file PublishableSection.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::addResource DWFPublishableResource  )  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 

Implemented in DWFToolkit::DWFModel.

Definition at line 235 of file PublishableSection.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::embedFont DWFEmbeddedFont  )  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 

Implemented in DWFToolkit::DWFModel.

Definition at line 219 of file PublishableSection.h.

virtual _DWFTK_API DWFCoordinateSystem::tList::Iterator* DWFToolkit::DWFPublishableSection::getCoordinateSystems  )  throw () [inline, virtual]
 

Locates all coordinate systems in this publishable section

Returns:
A pointer to an iterator for enumerating the coordinate systems (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Coordinate systems returned from the iterator are owned by the publishable section and must not be deleted by the caller.
Exceptions:
None 

Definition at line 456 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getLabel  )  const throw () [inline, virtual]
 

Returns the section label.

Returns:
A string containing a label for this section
Exceptions:
None 
Since:
7.2.0

Definition at line 354 of file PublishableSection.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 

Implemented in DWFToolkit::DWFModel.

Definition at line 250 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getSource  )  const throw () [inline, virtual]
 

Returns the name of the source of the section.

Returns:
Describes the source (application, component, etc.) of the section data.
Exceptions:
None 

Definition at line 300 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getSourceHRef  )  const throw () [inline, virtual]
 

Returns the href of the source of the section.

Returns:
An href location of the source (document, file, database, etc.) of the section data.
Exceptions:
None 

Definition at line 326 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getSourceID  )  const throw () [inline, virtual]
 

Returns an identifier of the source of the section.

Returns:
Uniquely identifies the source (document, file, database, etc.) of the section data.
Exceptions:
None 

Definition at line 313 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getTitle  )  const throw () [inline, virtual]
 

Returns the title of the section.

Returns:
Corresponds to the section title.
Exceptions:
None 

Definition at line 276 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::getType  )  const throw () [inline, virtual]
 

Returns the type of the section.

Returns:
Corresponds to the section type.
Exceptions:
None 

Definition at line 263 of file PublishableSection.h.

virtual _DWFTK_API double DWFToolkit::DWFPublishableSection::getVersion  )  const throw () [pure virtual]
 

Returns the version of this section type/descriptor.

Returns:
The version of this section type/descriptor.
Exceptions:
None 

Implemented in DWFToolkit::DWFModel.

virtual _DWFTK_API DWFString DWFToolkit::DWFPublishableSection::href  )  throw () [inline, virtual]
 

Get the section href that uniquely identifies the published section in the package. When setting URIs into this section, using this href in the URI.

Returns:
The section href
Exceptions:
None 
Since:
7.2.0

Definition at line 397 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::initialURI  )  throw () [inline, virtual]
 

Gets the initial URI.

Returns:
A string containing the URI to be applied after the section is loaded.
Exceptions:
None 
Since:
7.2.0

Definition at line 368 of file PublishableSection.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFPublishableSection::name  )  throw () [inline, virtual]
 

Get the section name, i.e. the second portion of the section href. This is set once a call to href() has been made. This is used by the publisher to ensure the published section has the correct href.

Returns:
The section name
Exceptions:
None 
Since:
7.2.0

Definition at line 423 of file PublishableSection.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.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::removeCoordinateSystem DWFCoordinateSystem pCS,
bool  bDelete
throw ( DWFException ) [inline, virtual]
 

Clears the coordinate system from the publishable section.

Parameters:
pCS The coordinate system object to remove from this container.
bDelete If true the coordinate system object will be deleted; otherwise, the object must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Definition at line 471 of file PublishableSection.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::setInitialURI const DWFString zInitialURI  )  throw () [inline, virtual]
 

Sets the initial URI.

Parameters:
zInitialURI A string containing the URI to be applied after the section is loaded.
Exceptions:
None 
Since:
7.2.0

Definition at line 382 of file PublishableSection.h.

virtual _DWFTK_API void DWFToolkit::DWFPublishableSection::setLabel const DWFString zLabel  )  throw () [inline, virtual]
 

Sets the section label.

Parameters:
zLabel A string containing the label.
Exceptions:
None 
Since:
7.3.0

Definition at line 340 of file PublishableSection.h.


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