DWFToolkit::DWFContentPresentationReferenceNode Class Reference

Inheritance diagram for DWFToolkit::DWFContentPresentationReferenceNode:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

The DWFContentPresentationReferenceNode class allows references to other dwf elements.

Since:
7.2
The DWFContentPresentationReferenceNode class allows references to other dwf elements. Specifically, content elements, resources and URIs can be referred to from reference nodes. In addition, if the containing view has property references, URIs for properties that correspond to this node can also be specified.

Definition at line 64 of file ContentPresentationReferenceNode.h.

Public Member Functions

_DWFTK_API DWFContentPresentationReferenceNode (const DWFString &zLabel=L"", const DWFString &zID=L"") throw ()
virtual _DWFTK_API ~DWFContentPresentationReferenceNode () throw ()
virtual _DWFTK_API void setContentElement (const DWFContentElement &rContentElement) throw ()
virtual _DWFTK_API const DWFStringcontentElementID () const throw ()
virtual _DWFTK_API void setResource (DWFResource &rResource, DWFSection &rContainingSection) throw ()
virtual _DWFTK_API void setResource (DWFResource &rResource) throw ()
virtual _DWFTK_API void setResource (const DWFString &rResourceURI) throw ()
virtual _DWFTK_API const DWFStringresourceURI () const throw ()
virtual _DWFTK_API void setPropertyReferenceURI (DWFPropertyReference &rPropertyReference, const DWFString &zURI) throw (DWFException)
virtual _DWFTK_API void setPropertyReferenceURI (const DWFString &zID, const DWFString &zURI) throw (DWFException)
virtual _DWFTK_API const DWFStringgetPropertyReferenceURI (const DWFPropertyReference &rPropertyReference) const throw ()
virtual _DWFTK_API void setURI (const DWFString &zURI) throw ()
virtual _DWFTK_API const DWFStringuri () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Friends

class DWFContentPresentationResource
class DWFContentPresentationReader


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContentPresentationReferenceNode::DWFContentPresentationReferenceNode const DWFString zLabel = L"",
const DWFString zID = L""
throw ()
 

Constructor

Parameters:
zLabel An optional user-friendly label for this node.
zID A unique string identifying this node. If not provided, one will be assigned.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationReferenceNode::contentElementID  )  const throw () [inline, virtual]
 

Gets the id of the content element referenced by this node. This can be the null string during publishing if the element does not have an id assigned yet. During read, this can be null if no content element reference has been set.

Returns:
The ID of the content element
Exceptions:
None 

Definition at line 111 of file ContentPresentationReferenceNode.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationReferenceNode::getPropertyReferenceURI const DWFPropertyReference rPropertyReference  )  const throw () [virtual]
 

Gets the URI reference for the property reference corresponding to this row. This can be the null string if no URI reference has been set.

Returns:
The string containing the URI
Exceptions:
None 

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

Reimplemented in DWFToolkit::DWFContentPresentationModelViewNode.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationReferenceNode::resourceURI  )  const throw () [inline, virtual]
 

Gets the id of the resource referenced by this node. This can be the null string during publishing if the resource does not have an id assigned yet. During read, this can be null if no resource reference has been set.

Returns:
The ID of the resource
Exceptions:
None 

Definition at line 160 of file ContentPresentationReferenceNode.h.

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

Reimplemented in DWFToolkit::DWFContentPresentationModelViewNode.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setContentElement const DWFContentElement rContentElement  )  throw () [virtual]
 

Sets a reference to a content element

Parameters:
rContentElement The element to which a reference is being set
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setPropertyReferenceURI const DWFString zID,
const DWFString zURI
throw (DWFException) [virtual]
 

Sets the URI for a property reference corresponding to this node. The property reference must be contained by the presentation view containing this node.

Parameters:
zID The ID of the property reference
zURI The string containing the URI
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setPropertyReferenceURI DWFPropertyReference rPropertyReference,
const DWFString zURI
throw (DWFException) [virtual]
 

Sets the URI for a property reference corresponding to this node. The property reference must be contained by the presentation view containing this node.

Parameters:
rPropertyReference The property reference
zURI The string containing the URI
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setResource const DWFString rResourceURI  )  throw () [virtual]
 

Sets a reference to a DWF resource

Parameters:
rResourceURI The uri to the resource to which a reference is being set.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setResource DWFResource rResource  )  throw () [virtual]
 

Sets a reference to a DWF resource

Parameters:
rResource The resource to which a reference is being set. The resource is must be in the section containing the presentation.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setResource DWFResource rResource,
DWFSection rContainingSection
throw () [virtual]
 

Sets a reference to a DWF resource

Parameters:
rResource The resource to which a reference is being set
rContainingSection The section containing the resource.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationReferenceNode::setURI const DWFString zURI  )  throw () [inline, virtual]
 

Sets a reference using a URI

Parameters:
zURI The URI of the reference
Exceptions:
None 

Definition at line 213 of file ContentPresentationReferenceNode.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationReferenceNode::uri  )  const throw () [inline, virtual]
 

Gets the URI reference. This can be the null string if no URI reference has been set.

Returns:
The string containing the URI
Exceptions:
None 

Definition at line 227 of file ContentPresentationReferenceNode.h.


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