vtkKWRegistryHelper Class Reference

A registry class. More...

#include <vtkKWRegistryHelper.h>

Inheritance diagram for vtkKWRegistryHelper:

[legend]List of all members.

[NOHEADER]
	vtkTypeRevisionMacro (vtkKWRegistryHelper, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkKWRegistryHelper *	New ()
Public Types
enum	{ ReadOnly, ReadWrite }
enum	{ RegistryKeyValueSizeMax = 8192, RegistryKeyNameSizeMax = 100 }
Public Member Functions
int	DeleteKey (const char *subkey, const char *key)
int	DeleteValue (const char *subkey, const char *key)
int	Close ()
int	ReadValue (const char *subkey, const char *key, char *value)
int	SetValue (const char *subkey, const char *key, const char *value)
int	Open (const char *toplevel, const char *subkey, int readonly)
virtual void	SetGlobalScope (int)
virtual void	GlobalScopeOn ()
virtual void	GlobalScopeOff ()
virtual int	GetGlobalScope ()
virtual void	SetTopLevel (const char *)
virtual char *	GetTopLevel ()
virtual int	GetOpened ()
virtual int	GetLocked ()
Protected Member Functions
	vtkKWRegistryHelper ()
virtual	~vtkKWRegistryHelper ()
virtual int	ReadValueInternal (const char *key, char *value)=0
virtual int	DeleteKeyInternal (const char *key)=0
virtual int	DeleteValueInternal (const char *key)=0
virtual int	CloseInternal ()=0
int	IsSpace (char c)
char *	Strip (char *str)
virtual void	SetLocked (int)
virtual void	LockedOn ()
virtual void	LockedOff ()
virtual int	SetValueInternal (const char *key, const char *value)=0
virtual int	OpenInternal (const char *toplevel, const char *subkey, int readonly)=0
Protected Attributes
int	Opened
int	Changed
int	Empty

---

Detailed Description

A registry class.

This class abstracts the storing of data that can be restored when the program executes again. On Win32 platform it is implemented using the registry and on unix as a file in the user's home directory.

Definition at line 29 of file vtkKWRegistryHelper.h.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: ReadOnly  ReadWrite  Definition at line 92 of file vtkKWRegistryHelper.h.

anonymous enum

Enumeration values: RegistryKeyValueSizeMax  RegistryKeyNameSizeMax  Definition at line 97 of file vtkKWRegistryHelper.h.

---

Constructor & Destructor Documentation

vtkKWRegistryHelper::vtkKWRegistryHelper (   )  [protected]

virtual vtkKWRegistryHelper::~vtkKWRegistryHelper (   )  [protected, virtual]

---

Member Function Documentation

vtkKWRegistryHelper* vtkKWRegistryHelper::New (   )  [static]

Standard New and type methods Reimplemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

vtkKWRegistryHelper::vtkTypeRevisionMacro (  vtkKWRegistryHelper  , vtkObject  )

void vtkKWRegistryHelper::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

int vtkKWRegistryHelper::ReadValue (  const char *  subkey, const char *  key, char *  value )

Read a value from the registry.

int vtkKWRegistryHelper::DeleteKey (  const char *  subkey, const char *  key )

Delete a key from the registry.

int vtkKWRegistryHelper::DeleteValue (  const char *  subkey, const char *  key )

Delete a value from a given key.

int vtkKWRegistryHelper::SetValue (  const char *  subkey, const char *  key, const char *  value )

Set value in a given key.

int vtkKWRegistryHelper::Open (  const char *  toplevel, const char *  subkey, int  readonly )

Open the registry at toplevel/subkey.

int vtkKWRegistryHelper::Close (   )

Close the registry.

virtual void vtkKWRegistryHelper::SetGlobalScope (  int   )  [virtual]

Read from local or global scope. On Windows this mean from local machine or local user. On unix this will read from $HOME/.Projectrc or /etc/Project

virtual void vtkKWRegistryHelper::GlobalScopeOn (   )  [virtual]

Read from local or global scope. On Windows this mean from local machine or local user. On unix this will read from $HOME/.Projectrc or /etc/Project

virtual void vtkKWRegistryHelper::GlobalScopeOff (   )  [virtual]

Read from local or global scope. On Windows this mean from local machine or local user. On unix this will read from $HOME/.Projectrc or /etc/Project

virtual int vtkKWRegistryHelper::GetGlobalScope (   )  [virtual]

Read from local or global scope. On Windows this mean from local machine or local user. On unix this will read from $HOME/.Projectrc or /etc/Project

virtual void vtkKWRegistryHelper::SetTopLevel (  const char *   )  [virtual]

Set or get the toplevel registry key.

virtual char* vtkKWRegistryHelper::GetTopLevel (   )  [virtual]

Set or get the toplevel registry key.

virtual int vtkKWRegistryHelper::GetOpened (   )  [virtual]

Return true if registry opened

virtual int vtkKWRegistryHelper::GetLocked (   )  [virtual]

Should the registry be locked?

virtual void vtkKWRegistryHelper::SetLocked (  int   )  [protected, virtual]

Should the registry be locked?

virtual void vtkKWRegistryHelper::LockedOn (   )  [protected, virtual]

Should the registry be locked?

virtual void vtkKWRegistryHelper::LockedOff (   )  [protected, virtual]

Should the registry be locked?

virtual int vtkKWRegistryHelper::ReadValueInternal (  const char *  key, char *  value )  [protected, pure virtual]

Read a value from the registry. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

virtual int vtkKWRegistryHelper::DeleteKeyInternal (  const char *  key  )  [protected, pure virtual]

Delete a key from the registry. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

virtual int vtkKWRegistryHelper::DeleteValueInternal (  const char *  key  )  [protected, pure virtual]

Delete a value from a given key. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

virtual int vtkKWRegistryHelper::SetValueInternal (  const char *  key, const char *  value )  [protected, pure virtual]

Set value in a given key. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

virtual int vtkKWRegistryHelper::OpenInternal (  const char *  toplevel, const char *  subkey, int  readonly )  [protected, pure virtual]

Open the registry at toplevel/subkey. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

virtual int vtkKWRegistryHelper::CloseInternal (   )  [protected, pure virtual]

Close the registry. Implemented in vtkKWUNIXRegistryHelper, and vtkKWWin32RegistryHelper.

int vtkKWRegistryHelper::IsSpace (  char  c  )  [protected]

Return true if the character is space.

char* vtkKWRegistryHelper::Strip (  char *  str  )  [protected]

Strip trailing and ending spaces.

---

Member Data Documentation

int vtkKWRegistryHelper::Opened [protected]

Definition at line 145 of file vtkKWRegistryHelper.h.

int vtkKWRegistryHelper::Changed [protected]

Definition at line 146 of file vtkKWRegistryHelper.h.

int vtkKWRegistryHelper::Empty [protected]

Definition at line 147 of file vtkKWRegistryHelper.h.

---

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

• GUI/Widgets/vtkKWRegistryHelper.h

---