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