DWFToolkit::DWFData Class Reference
[DWF Publisher API]

#include "dwf/publisher/data/Data.h"

List of all members.


Detailed Description

A publishable object that represents a single Data DWF section.

Since:
7.2

Definition at line 48 of file Data.h.

Public Member Functions

_DWFTK_API DWFData (const DWFString &zDataTitle="", const DWFString &zDataSource="", const DWFString &zDataSourceID="", const DWFString &zDataSourceHRef="") throw ()
_DWFTK_API ~DWFData () throw ()
_DWFTK_API void open () throw ( DWFException )
_DWFTK_API void close () throw ( DWFException )
_DWFTK_API void publish (DWFPublisher &rPublisher) throw ( DWFException )
virtual _DWFTK_API double getVersion () const throw ()
_DWFTK_API const DWFStringgetMIMEType () throw ( DWFException )
_DWFTK_API DWFInputStreamgetInputStream () throw ( DWFException )
_DWFTK_API void embedFont (DWFEmbeddedFont *pFont) throw ( DWFException )
_DWFTK_API void addResource (DWFPublishableResource *pResource) throw ( DWFException )
_DWFTK_API DWFIterator< DWFPublishableResource * > * getResources () throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFData::DWFData const DWFString zDataTitle = "",
const DWFString zDataSource = "",
const DWFString zDataSourceID = "",
const DWFString zDataSourceHRef = ""
throw ()
 

Constructor

Use this constructor to manage the graphics stream manually.

Parameters:
zDataTitle Corresponds to the EData section title.
zDataSource Describes the source (application, component, etc.) of the plot data.
zDataSourceID Uniquely identifies the source (document, file, database, etc.) of the plot data.
zDataSourceHRef A locator for more information about (or the actual location of) the original document.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFData::~DWFData  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFData::addResource DWFPublishableResource pResource  )  throw ( DWFException )
 

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 

_DWFTK_API void DWFToolkit::DWFData::close  )  throw ( DWFException )
 

Completes the plot.

This method should be paired with open() to scope the section's usage.

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFData::embedFont DWFEmbeddedFont pFont  )  throw ( DWFException )
 

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 

_DWFTK_API DWFInputStream* DWFToolkit::DWFData::getInputStream  )  throw ( DWFException ) [inline]
 

Returns a stream from which the publishable data can be read.

Returns:
The data stream. The caller must release the stream with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

Definition at line 141 of file Data.h.

_DWFTK_API const DWFString& DWFToolkit::DWFData::getMIMEType  )  throw ( DWFException ) [inline]
 

Returns the MIME type of the publishable data.

Returns:
The MIME type.
Exceptions:
DWFException 

Definition at line 131 of file Data.h.

_DWFTK_API DWFIterator<DWFPublishableResource*>* DWFToolkit::DWFData::getResources  )  throw ( DWFException )
 

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 

virtual _DWFTK_API double DWFToolkit::DWFData::getVersion  )  const throw () [inline, virtual]
 

Returns the version of this section type/descriptor.

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

Definition at line 121 of file Data.h.

_DWFTK_API void DWFToolkit::DWFData::open  )  throw ( DWFException )
 

Prepares the data section for first use.

Exceptions:
DWFException 

_DWFTK_API void DWFToolkit::DWFData::publish DWFPublisher rPublisher  )  throw ( DWFException )
 

Use the publisher to extract the plot structure.

Parameters:
rPublisher The publisher.
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