DWFToolkit::DWFXDWFPropertiesReader Class Reference

#include "dwf/dwfx/reader/DWFPropertiesReader.h"

Inheritance diagram for DWFToolkit::DWFXDWFPropertiesReader:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

This class implements the required XML parsing handlers to compose dwfx core properties.

Since:
7.4.0
This class contains the processing logic particular to the known versions of the dwfx dwf properties. The algorithm is tuned specifically for this schema and is not intended to be generic.

Definition at line 53 of file DWFPropertiesReader.h.

Public Types

typedef enum DWFToolkit::DWFXDWFPropertiesReader::teProviderType teProviderType
enum  teProviderType { eProvideNone = 0x00, eProvideProperties = 0x01, eProvideElements = 0xF0, eProvideAll = 0xFF }

Public Member Functions

_DWFTK_API DWFXDWFPropertiesReader (unsigned int nProviderFlags=eProvideAll) throw ()
virtual _DWFTK_API ~DWFXDWFPropertiesReader () throw ()
_DWFTK_API DWFXDWFPropertiesReaderfilter () const throw ()
_DWFTK_API void setFilter (DWFXDWFPropertiesReader *pFilter) throw ()
virtual _DWFTK_API DWFString provideSourceProductVendor (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideSourceProductName (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideSourceProductVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDWFProductVendor (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDWFProductVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDWFToolkitVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDWFFormatVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString providePasswordEncrypted (const DWFString &zValue) throw ()
_DWFTK_API void notifyStartElement (const char *zName, const char **ppAttributeList) throw ()
_DWFTK_API void notifyEndElement (const char *zName) throw ()
_DWFTK_API void notifyStartNamespace (const char *zPrefix, const char *zURI) throw ()
_DWFTK_API void notifyEndNamespace (const char *zPrefix) throw ()
_DWFTK_API void notifyCharacterData (const char *zCData, int nLength) throw ()


Member Typedef Documentation

typedef enum DWFToolkit::DWFXDWFPropertiesReader::teProviderType DWFToolkit::DWFXDWFPropertiesReader::teProviderType
 

These enumeration flags alter the behavior of the parser by restricting which elements are inflated into runtime objects. Generally these only prevent unwanted object creation (and thus memory allocations) but in some cases, additional data processing can be avoided.


Member Enumeration Documentation

enum DWFToolkit::DWFXDWFPropertiesReader::teProviderType
 

These enumeration flags alter the behavior of the parser by restricting which elements are inflated into runtime objects. Generally these only prevent unwanted object creation (and thus memory allocations) but in some cases, additional data processing can be avoided.

Enumerator:
eProvideNone  Parse the document only (no data objects will be created; no callbacks will be invoked.)
eProvideProperties  Invoke the provideProperty() callback.
eProvideElements  Equivalent to (eProvideProperties)
eProvideAll  Equivalent to (eProvideElements)

Definition at line 64 of file DWFPropertiesReader.h.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFXDWFPropertiesReader::DWFXDWFPropertiesReader unsigned int  nProviderFlags = eProvideAll  )  throw ()
 

Constructor

Parameters:
nProviderFlags A combination of teProviderType flags.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API DWFXDWFPropertiesReader* DWFToolkit::DWFXDWFPropertiesReader::filter  )  const throw ()
 

Returns the parser filter, if applicable.

Returns:
The external filter to be applied to this parser. This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::notifyCharacterData const char *  zCData,
int  nLength
throw ()
 

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::notifyEndElement const char *  zName  )  throw ()
 

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::notifyEndNamespace const char *  zPrefix  )  throw ()
 

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::notifyStartElement const char *  zName,
const char **  ppAttributeList
throw ()
 

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::notifyStartNamespace const char *  zPrefix,
const char *  zURI
throw ()
 

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideDWFFormatVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for DWF Format version

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideDWFProductVendor const DWFString zValue  )  throw () [virtual]
 

Accept the property value for DWF product vendor.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideDWFProductVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for DWF product version.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideDWFToolkitVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for DWF Toolkit version

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::providePasswordEncrypted const DWFString zValue  )  throw () [virtual]
 

Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideSourceProductName const DWFString zValue  )  throw () [virtual]
 

Accept the property value for source product name.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideSourceProductVendor const DWFString zValue  )  throw () [virtual]
 

Accept the property value for source product vendor.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

virtual _DWFTK_API DWFString DWFToolkit::DWFXDWFPropertiesReader::provideSourceProductVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for source product version.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::DWFXDWFProperties.

_DWFTK_API void DWFToolkit::DWFXDWFPropertiesReader::setFilter DWFXDWFPropertiesReader pFilter  )  throw ()
 

Inserts a parser filter.

Parameters:
pFilter The filter to apply to this parser. This pointer is not ever deleted by this object. This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 


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