include/wx/msw/regconf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/regconf.h
   3 // Purpose:     Registry based implementation of wxConfigBase
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     27.04.98
   7 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_MSW_REGCONF_H_
  12 #define _WX_MSW_REGCONF_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_CONFIG && wxUSE_REGKEY
  17
  18 #include "wx/msw/registry.h"
  19 #include "wx/object.h"
  20 #include "wx/confbase.h"
  21 #include "wx/buffer.h"
  22
  23 // ----------------------------------------------------------------------------
  24 // wxRegConfig
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLIMPEXP_BASE wxRegConfig : public wxConfigBase
  28 {
  29 public:
  30   // ctor & dtor
  31     // will store data in HKLM\appName and HKCU\appName
  32   wxRegConfig(const wxString& appName = wxEmptyString,
  33               const wxString& vendorName = wxEmptyString,
  34               const wxString& localFilename = wxEmptyString,
  35               const wxString& globalFilename = wxEmptyString,
  36               long style = wxCONFIG_USE_GLOBAL_FILE);
  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   virtual bool Flush(bool WXUNUSED(bCurrentOnly) = false) { return true; }
  66
  67   // rename
  68   virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
  69   virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
  70
  71   // delete
  72   virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso = true);
  73   virtual bool DeleteGroup(const wxString& key);
  74   virtual bool DeleteAll();
  75
  76 protected:
  77   // opens the local key creating it if necessary and returns it
  78   wxRegKey& LocalKey() const // must be const to be callable from const funcs
  79   {
  80       wxRegConfig* self = wxConstCast(this, wxRegConfig);
  81
  82       if ( !m_keyLocal.IsOpened() )
  83       {
  84           // create on demand
  85           self->m_keyLocal.Create();
  86       }
  87
  88       return self->m_keyLocal;
  89   }
  90
  91   // implement read/write methods
  92   virtual bool DoReadString(const wxString& key, wxString *pStr) const;
  93   virtual bool DoReadLong(const wxString& key, long *plResult) const;
  94   virtual bool DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const;
  95
  96   virtual bool DoWriteString(const wxString& key, const wxString& szValue);
  97   virtual bool DoWriteLong(const wxString& key, long lValue);
  98   virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf);
  99
 100 private:
 101   // these keys are opened during all lifetime of wxRegConfig object
 102   wxRegKey  m_keyLocalRoot,  m_keyLocal,
 103             m_keyGlobalRoot, m_keyGlobal;
 104
 105   // current path (not '/' terminated)
 106   wxString  m_strPath;
 107
 108   wxDECLARE_NO_COPY_CLASS(wxRegConfig);
 109   DECLARE_ABSTRACT_CLASS(wxRegConfig)
 110 };
 111
 112 #endif // wxUSE_CONFIG && wxUSE_REGKEY
 113
 114 #endif // _WX_MSW_REGCONF_H_