no changes, just update the copyright in the header

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

diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h
index 0cbe88f4c129d0a89cd12cf595fd47ad2ea87dc3..654290ea2f2c8eb96e59d9da19bc0510cea3a640 100644 (file)
--- a/include/wx/msw/registry.h
+++ b/include/wx/msw/registry.h
@@ -1,38 +1,28 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/registry.h
+// Name:        wx/msw/registry.h

 // Purpose:     Registry classes and functions
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     Registry classes and functions
 // Author:      Vadim Zeitlin
 // Modified by:

-// Created:     03.04.198
+// Created:     03.04.1998

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

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

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

-#ifndef   _REGISTRY_H
-#define   _REGISTRY_H
+#ifndef _WX_MSW_REGISTRY_H_
+#define _WX_MSW_REGISTRY_H_

 
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "registry.h"
-#endif
+#include "wx/defs.h"

 
 

-// ----------------------------------------------------------------------------
-// types used in this module
-// ----------------------------------------------------------------------------
+#if wxUSE_REGKEY

 
 

-/*
-#ifndef   HKEY_DEFINED
-  #define HKEY_DEFINED
-  #define HKEY unsigned long
-#endif
-*/
-
-typedef unsigned long ulong;
+class WXDLLIMPEXP_FWD_BASE wxOutputStream;

 
 // ----------------------------------------------------------------------------
 // class wxRegKey encapsulates window HKEY handle
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // class wxRegKey encapsulates window HKEY handle
 // ----------------------------------------------------------------------------

-class WXDLLIMPEXP_BASE wxRegKey 
+
+class WXDLLIMPEXP_BASE wxRegKey

 {
 public:
   // NB: do _not_ change the values of elements in these enumerations!
 {
 public:
   // NB: do _not_ change the values of elements in these enumerations!


@@ -42,7 +32,6 @@ public:
   {
     Type_None,                       // No value type
     Type_String,                     // Unicode nul terminated string
   {
     Type_None,                       // No value type
     Type_String,                     // Unicode nul terminated string

-#ifdef  __WIN32__

     Type_Expand_String,              // Unicode nul terminated string
                                      // (with environment variable references)
     Type_Binary,                     // Free form binary
     Type_Expand_String,              // Unicode nul terminated string
                                      // (with environment variable references)
     Type_Binary,                     // Free form binary


@@ -55,25 +44,19 @@ public:
     Type_Resource_list,              // Resource list in the resource map
     Type_Full_resource_descriptor,   // Resource list in the hardware description
     Type_Resource_requirements_list  // ???
     Type_Resource_list,              // Resource list in the resource map
     Type_Full_resource_descriptor,   // Resource list in the hardware description
     Type_Resource_requirements_list  // ???

-#endif  //WIN32

   };
 
   // predefined registry keys
   enum StdKey
   {
   };
 
   // predefined registry keys
   enum StdKey
   {

-    HKCR        // classes root
-#ifdef  __WIN32__
-    ,
+    HKCR,       // classes root

     HKCU,       // current user
     HKLM,       // local machine
     HKUSR,      // users
     HKCU,       // current user
     HKLM,       // local machine
     HKUSR,      // users

-    HKPD        // performance data (WinNT/2K only)
-#if WINVER >= 0x0400
-    ,
-    HKCC,       // current config (starting from Win95/NT 4.0)
-    HKDD        // dynamic data (Win95/98 only)
-#endif  // Winver
-#endif  // Win32/16
+    HKPD,       // performance data (WinNT/2K only)
+    HKCC,       // current config
+    HKDD,       // dynamic data (Win95/98 only)
+    HKMAX

   };
 
   // access mode for the key
   };
 
   // access mode for the key


@@ -121,7 +104,7 @@ public:
 
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.
 
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.

-  wxString GetName(bool bShortPrefix = TRUE) const;
+  wxString GetName(bool bShortPrefix = true) const;

     // return true if the key exists
   bool  Exists() const;
     // get the info about key (any number of these pointers may be NULL)
     // return true if the key exists
   bool  Exists() const;
     // get the info about key (any number of these pointers may be NULL)


@@ -139,17 +122,18 @@ public:
     // which need the key to be opened if the key is not opened yet)
   bool  Open(AccessMode mode = Write);
     // create the key: will fail if the key already exists and !bOkIfExists
     // which need the key to be opened if the key is not opened yet)
   bool  Open(AccessMode mode = Write);
     // create the key: will fail if the key already exists and !bOkIfExists

-  bool  Create(bool bOkIfExists = TRUE);
+  bool  Create(bool bOkIfExists = true);

     // rename a value from old name to new one
     // rename a value from old name to new one

-  bool  RenameValue(const wxChar *szValueOld, const wxChar *szValueNew);
+  bool  RenameValue(const wxString& szValueOld, const wxString& szValueNew);

     // rename the key
     // rename the key

-  bool  Rename(const wxChar *szNewName);
+  bool  Rename(const wxString& szNewName);

     // copy value to another key possibly changing its name (by default it will
     // remain the same)
     // copy value to another key possibly changing its name (by default it will
     // remain the same)

-  bool  CopyValue(const wxChar *szValue, wxRegKey& keyDst,
-                  const wxChar *szNewName = NULL);
+  bool  CopyValue(const wxString& szValue, wxRegKey& keyDst,
+                  const wxString& szNewName = wxEmptyString);
+

     // copy the entire contents of the key recursively to another location
     // copy the entire contents of the key recursively to another location

-  bool  Copy(const wxChar *szNewName);
+  bool  Copy(const wxString& szNewName);

     // same as Copy() but using a key and not the name
   bool  Copy(wxRegKey& keyDst);
     // close the key (will be automatically done in dtor)
     // same as Copy() but using a key and not the name
   bool  Copy(wxRegKey& keyDst);
     // close the key (will be automatically done in dtor)


@@ -159,21 +143,19 @@ public:
     // deletes this key and all of it's subkeys/values
   bool  DeleteSelf();
     // deletes the subkey with all of it's subkeys/values recursively
     // deletes this key and all of it's subkeys/values
   bool  DeleteSelf();
     // deletes the subkey with all of it's subkeys/values recursively

-  bool  DeleteKey(const wxChar *szKey);
-    // deletes the named value (may be NULL to remove the default value)
-  bool  DeleteValue(const wxChar *szValue);
+  bool  DeleteKey(const wxString& szKey);
+    // deletes the named value (may be empty string to remove the default value)
+  bool DeleteValue(const wxString& szValue);

 
   // access to values and subkeys
     // get value type
 
   // access to values and subkeys
     // get value type

-  ValueType GetValueType(const wxChar *szValue) const;
-    // returns TRUE if the value contains a number (else it's some string)
-  bool IsNumericValue(const wxChar *szValue) const;
+  ValueType GetValueType(const wxString& szValue) const;
+    // returns true if the value contains a number (else it's some string)
+  bool IsNumericValue(const wxString& szValue) const;

 
     // assignment operators set the default value of the key
   wxRegKey& operator=(const wxString& strValue)
 
     // assignment operators set the default value of the key
   wxRegKey& operator=(const wxString& strValue)

-    { SetValue(NULL, strValue); return *this; }
-  wxRegKey& operator=(long lValue)
-    { SetValue(NULL, lValue); return *this; }
+    { SetValue(wxEmptyString, strValue); return *this; }

 
     // query the default value of the key: implicitly or explicitly
   wxString QueryDefaultValue() const;
 
     // query the default value of the key: implicitly or explicitly
   wxString QueryDefaultValue() const;


@@ -182,28 +164,30 @@ public:
     // named values
 
     // set the string value
     // named values
 
     // set the string value

-  bool  SetValue(const wxChar *szValue, const wxString& strValue);
+  bool  SetValue(const wxString& szValue, const wxString& strValue);

     // retrieve the string value
     // retrieve the string value

-  bool  QueryValue(const wxChar *szValue, wxString& strValue) const
-    { return QueryValue(szValue, strValue, FALSE); }
+  bool  QueryValue(const wxString& szValue, wxString& strValue) const
+    { return QueryValue(szValue, strValue, false); }

     // retrieve raw string value
     // retrieve raw string value

-  bool  QueryRawValue(const wxChar *szValue, wxString& strValue) const
-    { return QueryValue(szValue, strValue, TRUE); }
+  bool  QueryRawValue(const wxString& szValue, wxString& strValue) const
+    { return QueryValue(szValue, strValue, true); }

     // retrieve either raw or expanded string value
     // retrieve either raw or expanded string value

-  bool  QueryValue(const wxChar *szValue, wxString& strValue, bool raw) const;
+  bool  QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;

 
 

-#ifdef  __WIN32__

     // set the numeric value
     // set the numeric value

-  bool  SetValue(const wxChar *szValue, long lValue);
+  bool  SetValue(const wxString& szValue, long lValue);

     // return the numeric value
     // return the numeric value

-  bool  QueryValue(const wxChar *szValue, long *plValue) const;
-#endif  //Win32
+  bool  QueryValue(const wxString& szValue, long *plValue) const;
+    // set the binary value
+  bool  SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
+    // return the binary value
+  bool  QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;

 
   // query existence of a key/value
     // return true if value exists
 
   // query existence of a key/value
     // return true if value exists

-  bool HasValue(const wxChar *szKey) const;
+  bool HasValue(const wxString& szKey) const;

     // return true if given subkey exists
     // return true if given subkey exists

-  bool HasSubKey(const wxChar *szKey) const;
+  bool HasSubKey(const wxString& szKey) const;

     // return true if any subkeys exist
   bool HasSubkeys() const;
     // return true if any values exist
     // return true if any subkeys exist
   bool HasSubkeys() const;
     // return true if any values exist


@@ -218,6 +202,17 @@ public:
   bool  GetFirstKey  (wxString& strKeyName  , long& lIndex);
   bool  GetNextKey   (wxString& strKeyName  , long& lIndex) const;
 
   bool  GetFirstKey  (wxString& strKeyName  , long& lIndex);
   bool  GetNextKey   (wxString& strKeyName  , long& lIndex) const;
 

+  // export the contents of this key and all its subkeys to the given file
+  // (which won't be overwritten, it's an error if it already exists)
+  //
+  // note that we export the key in REGEDIT4 format, not RegSaveKey() binary
+  // format nor newer REGEDIT5 one
+  bool Export(const wxString& filename) const;
+
+  // same as above but write to the given (opened) stream
+  bool Export(wxOutputStream& ostr) const;
+
+

   // for wxRegConfig usage only: preallocate some memory for the name
   void ReserveMemoryForName(size_t bytes) { m_strKey.reserve(bytes); }
 
   // for wxRegConfig usage only: preallocate some memory for the name
   void ReserveMemoryForName(size_t bytes) { m_strKey.reserve(bytes); }
 


@@ -229,16 +224,29 @@ private:
     m_dwLastError = 0;
   }
 
     m_dwLastError = 0;
   }
 

-  // no copy ctor/assignment operator
-  wxRegKey(const wxRegKey& key);            // not implemented
-  wxRegKey& operator=(const wxRegKey& key); // not implemented
+  // recursive helper for Export()
+  bool DoExport(wxOutputStream& ostr) const;
+
+  // export a single value
+  bool DoExportValue(wxOutputStream& ostr, const wxString& name) const;
+
+  // return the text representation (in REGEDIT4 format) of the value with the
+  // given name
+  wxString FormatValue(const wxString& name) const;
+

 
   WXHKEY      m_hKey,           // our handle
               m_hRootKey;       // handle of the top key (i.e. StdKey)
   wxString    m_strKey;         // key name (relative to m_hRootKey)
 
 
   WXHKEY      m_hKey,           // our handle
               m_hRootKey;       // handle of the top key (i.e. StdKey)
   wxString    m_strKey;         // key name (relative to m_hRootKey)
 

+  AccessMode  m_mode;           // valid only if key is opened

   long        m_dwLastError;    // last error (0 if none)
   long        m_dwLastError;    // last error (0 if none)

+
+
+  wxDECLARE_NO_COPY_CLASS(wxRegKey);

 };
 
 };
 

-#endif  //_REGISTRY_H
+#endif // wxUSE_REGKEY
+
+#endif // _WX_MSW_REGISTRY_H_