RmStringVariable Class Reference

String Variable Node. More...

#include <RmEffect.h>

Inheritance diagram for RmStringVariable:

List of all members.

Public Member Functions
	RmStringVariable ()
	Default Constructor.
	RmStringVariable (const RM_TCHAR *strValue)
	Constructor.
virtual	~RmStringVariable ()
	Destructor.
virtual void	Update (RmNodeUpdateType nodeUpdateType, RmNode *pRmUpdateRootNode)
	Update.
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.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
const RmStringT &	GetValue ()
	Get value.
void	SetValue (const RM_TCHAR *strValue)
	Set value.
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_string
	The string variable stored in the node.

---

Detailed Description

String Variable Node.

RmString is a node containing a STRING variable

---

Constructor & Destructor Documentation

RmStringVariable::RmStringVariable (   )

Default Constructor. Default constructor: creates an empty string

RmStringVariable::RmStringVariable (  const RM_TCHAR *  strValue  )

Constructor. Creates a string initialized to a copy of the given string Parameters: strValue  New string

virtual RmStringVariable::~RmStringVariable (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual RmNode* RmStringVariable::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 RmStringVariable::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 RmVariable.

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

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

virtual RmNodeTypeChildRuleList* RmStringVariable::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 RmVariable.

const RmStringT& RmStringVariable::GetValue (   )  [inline]

Get value. Retrieve the contents of the string Returns: String value of this Node

virtual bool RmStringVariable::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 RmVariable.

virtual bool RmStringVariable::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 RmVariable.

virtual void RmStringVariable::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 RmVariable.

void RmStringVariable::SetValue (  const RM_TCHAR *  strValue  )

Set value. Specifies new contents for the string node Parameters: strValue  New string value Returns: None

virtual void RmStringVariable::Update (  RmNodeUpdateType  nodeUpdateType, RmNode *  pRmUpdateRootNode )  [virtual]

Update. Updates the internal values of the node Parameters: nodeUpdateType  Update type See also: RmNodeUpdateType Parameters: pRmUpdateRootNode  Root node for update Returns: None Reimplemented from RmNode.

---

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

• RmEffect.h

---