include/wx/msw/regconf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/regconf.h
   3 // Purpose:     Registry based implementation of wxConfigBase
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     27.04.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _REGCONF_H
  13 #define   _REGCONF_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface "regconf.h"
  17 #endif
  18
  19 #ifndef   _REGISTRY_H
  20   #include <wx/msw/registry.h>
  21 #endif
  22
  23 // ----------------------------------------------------------------------------
  24 // wxRegConfig
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLEXPORT wxRegConfig : public wxConfigBase
  28 {
  29 public:
  30   // ctor & dtor
  31     // will store data in HKLM\appName and HKCU\appName
  32   wxRegConfig(const wxString& appName = _T(""),
  33               const wxString& vendorName = _T(""),
  34               const wxString& localFilename = _T(""),
  35               const wxString& globalFilename = _T(""),
  36               long style = 0);
  37
  38     // dtor will save unsaved data
  39   virtual ~wxRegConfig();
  40
  41   // implement inherited pure virtual functions
  42   // ------------------------------------------
  43
  44   // path management
  45   virtual void SetPath(const wxString& strPath);
  46   virtual const wxString& GetPath() const { return m_strPath; }
  47
  48   // entry/subgroup info
  49     // enumerate all of them
  50   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
  51   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
  52   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
  53   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
  54
  55     // tests for existence
  56   virtual bool HasGroup(const wxString& strName) const;
  57   virtual bool HasEntry(const wxString& strName) const;
  58   virtual EntryType GetEntryType(const wxString& name) const;
  59
  60     // get number of entries/subgroups in the current group, with or without
  61     // it's subgroups
  62   virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const;
  63   virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const;
  64
  65   // read/write
  66   bool Read(const wxString& key, wxString *pStr) const;
  67   bool Read(const wxString& key, wxString *pStr, const wxString& szDefault) const;
  68   wxString Read(const wxString& key, const wxString& defVal) const
  69       { return wxConfigBase::Read(key, defVal); }
  70
  71   bool Read(const wxString& key, long *plResult) const;
  72   bool Read(const wxString& key, long *pl, long defVal) const
  73       { return wxConfigBase::Read(key, pl, defVal); }
  74   long Read(const wxString& key, long defVal) const
  75       { return wxConfigBase::Read(key, defVal); }
  76
  77   // The following are necessary to satisfy the compiler
  78   bool Read(const wxString& key, int *pi, int defVal) const
  79       { return wxConfigBase::Read(key, pi, defVal); }
  80   bool Read(const wxString& key, int *pi) const
  81       { return wxConfigBase::Read(key, pi); }
  82
  83   bool Read(const wxString& key, double* val, double defVal) const
  84       { return wxConfigBase::Read(key, val, defVal); }
  85   bool Read(const wxString& key, double* val) const
  86       { return wxConfigBase::Read(key, val); }
  87
  88   bool Read(const wxString& key, bool *pb, bool defVal) const
  89       { return wxConfigBase::Read(key, pb, defVal); }
  90   bool Read(const wxString& key, bool *pb) const
  91       { return wxConfigBase::Read(key, pb); }
  92
  93   bool Write(const wxString& key, const wxString& szValue);
  94   bool Write(const wxString& key, long lValue);
  95   bool Write(const wxString& key, double dValue)
  96       { return wxConfigBase::Write(key, dValue); }
  97   bool Write(const wxString& key, bool bValue)
  98       { return wxConfigBase::Write(key, bValue); }
  99
 100   virtual bool Flush(bool /* bCurrentOnly = FALSE */ ) { return TRUE; }
 101
 102   // rename
 103   virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
 104   virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
 105
 106   // delete
 107   virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso);
 108   virtual bool DeleteGroup(const wxString& key);
 109   virtual bool DeleteAll();
 110
 111 protected:
 112   // opens the local key creating it if necessary and returns it
 113   wxRegKey& LocalKey() const // must be const to be callable from const funcs
 114   {
 115       wxRegConfig* self = wxConstCast(this, wxRegConfig);
 116
 117       if ( !m_keyLocal.IsOpened() )
 118       {
 119           // create on demand
 120           self->m_keyLocal.Create();
 121       }
 122
 123       return self->m_keyLocal;
 124   }
 125
 126 private:
 127   // no copy ctor/assignment operator
 128   wxRegConfig(const wxRegConfig&);
 129   wxRegConfig& operator=(const wxRegConfig&);
 130
 131   // these keys are opened during all lifetime of wxRegConfig object
 132   wxRegKey  m_keyLocalRoot,  m_keyLocal,
 133             m_keyGlobalRoot, m_keyGlobal;
 134
 135   // current path (not '/' terminated)
 136   wxString  m_strPath;
 137 };
 138
 139 #endif  //_REGCONF_H