Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

RmRegistryBranch Class Reference

RegistryBranch. More...

#include <RmEffect.h>

Inheritance diagram for RmRegistryBranch:

RmNode List of all members.

Public Member Functions

 RmRegistryBranch ()
 Default Constructor.

virtual RmNodeClone (bool bIncludeLoadedData)
 Clone this node.

virtual const RM_TCHAR * GetDescription ()
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 Data Block.

const RM_TCHAR * GetTextDataBlock ()

Protected Member Functions

virtual void CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
 Copy node data.

virtual RmNodeTypeChildRuleListGetNodeTypeChildRuleList ()
 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 block.


Detailed Description

RegistryBranch.

RmRegistryBranch for registry node localization .............///


Constructor & Destructor Documentation

RmRegistryBranch::RmRegistryBranch  ) 
 

Default Constructor.

Constructor


Member Function Documentation

virtual RmNode* RmRegistryBranch::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 RmRegistryBranch::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* RmRegistryBranch::GetDescription  )  [virtual]
 

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* RmRegistryBranch::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 RM_TCHAR* RmRegistryBranch::GetTextDataBlock  )  [inline]
 

Get text block stored in the clipboard

Retrieve the text block stored in this clipboard node

Returns:
Text block string

virtual bool RmRegistryBranch::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 RmRegistryBranch::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 void RmRegistryBranch::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 RmRegistryBranch::SetTextDataBlock const RM_TCHAR *  strTextDataBlock  )  [inline]
 

Set Text Data Block.

Set textblock

Parameters:
strTextDataBlock Text block
Returns:
None


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:09:17 2005 for RenderMonkey SDK by doxygen 1.3.6