RmClipboardNode Class Reference

Clipboard. More...

#include <RmEffect.h>

Inheritance diagram for RmClipboardNode:

List of all members.

Public Member Functions
	RmClipboardNode ()
	Default Constructor.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
	Description of the node.
virtual bool	SaveXMLNode (int hDoc, const RM_TCHAR *strXPath)
	Save node contents to XML.
virtual bool	LoadXMLData (int hDoc, const RM_TCHAR *strXPath, const RM_TCHAR *strRmXMLVersion)
	Load node data from XML.
virtual bool	SaveXMLData (int hDoc, const RM_TCHAR *strXPath)
	Save node data to XML.
void	SetTextDataBlock (const RM_TCHAR *strTextDataBlock)
	Set text.
const RmStringT &	GetTextDataBlock () const
	Get text.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
virtual RmNodeTypeChildRuleList *	GetNodeTypeChildRuleList ()
	Parent / Child rule list function.
virtual void	SetNodeTypeChildRuleList (RmNodeTypeChildRuleList *pRmNodeChildRuleList)
	Sets the node child rule list for the given node.
Protected Attributes
RmStringT	m_strTextDataBlock
	Text data.

---

Detailed Description

Clipboard.

RmClipboardNode used for storing nodes on clipboard

---

Constructor & Destructor Documentation

RmClipboardNode::RmClipboardNode (   )

Default Constructor. Constructor

---

Member Function Documentation

virtual RmNode* RmClipboardNode::Clone (  bool  bIncludeLoadedData  )  [virtual]

Clone this node. Creates a clone of this node Returns: Cloned node. Returns NULL if cloning failed. Reimplemented from RmNode.

virtual void RmClipboardNode::CopyNodeData (  RmNode *  pDestinationNode, bool  bIncludeLoadedData )  [protected, virtual]

Copy node data. Copies this node's contents (not including children) into the destination node. See RmNode::CopyNodeData for details Parameters: pDestinationNode  the destination node Returns: None Reimplemented from RmNode.

virtual const RM_TCHAR* RmClipboardNode::GetDescription (   )  [virtual]

Description of the node. Returns description of the node: used for displaying a tooltip in the workspace tree view for the given node. Returns: Returns description string Reimplemented from RmNode.

virtual RmNodeTypeChildRuleList* RmClipboardNode::GetNodeTypeChildRuleList (   )  [inline, protected, virtual]

Parent / Child rule list function. Retrieves the rule list for adding child nodes for a given node type Returns: Returns node type child list rules Reimplemented from RmNode.

const RmStringT& RmClipboardNode::GetTextDataBlock (   )  const [inline]

Get text. Get Text Data Block Returns: Text

virtual bool RmClipboardNode::LoadXMLData (  int  hDoc, const RM_TCHAR *  strXPath, const RM_TCHAR *  strRmXMLVersion )  [virtual]

Load node data from XML. Loads versioned XML node data. Note that this method will only load the contents of each node, not the data for all of the children nodes. Each child will have its own XML loading function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML strRmXMLVersion  XML version Returns: True if load succeeded. False otherwise. Reimplemented from RmNode.

virtual bool RmClipboardNode::SaveXMLData (  int  hDoc, const RM_TCHAR *  strXPath )  [virtual]

Save node data to XML. Saves node's contents to XML. Note that this method will only save the contents of each node, not the data for all of the children nodes. Each child will have its own XML saving function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML Returns: True if save succeeded. False otherwise. Reimplemented from RmNode.

virtual bool RmClipboardNode::SaveXMLNode (  int  hDoc, const RM_TCHAR *  strXPath )  [virtual]

Save node contents to XML. Save XML data for the node given a pointer to the XML document Parameters: hDoc  Handle to XML document strXPath  path to this node in XML bSortChildren  Flag to sort children Returns: True on success Reimplemented from RmNode.

virtual void RmClipboardNode::SetNodeTypeChildRuleList (  RmNodeTypeChildRuleList *  pRmNodeChildRuleList  )  [inline, protected, virtual]

Sets the node child rule list for the given node. Sets the child addition rule list for the given node. Parameters: pRmNodeChildRuleList  new node rules list None  Reimplemented from RmNode.

void RmClipboardNode::SetTextDataBlock (  const RM_TCHAR *  strTextDataBlock  )  [inline]

Set text. Set Text Data Block Parameters: strTextDataBlock  text to set Returns: None

---

The documentation for this class was generated from the following file:

• RmEffect.h

---