Added event handler macro

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

diff --git a/include/wx/msw/regconf.h b/include/wx/msw/regconf.h
index 387456ff1e4de1dec82919be8454486b35aae645..d90dec3bb090ce408192a4411dde1abd36972e31 100644 (file)
--- a/include/wx/msw/regconf.h
+++ b/include/wx/msw/regconf.h
@@ -1,29 +1,43 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/regconf.h  
-// Purpose:     Registry based implementation of wxConfig
+// Name:        msw/regconf.h
+// Purpose:     Registry based implementation of wxConfigBase

 // Author:      Vadim Zeitlin
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     27.04.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     27.04.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef   _REGCONF_H
-#define   _REGCONF_H
+#ifndef _WX_MSW_REGCONF_H_
+#define _WX_MSW_REGCONF_H_
+
+#include "wx/defs.h"
+
+#if wxUSE_CONFIG && wxUSE_REGKEY
+
+#include "wx/msw/registry.h"
+#include "wx/object.h"
+#include "wx/confbase.h"
+#include "wx/buffer.h"

 
 // ----------------------------------------------------------------------------
 // wxRegConfig
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxRegConfig
 // ----------------------------------------------------------------------------
 

-class wxRegConfig : public wxConfig
+class WXDLLIMPEXP_BASE wxRegConfig : public wxConfigBase

 {
 public:
   // ctor & dtor
 {
 public:
   // ctor & dtor

-    // will store data in HKLM\strRegHive and HKCU\strRegHive
-  wxRegConfig(const wxString& strRegHive);
+    // 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 = wxCONFIG_USE_GLOBAL_FILE);
+

     // dtor will save unsaved data
     // dtor will save unsaved data

-  virtual ~wxRegConfig();
+  virtual ~wxRegConfig(){}

 
   // implement inherited pure virtual functions
   // ------------------------------------------
 
   // implement inherited pure virtual functions
   // ------------------------------------------


@@ -32,24 +46,58 @@ public:
   virtual void SetPath(const wxString& strPath);
   virtual const wxString& GetPath() const { return m_strPath; }
 
   virtual void SetPath(const wxString& strPath);
   virtual const wxString& GetPath() const { return m_strPath; }
 

-  // enum
-  virtual bool GetFirstGroup(wxString& str, long& lIndex);
-  virtual bool GetNextGroup (wxString& str, long& lIndex);
-  virtual bool GetFirstEntry(wxString& str, long& lIndex);
-  virtual bool GetNextEntry (wxString& str, long& lIndex);
+  // entry/subgroup info
+    // enumerate all of them
+  virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
+  virtual bool GetNextGroup (wxString& str, long& lIndex) const;
+  virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
+  virtual bool GetNextEntry (wxString& str, long& lIndex) const;
+
+    // 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;
+
+  virtual bool Flush(bool WXUNUSED(bCurrentOnly) = false) { return true; }

 
 

-  // read/write
-  virtual bool Read(wxString&, const char *, const char * = 0) const;
-  virtual bool Read(long&, const char *, long = 0) const;
-  virtual bool Write(const char *szKey, const char *szValue);
-  virtual bool Write(const char *szKey, long Value);
-  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
 
   // delete

-  virtual bool DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso);
-  virtual bool DeleteGroup(const char *szKey);
+  virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso = true);
+  virtual bool DeleteGroup(const wxString& key);

   virtual bool DeleteAll();
 
   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 DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const;
+
+  virtual bool DoWriteString(const wxString& key, const wxString& szValue);
+  virtual bool DoWriteLong(const wxString& key, long lValue);
+  virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf);
+

 private:
   // these keys are opened during all lifetime of wxRegConfig object
   wxRegKey  m_keyLocalRoot,  m_keyLocal,
 private:
   // these keys are opened during all lifetime of wxRegConfig object
   wxRegKey  m_keyLocalRoot,  m_keyLocal,


@@ -57,6 +105,11 @@ private:
 
   // current path (not '/' terminated)
   wxString  m_strPath;
 
   // current path (not '/' terminated)
   wxString  m_strPath;

+
+  DECLARE_NO_COPY_CLASS(wxRegConfig)
+  DECLARE_ABSTRACT_CLASS(wxRegConfig)

 };
 
 };
 

-#endif  //_REGCONF_H
+#endif // wxUSE_CONFIG && wxUSE_REGKEY
+
+#endif  // _WX_MSW_REGCONF_H_