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

DWFToolkit::DWFSource Class Reference
[DWF Package API]

#include "dwf/package/Source.h"

Inheritance diagram for DWFToolkit::DWFSource:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to identify the origin of the section content.
Since:
7.0.1.
Examples:

SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp.

Definition at line 45 of file Source.h.

Public Member Functions

_DWFTK_API DWFSource () throw ()
_DWFTK_API DWFSource (const DWFString &zHRef, const DWFString &zProvider, const DWFString &zObjectID) throw ()
_DWFTK_API DWFSource (const DWFSource &rSource) throw ()
_DWFTK_API DWFSourceoperator= (const DWFSource &rSource) throw ()
virtual _DWFTK_API ~DWFSource () throw ()
_DWFTK_API const DWFStringhref () const throw ()
_DWFTK_API const DWFStringprovider () const throw ()
_DWFTK_API const DWFStringobjectID () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSource::DWFSource  )  throw ()
 

Constructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFSource::DWFSource const DWFString zHRef,
const DWFString zProvider,
const DWFString zObjectID
throw ()
 

Constructor

Parameters:
zHRef A locator for more information about (or the actual location of) the original document.
zProvider The design or creator application or data source.
zObjectID A provider-specific identifier for the source document.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFSource::DWFSource const DWFSource rSource  )  throw ()
 

Copy Constructor

Parameters:
rSource The object from which to copy data.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::DWFSource::href  )  const throw () [inline]
 

Returns the source HREF.

Returns:
The HREF.
Exceptions:
None 

Definition at line 114 of file Source.h.

_DWFTK_API const DWFString& DWFToolkit::DWFSource::objectID  )  const throw () [inline]
 

Returns the source object ID.

Returns:
The object ID.
Exceptions:
None 

Definition at line 140 of file Source.h.

_DWFTK_API DWFSource& DWFToolkit::DWFSource::operator= const DWFSource rSource  )  throw ()
 

Assignment Operator

Parameters:
rSource The object from which to copy data.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFSource::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Receives and processes an attribute list from the parser; using it to initialize class members.

Example:

                 size_t iAttrib = 0;
       
                 for(; ppAttributeList[iAttrib]; iAttrib += 2)
                 {
                    //
                    // dump attribute 
                    //
                    cout << "Attribute Name: " << ppAttributeList[iAttrib] << " ";
                    cout << "Attribute Value: " << ppAttributeList[iAttrib+1] << endl;
                }

Parameters:
ppAttributeList An array of null-terminated atribute name, value string pairs. The array itself is zero-terminated.
Exceptions:
None 

Implements DWFToolkit::DWFXMLBuildable.

_DWFTK_API const DWFString& DWFToolkit::DWFSource::provider  )  const throw () [inline]
 

Returns the source provider.

Returns:
The provider.
Exceptions:
None 

Definition at line 127 of file Source.h.

_DWFTK_API void DWFToolkit::DWFSource::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

Writes an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
nFlags An implementation-defined set of options for altering the serialization process of this object.

Implements DWFToolkit::DWFXMLSerializable.


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