DWFToolkit::DWFContentPresentationNode Class Reference

Inheritance diagram for DWFToolkit::DWFContentPresentationNode:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

The DWFContentPresentationNode class supports label-only nodes in a presentation view.

Since:
7.2
The DWFContentPresentationNode class supports label-only nodes in a presentation view. Icons can be assigned to be displayed along with the nodes.

Definition at line 65 of file ContentPresentationNode.h.

Public Types

typedef DWFOrderedVector<
DWFContentPresentationNode * > 
tList
 This type defines a list of DWFContentPresentationNode pointers.
typedef DWFStringKeySkipList<
DWFContentPresentationNode * > 
tMap
 This type defines a mapped collection of DWFContentPresentationNode pointers.
typedef DWFIterator< DWFContentPresentationNode * > tIterator
 This type defines a basic iterator on a collection of DWFContentPresentationNode pointers.

Public Member Functions

_DWFTK_API DWFContentPresentationNode (const DWFString &zLabel=L"", const DWFString &zID=L"") throw ()
virtual _DWFTK_API ~DWFContentPresentationNode () throw ()
virtual _DWFTK_API void setID (const DWFString &zID) throw ( DWFException )
virtual _DWFTK_API const DWFStringid () const throw ()
virtual _DWFTK_API void setLabel (const DWFString &zLabel) throw ()
virtual _DWFTK_API const DWFStringlabel () const throw ()
virtual _DWFTK_API void setDefaultIconResource (DWFImageResource &rImageResource, DWFSection &rContainingSection) throw ()
virtual _DWFTK_API void setDefaultIconResource (DWFImageResource &rImageResource) throw ()
virtual _DWFTK_API void setDefaultIconResourceURI (const DWFString &zURI) throw ()
virtual _DWFTK_API const DWFStringdefaultIconResourceURI () const throw ()
virtual _DWFTK_API void setActiveIconResource (DWFImageResource &rImageResource, DWFSection &rContainingSection) throw ()
virtual _DWFTK_API void setActiveIconResource (DWFImageResource &rImageResource) throw ()
virtual _DWFTK_API void setActiveIconResourceURI (const DWFString &zURI) throw ()
virtual _DWFTK_API const DWFStringactiveIconResourceURI () const throw ()
virtual _DWFTK_API void setExpandedIconResource (DWFImageResource &rImageResource, DWFSection &rContainingSection) throw ()
virtual _DWFTK_API void setExpandedIconResource (DWFImageResource &rImageResource) throw ()
virtual _DWFTK_API void setExpandedIconResourceURI (const DWFString &zURI) throw ()
virtual _DWFTK_API const DWFStringexpandedIconResourceURI () const throw ()
virtual _DWFTK_API void addChild (DWFContentPresentationNode *pNode) throw ( DWFException )
virtual _DWFTK_API DWFContentPresentationNode::tList::IteratorgetChildren () throw ()
virtual _DWFTK_API void removeChild (DWFContentPresentationNode *pNode, bool bDelete) throw ( DWFException )
virtual _DWFTK_API void setGroupExclusivity (bool bExclusive) throw ()
virtual _DWFTK_API bool groupExclusivity () const throw ()
virtual _DWFTK_API void setHidden (bool bHidden) throw ()
virtual _DWFTK_API bool hidden () const throw ()
virtual _DWFTK_API DWFContentPresentationNodeContainerparent () 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 DWFContentPresentationNodeContainer


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContentPresentationNode::DWFContentPresentationNode 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::DWFContentPresentationNode::~DWFContentPresentationNode  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationNode::activeIconResourceURI  )  const throw () [virtual]
 

Returns the URI to the resource that contains the icon to be used when this node is active. If no icon has been set, the string will be a null string.

Returns:
URI to the resource that contains the icon to be used when this node is in an active state.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::addChild DWFContentPresentationNode pNode  )  throw ( DWFException ) [virtual]
 

Inserts a child node to this node.

Parameters:
pNode The node to add as the child (must not be NULL). This pointer is now owned by this node and will be released with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationNode::defaultIconResourceURI  )  const throw () [virtual]
 

Returns the URI to the resource that contains the icon to be used when this node is default. If no icon has been set, the string will be a null string.

Returns:
URI to the resource that contains the icon to be used when this node is in its default state.
Exceptions:
None 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationNode::expandedIconResourceURI  )  const throw () [virtual]
 

Returns the URI to the resource that contains the icon to be used when this node is in a expanded state. If no icon has been set, the string will be a null string.

Returns:
URI to the resource that contains the icon to be used when this node is in a expanded state.
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationNode::tList::Iterator* DWFToolkit::DWFContentPresentationNode::getChildren  )  throw () [virtual]
 

Locates all children nodes in the container

Returns:
A pointer to an iterator for enumerating the nodes (may be NULL). This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro. Nodes returned from the iterator are owned by the container and must not be deleted by the caller.
Exceptions:
None 

virtual _DWFTK_API bool DWFToolkit::DWFContentPresentationNode::groupExclusivity  )  const throw () [virtual]
 

The exclusivity of this group (when it has children)

Returns:
Returns whether the group of nodes contained within this node must be treated as mutually exclusive.
Exceptions:
DWFException 

virtual _DWFTK_API bool DWFToolkit::DWFContentPresentationNode::hidden  )  const throw () [inline, virtual]
 

Returns whether this node is hidden or not.

Returns:
Returns whether this node is hidden or not.
Exceptions:
None 

Definition at line 381 of file ContentPresentationNode.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationNode::id  )  const throw () [virtual]
 

Returns the ID for this node.

Returns:
The id for this node
Exceptions:
None 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationNode::label  )  const throw () [virtual]
 

Returns the label for this node If no label has been set, returns the null string

Returns:
The label for this node
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationNodeContainer* DWFToolkit::DWFContentPresentationNode::parent  )  const throw () [inline, virtual]
 

Returns the parent of this node - the container which holds it.

Returns:
The parent, or NULL if one has not yet been set.
Exceptions:
None 

Definition at line 394 of file ContentPresentationNode.h.

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

Implements DWFCore::DWFXMLBuildable.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::removeChild DWFContentPresentationNode pNode,
bool  bDelete
throw ( DWFException ) [virtual]
 

Removes this node as a child

Parameters:
pNode The node object to remove.
bDelete If true the node will be deleted; otherwise, the node must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

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

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setActiveIconResource DWFImageResource rImageResource  )  throw () [virtual]
 

Sets the icon to be used when this node is in an active state.

Parameters:
rImageResource The image resource to be used as the icon. The image resource is must be in the section containing the presentation.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setActiveIconResource DWFImageResource rImageResource,
DWFSection rContainingSection
throw () [virtual]
 

Sets the icon to be used when this node is in an active state.

Parameters:
rImageResource The image resource to be used as the icon.
rContainingSection The section containing the resource.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setActiveIconResourceURI const DWFString zURI  )  throw () [virtual]
 

Sets the URI of the active icon resource

Parameters:
zURI The URI of the active icon resource
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setDefaultIconResource DWFImageResource rImageResource  )  throw () [virtual]
 

Sets the icon to be used when this node is in its default state.

Parameters:
rImageResource The image resource to be used as the icon. The image resource is must be in the section containing the presentation.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setDefaultIconResource DWFImageResource rImageResource,
DWFSection rContainingSection
throw () [virtual]
 

Sets the icon to be used when this node is in its default state.

Parameters:
rImageResource The image resource to be used as the icon.
rContainingSection The section containing the resource.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setDefaultIconResourceURI const DWFString zURI  )  throw () [virtual]
 

Sets the URI of the default icon resource

Parameters:
zURI The URI of the default icon resource
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setExpandedIconResource DWFImageResource rImageResource  )  throw () [virtual]
 

Sets the icon to be used when this node is in a expanded state. This is meaningful only for nodes that have children.

Parameters:
rImageResource The image resource to be used as the icon. The image resource is must be in the section containing the presentation.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setExpandedIconResource DWFImageResource rImageResource,
DWFSection rContainingSection
throw () [virtual]
 

Sets the icon to be used when this node is in a expanded state. This is meaningful only for nodes that have children.

Parameters:
rImageResource The image resource to be used as the icon.
rContainingSection The section containing the resource.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setExpandedIconResourceURI const DWFString zURI  )  throw () [virtual]
 

Sets the URI of the expanded icon resource

Parameters:
zURI The URI of the expanded icon resource
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setGroupExclusivity bool  bExclusive  )  throw () [virtual]
 

Specifies whether children of this node should be treated in a mutually exclusive manner. This mostly applies to groups containing view nodes, where the concept of undoing a node exists. When a group if identified as exclusive only one node within group maybe activated at a given time. This means, before applying a node within the group, if there exists a previously applied node, it should be "undone".

Parameters:
bExclusive If true, children of this group should be treated in an exclusive manner. The default behavior is to not treat nodes as mutually exclusive.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setHidden bool  bHidden  )  throw () [inline, virtual]
 

Specifies whether this node is hidden or not.

Parameters:
bHidden If true, this view will be marked as hidden.
Exceptions:
None 

Definition at line 368 of file ContentPresentationNode.h.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setID const DWFString zID  )  throw ( DWFException ) [virtual]
 

Sets an id for this view.

Parameters:
zID A string that specifies the id.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationNode::setLabel const DWFString zLabel  )  throw () [virtual]
 

Sets a user-friendly label for this node that

Parameters:
zLabel A string that specifies the label
Exceptions:
None 


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