DWFToolkit::OPCCoreProperties Class Reference

Inheritance diagram for DWFToolkit::OPCCoreProperties:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 35 of file CoreProperties.h.

Public Types

typedef std::pair< DWFString,
DWFString
tNameValuePair
 This type defines a name-value string pair for properties.
typedef DWFCachingIterator<
tNameValuePair
tPropertyIterator
 This type defines an iterator over a collection of OPC property name-value pairs.

Public Member Functions

_DWFTK_API OPCCoreProperties () throw ()
_DWFTK_API const DWFStringgetSchemaID () throw ()
_DWFTK_API OPCCoreProperties::tPropertyIteratorproperties () const throw ()
_DWFTK_API OPCCoreProperties::tPropertyIteratorpropertiesInOPCNamespace () const throw ()
_DWFTK_API OPCCoreProperties::tPropertyIteratorpropertiesInDCNamespace () const throw ()
_DWFTK_API OPCCoreProperties::tPropertyIteratorpropertiesInDCTermsNamespace () const throw ()
virtual _DWFTK_API DWFString provideKeywords (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideContentType (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCategory (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideRevision (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLastModifiedBy (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLastPrinted (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideContentStatus (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCreator (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideIdentifier (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideTitle (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideSubject (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDescription (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLanguage (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCreated (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideModified (const DWFString &zValue) throw ()
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer) throw ( DWFException )

Static Public Attributes

static const char *const kzName
 "CoreProperties.xml"


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::OPCCoreProperties::OPCCoreProperties  )  throw ()
 

Constructor


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::OPCCoreProperties::getSchemaID  )  throw ()
 

For internal use only.

Return the Autodesk defined schema ID that corresponds to the OPC core properties.

Returns:
The Core Properties schema ID as defined by Autodesk.
Exceptions:
None 

_DWFTK_API OPCCoreProperties::tPropertyIterator* DWFToolkit::OPCCoreProperties::properties  )  const throw ()
 

Get an iterator over all the properties set.

Returns:
Pointer to an iterator over name-value pairs. The iterator must be deleted by the caller using DWFCORE_FREE_OBJECT. If no properties are set, the return value may be NULL.

_DWFTK_API OPCCoreProperties::tPropertyIterator* DWFToolkit::OPCCoreProperties::propertiesInDCNamespace  )  const throw ()
 

Get an iterator over all the properties in the Dublin Core namespace that have been set.

Returns:
Pointer to an iterator over name-value pairs. The iterator must be deleted by the caller using DWFCORE_FREE_OBJECT. If no such properties are set, the return value may be NULL.

_DWFTK_API OPCCoreProperties::tPropertyIterator* DWFToolkit::OPCCoreProperties::propertiesInDCTermsNamespace  )  const throw ()
 

Get an iterator over all the properties in the Dublin Core Terms namespace that have been set.

Returns:
Pointer to an iterator over name-value pairs. The iterator must be deleted by the caller using DWFCORE_FREE_OBJECT. If no such properties are set, the return value may be NULL.

_DWFTK_API OPCCoreProperties::tPropertyIterator* DWFToolkit::OPCCoreProperties::propertiesInOPCNamespace  )  const throw ()
 

Get an iterator over all the properties in the OPC namespace that have been set.

Returns:
Pointer to an iterator over name-value pairs. The iterator must be deleted by the caller using DWFCORE_FREE_OBJECT. If no such properties are set, the return value may be NULL.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideCategory const DWFString zValue  )  throw () [virtual]
 

Accept the property value for category.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideContentStatus const DWFString zValue  )  throw () [virtual]
 

Accept the property value for status.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideContentType const DWFString zValue  )  throw () [virtual]
 

Accept the property value for content type.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideCreated const DWFString zValue  )  throw () [virtual]
 

Accept the property value for date/time created.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideCreator const DWFString zValue  )  throw () [virtual]
 

Accept the property value for creator.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideDescription const DWFString zValue  )  throw () [virtual]
 

Accept the property value for description.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideIdentifier const DWFString zValue  )  throw () [virtual]
 

Accept the property value for identifier.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideKeywords const DWFString zValue  )  throw () [virtual]
 

Accept the property value for keywords.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideLanguage const DWFString zValue  )  throw () [virtual]
 

Accept the property value for language.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideLastModifiedBy const DWFString zValue  )  throw () [virtual]
 

Accept the property value for last modifier.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideLastPrinted const DWFString zValue  )  throw () [virtual]
 

Accept the property value for last printed.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideModified const DWFString zValue  )  throw () [virtual]
 

Accept the property value for date/time modified.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideRevision const DWFString zValue  )  throw () [virtual]
 

Accept the property value for revision.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideSubject const DWFString zValue  )  throw () [virtual]
 

Accept the property value for subject.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideTitle const DWFString zValue  )  throw () [virtual]
 

Accept the property value for title.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

virtual _DWFTK_API DWFString DWFToolkit::OPCCoreProperties::provideVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for version.

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

Reimplemented from DWFToolkit::OPCCorePropertiesReader.

_DWFTK_API void DWFToolkit::OPCCoreProperties::serializeXML DWFXMLSerializer rSerializer  )  throw ( DWFException ) [virtual]
 

Write an XML representation of the object into a stream.

Parameters:
rSerializer The object that accepts the serialization of the object.
Exceptions:
DWFException 

Implements DWFToolkit::OPCXMLPart.


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