vtkKWRegistryHelper.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWRegistryHelper.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWRegistryHelper_h
#define __vtkKWRegistryHelper_h

#include "vtkObject.h"
#include "vtkKWWidgets.h" // Needed for export symbols directives

class KWWidgets_EXPORT vtkKWRegistryHelper : public vtkObject
{
// @cond section_public
public:

  static vtkKWRegistryHelper* New();
  vtkTypeRevisionMacro(vtkKWRegistryHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  int ReadValue(const char *subkey, 
                const char *key, char *value);

  int DeleteKey(const char *subkey, const char *key);

  int DeleteValue(const char *subkey, const char *key);


  int SetValue(const char *subkey, const char *key, 
               const char *value);


  int Open(const char *toplevel, const char *subkey, 
           int readonly);
  
  int Close();


  vtkSetClampMacro(GlobalScope, int, 0, 1);
  vtkBooleanMacro(GlobalScope, int);
  vtkGetMacro(GlobalScope, int);
  

  vtkSetStringMacro(TopLevel);
  vtkGetStringMacro(TopLevel);


  vtkGetMacro(Opened, int);


  vtkGetMacro(Locked, int);

  //BTX
  enum {
    ReadOnly,
    ReadWrite
  };

  enum
  {
    RegistryKeyValueSizeMax = 8192,
    RegistryKeyNameSizeMax = 100
  };
  //ETX

// @endcond
// @cond section_protected
protected:
  vtkKWRegistryHelper();
  virtual ~vtkKWRegistryHelper();


  vtkSetClampMacro(Locked, int, 0, 1);
  vtkBooleanMacro(Locked, int);

  
  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 SetValueInternal(const char *key, 
                               const char *value) = 0;


  virtual int OpenInternal(const char *toplevel, const char *subkey, 
                           int readonly) = 0;
  
  virtual int CloseInternal() = 0;

  int IsSpace(char c);

  char *Strip(char *str);

  int Opened;
  int Changed;
  int Empty;
   
// @endcond
// @cond section_private
private:
  char *TopLevel;  
  int Locked;
  int GlobalScope;

  vtkKWRegistryHelper(const vtkKWRegistryHelper&); // Not implemented
  void operator=(const vtkKWRegistryHelper&); // Not implemented
};

#endif


// @endcond

---