DWFToolkit::OPCPackage Class Reference

Inheritance diagram for DWFToolkit::OPCPackage:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 45 of file opc/Package.h.

Public Member Functions

_DWFTK_API OPCContentTypes
*const 
contentTypes () const throw ()
_DWFTK_API OPCCoreProperties
*const 
coreProperties () const throw ()
_DWFTK_API virtual void setCoreProperties (OPCCoreProperties *pCorePropertiesPart, bool bOwn=true) throw ( DWFException )
virtual _DWFTK_API OPCRelationshipaddRelationship (OPCPart *pTargetPart, const DWFString &zRelationshipType, OPCRelationship::teTargetMode eTargetMode=OPCRelationship::eInternal) throw ( DWFException )
virtual _DWFTK_API bool deleteRelationship (OPCRelationship *pRelationship) throw ()
virtual _DWFTK_API size_t relationshipCount () const throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationships () throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByTarget (const DWFString &zTargetURI) const throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByTarget (OPCPart *pPart) const throw ()
virtual _DWFTK_API OPCRelationship::tIteratorrelationshipsByType (const DWFString &zType) const throw ()
virtual _DWFTK_API void deleteRelationshipsByTarget (OPCPart *pPart) throw ( DWFException )
virtual _DWFTK_API DWFInputStreamgetRelationshipsInputStream () throw ( DWFException )

Static Public Attributes

static const wchar_t *const kzURI_PackageRels
 URI of the package relationships.
static const wchar_t *const kzURI_PackageDigitalSignature
static const wchar_t *const kzURI_PackageDigitalSignatureRels
static const wchar_t *const kzURI_PackageDigitalSignatureExt
static const wchar_t *const kzURI_PackageDigitalSignatureXPS


Member Function Documentation

virtual _DWFTK_API OPCRelationship* DWFToolkit::OPCPackage::addRelationship OPCPart pTargetPart,
const DWFString zRelationshipType,
OPCRelationship::teTargetMode  eTargetMode = OPCRelationship::eInternal
throw ( DWFException ) [virtual]
 

Create and add a new relationship from the container to the specified part.

Parameters:
pTargetPart The target of the new relationship.
zRelationshipType The type to be assigned to the relationship.
eTargetMode The mode of the relationship - internal or external.
Returns:
Pointer to the new relationship
Exceptions:
DWFException 

Implements DWFToolkit::OPCRelationshipContainerInterface.

_DWFTK_API OPCCoreProperties* const DWFToolkit::OPCPackage::coreProperties  )  const throw () [inline]
 

Get the core properties of the package.

Returns:
Pointer to the package's core properties part.
Exceptions:
None 

Definition at line 83 of file opc/Package.h.

virtual _DWFTK_API bool DWFToolkit::OPCPackage::deleteRelationship OPCRelationship pRelationship  )  throw () [virtual]
 

Delete a specific relationship

Parameters:
pRelationship Pointer to the relationship to be removed.
Exceptions:
None 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API void DWFToolkit::OPCPackage::deleteRelationshipsByTarget OPCPart pPart  )  throw ( DWFException ) [virtual]
 

Remove all relationships from this item to the specified target.

Parameters:
pTargetPart Relationships to this target willl be removed.
Exceptions:
None. 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API DWFInputStream* DWFToolkit::OPCPackage::getRelationshipsInputStream  )  throw ( DWFException ) [virtual]
 

Get the input stream that will provide the serialized bytes of all relationships in the container.

Returns:
Pointer to an input stream. It must be deleted by the caller using DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

virtual _DWFTK_API size_t DWFToolkit::OPCPackage::relationshipCount  )  const throw () [virtual]
 

Get the total number of relationships from this item.

Returns:
The number of relationships from this item.
Exceptions:
None. 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCPackage::relationships  )  throw () [virtual]
 

Get all the relationships from this item

Returns:
Pointer to an iterator over all relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCPackage::relationshipsByTarget OPCPart pPart  )  const throw () [virtual]
 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCPackage::relationshipsByTarget const DWFString zTargetURI  )  const throw () [virtual]
 

Implements DWFToolkit::OPCRelationshipContainerInterface.

virtual _DWFTK_API OPCRelationship::tIterator* DWFToolkit::OPCPackage::relationshipsByType const DWFString zType  )  const throw () [virtual]
 

Get all the relationships of a given type from this item.

Parameters:
zType The type of relationships to be iterated over.
Returns:
Pointer to an iterator over the relationships. It may be NULL. It must be deleted using DWFCORE_FREE_OBJECT.
Exceptions:
None. 

Implements DWFToolkit::OPCRelationshipContainerInterface.

_DWFTK_API virtual void DWFToolkit::OPCPackage::setCoreProperties OPCCoreProperties pCorePropertiesPart,
bool  bOwn = true
throw ( DWFException ) [virtual]
 

Replace the core properties part with the one provided. This will delete the existing core properties if the package owns it and transfer over any of it's relationships to the new core properties part.

Parameters:
pCoreProperties The new coreproperties part to replace the existing one in the package.
bOwn Take ownership of the core properties part if this is true.
Exceptions:
DWFException 


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