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

IRmRegistryManager Class Reference

Registry managing interface. More...

#include <RmRegistryManager.h>

List of all members.

Public Member Functions

 IRmRegistryManager ()
 Constructor.

virtual ~IRmRegistryManager ()
 Destructor.

virtual RmRegistryBranch * GetRegistryRootBranch (RmNode *pRmNode)=0
 Get root branch.

virtual const RM_TCHAR * GetRegistryRootPath (void)=0
 Get root branch path.

virtual RmRegistryBranch * GetGlobalRegistryRootBranch (RmRegistryBranch *pGlobalRegistryBranch)=0
 Get global registry branch.

virtual const RM_TCHAR * GetRootPlugInBranchPath (void)=0
virtual RmRegistryBranch * GetLocalRegistryBranch ()=0
 Get local registry branch.

virtual const RM_TCHAR * GetLocalRegistryBranchPath (void)=0
 Get local registry branch path.

virtual RmRegistryBranch * GetLocalRegistryRootPlugInBranch (void)=0
 Get local registry root plugin branch.

virtual RmRegistryBranch * GetGlobalRegistryRootPlugInBranch (void)=0
 Get global registry root plugin branch.

virtual RmRegistryBranch * GetLocalRegistryPlugInUserBranch (const RM_TCHAR *strUserPlugInBranchName)=0
 Get local registry plugin user branch.

virtual RmRegistryBranch * GetLocalRegistryBranchForPlugIn (const RM_TCHAR *strPlugInBranchName)=0
 Get local registry branch for plugin.

virtual bool LocalPlugInRegistryProcessNodeNameChange (const RM_TCHAR *strPlugInBranchName, const RM_TCHAR *strPlugInRepositoryName, const RM_TCHAR *strRegistryName, RmNode *pNode, RmStringT *pStrOldName)=0
virtual bool CreateLocalPlugInRegistryBranch (const RM_TCHAR *strPlugInBranchName)=0
 Create local plugin registry.

virtual bool DeleteAllEntriesInLocalPlugInRegistryBranch (const RM_TCHAR *strPlugInBranchName, const RM_TCHAR *strPlugInRepositoryName, const RM_TCHAR *strRegistryName)=0
 Destroy all entries in local plugin registries.

virtual RmNode * GetRegistryNode (RmNode *pRegistryBranch, const RM_TCHAR *strRegistryPath)=0
 Get registry node.

virtual bool GetWindowPlacementData (RmRegistryBranch *pNodeRegistryBranch, RmWindowPlacementData &windowPlacementData)=0
 Get window placement data.

virtual bool SaveWindowPlacementData (RmRegistryBranch *pNodeRegistryBranch, HWND hWnd)=0
 Save window placement data.

virtual bool SaveWindowPlacementData (RmRegistryBranch *pNodeRegistryBranch, const RmWindowPlacementData &windowPlacementData)=0
 Save window placement data.

virtual bool CreateWindowPlacementData (HWND hWnd, RmWindowPlacementData &windowPlacementData)=0
 Create window placement data.

virtual RmRegistryBranch * GetGlobalRegistryUserDefinedBranch (const RM_TCHAR *strRegistryName)=0
 Get global registry user defined branch.

virtual void GlobalRegistrySaveIntegerNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, int nValue)=0
 Save integer value.

virtual int GlobalRegistryLoadIntegerNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, int nDefaultValue)=0
 Load integer from registry.

virtual void GlobalRegistrySaveFloatNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, float fValue)=0
 Save float to registry.

virtual float GlobalRegistryLoadFloatNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, float fDefaultValue)=0
 Load float value from registry.

virtual void GlobalRegistrySaveStringNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, const RM_TCHAR *pStrValue)=0
 Save string value to registry.

virtual void GlobalRegistryLoadStringNode (RmRegistryBranch *pGeneralRegistryBranch, const RM_TCHAR *strNodeName, const RM_TCHAR *pDefaultString, RM_TCHAR *strResult)=0
 Load string value from registry.

Detailed Description

Registry managing interface.

RegistryManager Interface.

The registry manager is used to manage RenderMonkey application registry (also called 'global registry') as well as workspace-specific registry branches. Each registry branch can store information about either application settings (in global registry) or about plug-ins (for example) or specific window information (window placement information, for example).

Constructor & Destructor Documentation

IRmRegistryManager::IRmRegistryManager (   ) 
 

Constructor.

Constructor

virtual IRmRegistryManager::~IRmRegistryManager (   )  [virtual]
 

Destructor.

Destructor

Member Function Documentation

virtual bool IRmRegistryManager::CreateLocalPlugInRegistryBranch (  const RM_TCHAR *  strPlugInBranchName  )  [pure virtual]
 

Create local plugin registry.

Creates a new branch with a given name for a specified plug-in in the local plug-in registry branch. See the scheme above for structure (the branch created is equivalent to branch located at 'strPlugInBranchName' level.

Parameters:
strPlugInBranchName PlugIn branch name
Returns:
True on success

virtual bool IRmRegistryManager::CreateWindowPlacementData (  HWND  hWnd,
RmWindowPlacementData &  windowPlacementData
)  [pure virtual]
 

Create window placement data.

Create RenderMonkey-specific window placement data with current window positioning and sizing information retrieved from the specified window handle.

Parameters:
hWnd Window handle
windowPlacementData Placement data
See also:
RmWindowPlacementData
Returns:
True on success

virtual bool IRmRegistryManager::DeleteAllEntriesInLocalPlugInRegistryBranch (  const RM_TCHAR *  strPlugInBranchName,
const RM_TCHAR *  strPlugInRepositoryName,
const RM_TCHAR *  strRegistryName
)  [pure virtual]
 

Destroy all entries in local plugin registries.

Deletes entries from a registry branch in the plug-in branch in local registry (see the scheme above.

Parameters:
strPlugInBranchName Branch name
strPlugInRepositoryName Repository name
strRegistryName Registry name
Returns:
True on success

virtual RmRegistryBranch* IRmRegistryManager::GetGlobalRegistryRootBranch (  RmRegistryBranch *  pGlobalRegistryBranch  )  [pure virtual]
 

Get global registry branch.

Retrieves the global registry root which is used to save application-specific settings

Returns:
Global registry branch

virtual RmRegistryBranch* IRmRegistryManager::GetGlobalRegistryRootPlugInBranch (  void   )  [pure virtual]
 

Get global registry root plugin branch.

Retrieve the registry branch used to store plug-in specific information in the application (global) registry Each RenderMonkey plug-in can then add or retrieve a registry node dedicated to that particular plug-in data

Returns:
Global registry root plugin branch

virtual RmRegistryBranch* IRmRegistryManager::GetGlobalRegistryUserDefinedBranch (  const RM_TCHAR *  strRegistryName  )  [pure virtual]
 

Get global registry user defined branch.

Retrieve a registry branch for specified user-defined name from the application global registry branch. For example, a plug-in may want to store its own application settings in a plug-in registry node, in which case it has a consistent place for registry management.

Parameters:
strRegistryName Name of registry
Returns:
Global registry user defined branch

virtual RmRegistryBranch* IRmRegistryManager::GetLocalRegistryBranch (   )  [pure virtual]
 

Get local registry branch.

Retrieve the root node to local registry, these reg keys are saved in the workspace file whenever the user chooses to save the workspace to disk.

Returns:
Local registry branch

virtual RmRegistryBranch* IRmRegistryManager::GetLocalRegistryBranchForPlugIn (  const RM_TCHAR *  strPlugInBranchName  )  [pure virtual]
 

Get local registry branch for plugin.

Retrieve a registry branch for a particular plug-in from the local plug-in registry repository using the specified name as an identifier

Parameters:
strUserPlugInBranchName Name of plugin to serach for
Returns:
Local registry branch for plugin

virtual const RM_TCHAR* IRmRegistryManager::GetLocalRegistryBranchPath (  void   )  [pure virtual]
 

Get local registry branch path.

Retrieve the name for local plug-in registry branch root

Returns:
Path to local registry branch

virtual RmRegistryBranch* IRmRegistryManager::GetLocalRegistryPlugInUserBranch (  const RM_TCHAR *  strUserPlugInBranchName  )  [pure virtual]
 

Get local registry plugin user branch.

Retrieve a registry branch for a particular plug-in using specified name for the registry branch from local workspace registry. Returns NULL if no such plug-in registry is found.

Parameters:
strUserPlugInBranchName Name of plugin to serach for
Returns:
Local registry plugin user branch

virtual RmRegistryBranch* IRmRegistryManager::GetLocalRegistryRootPlugInBranch (  void   )  [pure virtual]
 

Get local registry root plugin branch.

Retrieve the root registry branch used to store plug-in specific information the workspace (i.e. local) registry. Each RenderMonkey plug-in can then add or retrieve a registry node dedicated to that particular plug-in data.

Returns:
Local registry root plugin branch

virtual RmNode* IRmRegistryManager::GetRegistryNode (  RmNode *  pRegistryBranch,
const RM_TCHAR *  strRegistryPath
)  [pure virtual]
 

Get registry node.

Retrieve a node in the registry pointed to by the supplied path. The specified path must be of form below: /RM_GLOBAL/NODE_NAME/NODE2_NAME /RM_LOCAL/FOO/BAR /RM_LOCAL/FOO/../FOO/BAR/./.

Use Get**Path() methods to determine starting points for the paths.

Parameters:
pRegistryBranch Registry branch node
strRegistryPath Path to registry
Returns:
Node found
See also:
RmNode

virtual RmRegistryBranch* IRmRegistryManager::GetRegistryRootBranch (  RmNode *  pRmNode  )  [pure virtual]
 

Get root branch.

Retrieve the root node of the registry. This root registry node has two child branches: one for application settings (also referred to as 'global registry') which is used to store RenderMonkey application preferences and settings and one registry branch used to store settings specific to the currently opened workspace ('local' registry). The global registry information is store in the application configuration file (rmRegistry.rfx in the /data directory under the main RenderMonkey directory). The local workspace registry information is stored in each RFX workspace file.

If the user specifies the main RenderMonkey workspace node as the input 'pRmNode' then the local registry root will be retrieved. If the user specifies the global registry workspace as the 'pRmNode' then the global registry root will be retrieved.

Parameters:
pRmNode Node
See also:
RmNode
Returns:
If Node is workspace, return registry root, otherwise global registry root is returned.

virtual const RM_TCHAR* IRmRegistryManager::GetRegistryRootPath (  void   )  [pure virtual]
 

Get root branch path.

Retrieve the path to the main registry root node (see RmRegistryManager.h in RmCore for more explanation about registry management in RenderMonkey).

Returns:
Path to registry root branch

virtual const RM_TCHAR* IRmRegistryManager::GetRootPlugInBranchPath (  void   )  [pure virtual]
 

Get root plugin branch

Retrieve the name for root plug-in registry branch

Returns:
Root plugin branch

virtual bool IRmRegistryManager::GetWindowPlacementData (  RmRegistryBranch *  pNodeRegistryBranch,
RmWindowPlacementData &  windowPlacementData
)  [pure virtual]
 

Get window placement data.

Retrieve window placement data for specified node registry branch (see comment in RmRegistryManager.h for more details about window placement information management).

Parameters:
pNodeRegistryBranch Registry branch
windowPlacementData Windowplacement data
See also:
RmWindowPlacementData
Returns:
True on success

virtual float IRmRegistryManager::GlobalRegistryLoadFloatNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
float  fDefaultValue
)  [pure virtual]
 

Load float value from registry.

Load a float value from the registry.If the node doesn't exist in the registry, it will be created with the provided 'fDefaultValue'

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node
fDefaultValue Default value incase node was not found
Returns:
Value from node ( or default value if node was not found )

virtual int IRmRegistryManager::GlobalRegistryLoadIntegerNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
int  nDefaultValue
)  [pure virtual]
 

Load integer from registry.

Load an integer value from the registry. If the node doesn't exist in the registry, it will be created with the provided 'nDefaultValue'

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node
nDefaultValue Default value incase node was not found
Returns:
Value from node ( or default value if node was not found )

virtual void IRmRegistryManager::GlobalRegistryLoadStringNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
const RM_TCHAR *  pDefaultString,
RM_TCHAR *  strResult
)  [pure virtual]
 

Load string value from registry.

Load a string value from the registry. If the node doesn't exist in the registry, it will be created with the provided 'pDefaultString'

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node
pDefaultString Default value incase node was not found
Result string is saved to here

virtual void IRmRegistryManager::GlobalRegistrySaveFloatNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
float  fValue
)  [pure virtual]
 

Save float to registry.

Save a float value to the specified registry branch in the global registry

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node
fValue Value to save
Returns:
None

virtual void IRmRegistryManager::GlobalRegistrySaveIntegerNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
int  nValue
)  [pure virtual]
 

Save integer value.

Save an integer value to the specified registry branch in the global registry

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node Value to save
Returns:
None

virtual void IRmRegistryManager::GlobalRegistrySaveStringNode (  RmRegistryBranch *  pGeneralRegistryBranch,
const RM_TCHAR *  strNodeName,
const RM_TCHAR *  pStrValue
)  [pure virtual]
 

Save string value to registry.

Save a string value to the specified registry branch in the global registry

Parameters:
pGeneralRegistryBranch Global registry branch
strNode Name of node
pStrValue Value to save
Returns:
None

virtual bool IRmRegistryManager::LocalPlugInRegistryProcessNodeNameChange (  const RM_TCHAR *  strPlugInBranchName,
const RM_TCHAR *  strPlugInRepositoryName,
const RM_TCHAR *  strRegistryName,
RmNode *  pNode,
RmStringT *  pStrOldName
)  [pure virtual]
 

This method goes through the plug-in registry branch repository located (see scheme below) and updates the entry for the given node (if one exists). The node must already be renamed and the input parameter 'pStrOldName' contains the name by which to identify the node stored in the plug-in registry branch. For example, if a plug-in registry stored information about a variable named "MyFloat", which was then renamed to "MyNewFloat", then the parameter 'pStrOldName' would store "MyFloat" and parameter 'pNode' would be named "MyNewFloat" when this method would be called. This method assumes that the structure of plug-in repository branch is as follows: + RenderMonkey Local Plug-in Registry |

  • PlugIn Branch ('strPlugInBranchName') |
    • A particular repository branch for some information ('strPlugInRepositoryName') (each plug-in can have as many repositories as it wishes) |
      • registry ('strRegistryName') (contains entries for each node based on node name

Parameters:
strPlugInBranchName Branch name
strPlugInRepositoryName Repository name
strRegistryName Registry name
pNode Node that got renamed
pStrOldName Old name of node before renaming
Returns:
True on success

virtual bool IRmRegistryManager::SaveWindowPlacementData (  RmRegistryBranch *  pNodeRegistryBranch,
const RmWindowPlacementData &  windowPlacementData
)  [pure virtual]
 

Save window placement data.

Save specified window placement data in the specified node registry branch (see comment in RmRegistryManager.h for more details about window placement information management).

Parameters:
pNodeRegistryBranch Registry branch
windowPlacementData Placement data to save
See also:
RmWindowPlacementData
Returns:
True on success

virtual bool IRmRegistryManager::SaveWindowPlacementData (  RmRegistryBranch *  pNodeRegistryBranch,
HWND  hWnd
)  [pure virtual]
 

Save window placement data.

Save specified window placement data in the specified node registry branch (see comment in RmRegistryManager.h for more details about window placement information management). This method will create window placement structure based on the current position and size information of the input window ('hWnd').

Parameters:
pNodeRegistryBranch Registry branch
hWnd Window handle to save placement for
Returns:
True on success

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