Doc tweaks

[wxWidgets.git] / include / wx / msw / regconf.h

diff --git a/include/wx/msw/regconf.h b/include/wx/msw/regconf.h
index 3c33e2731acd1423dd0a5e50001867a7cfc1d2f6..960d098f82c5595793a2dbb9285e19177e0f037a 100644 (file)
--- a/include/wx/msw/regconf.h
+++ b/include/wx/msw/regconf.h
@@ -1,8 +1,8 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        msw/regconf.h  
+// Name:        msw/regconf.h
 // Purpose:     Registry based implementation of wxConfigBase
 // Author:      Vadim Zeitlin
-// Modified by: 
+// Modified by:
 // Created:     27.04.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
@@ -17,21 +17,24 @@
 #endif
 
 #ifndef   _REGISTRY_H
-  #include <wx/msw/registry.h>
+  #include "wx/msw/registry.h"
 #endif
+#include "wx/object.h"
 
 // ----------------------------------------------------------------------------
 // wxRegConfig
 // ----------------------------------------------------------------------------
 
-class wxRegConfig : public wxConfigBase
+class WXDLLEXPORT wxRegConfig : public wxConfigBase
 {
 public:
   // ctor & dtor
     // will store data in HKLM\appName and HKCU\appName
-  wxRegConfig(const wxString& appName = wxEmptyString, const wxString& vendorName = wxEmptyString,
-    const wxString& localFilename = wxEmptyString, const wxString& globalFilename = wxEmptyString,
-    long style = 0);
+  wxRegConfig(const wxString& appName = _T(""),
+              const wxString& vendorName = _T(""),
+              const wxString& localFilename = _T(""),
+              const wxString& globalFilename = _T(""),
+              long style = 0);
 
     // dtor will save unsaved data
   virtual ~wxRegConfig();
@@ -53,40 +56,51 @@ public:
     // tests for existence
   virtual bool HasGroup(const wxString& strName) const;
   virtual bool HasEntry(const wxString& strName) const;
+  virtual EntryType GetEntryType(const wxString& name) const;
 
     // get number of entries/subgroups in the current group, with or without
     // it's subgroups
   virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const;
   virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const;
 
-  // read/write
-  bool Read(const wxString& key, wxString *pStr) const;
-  bool Read(const wxString& key, wxString *pStr, const wxString& szDefault) const;
-  bool Read(const wxString& key, long *plResult) const;
+  virtual bool Flush(bool WXUNUSED(bCurrentOnly) = FALSE) { return TRUE; }
 
-  // The following are necessary to satisfy the compiler
-  wxString Read(const wxString& key, const wxString& defVal) const
-  { return wxConfigBase::Read(key, defVal); }
-  bool Read(const wxString& key, long *pl, long defVal) const
-  { return wxConfigBase::Read(key, pl, defVal); }
-  long Read(const wxString& key, long defVal) const
-  { return wxConfigBase::Read(key, defVal); }
-  bool Read(const wxString& key, double* val) const
-  { return wxConfigBase::Read(key, val); }
-  bool Read(const wxString& key, double* val, double defVal) const
-  { return wxConfigBase::Read(key, val, defVal); }
-
-  bool Write(const wxString& key, const wxString& szValue);
-  bool Write(const wxString& key, long lValue);
-
-  virtual bool Flush(bool /* bCurrentOnly = FALSE */ ) { return TRUE; }
+  // rename
+  virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
+  virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
 
   // delete
-  virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso);
+  virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso = TRUE);
   virtual bool DeleteGroup(const wxString& key);
   virtual bool DeleteAll();
 
+protected:
+  // opens the local key creating it if necessary and returns it
+  wxRegKey& LocalKey() const // must be const to be callable from const funcs
+  {
+      wxRegConfig* self = wxConstCast(this, wxRegConfig);
+
+      if ( !m_keyLocal.IsOpened() )
+      {
+          // create on demand
+          self->m_keyLocal.Create();
+      }
+
+      return self->m_keyLocal;
+  }
+
+  // implement read/write methods
+  virtual bool DoReadString(const wxString& key, wxString *pStr) const;
+  virtual bool DoReadLong(const wxString& key, long *plResult) const;
+
+  virtual bool DoWriteString(const wxString& key, const wxString& szValue);
+  virtual bool DoWriteLong(const wxString& key, long lValue);
+
 private:
+  // no copy ctor/assignment operator
+  wxRegConfig(const wxRegConfig&);
+  wxRegConfig& operator=(const wxRegConfig&);
+
   // these keys are opened during all lifetime of wxRegConfig object
   wxRegKey  m_keyLocalRoot,  m_keyLocal,
             m_keyGlobalRoot, m_keyGlobal;