synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h
index 5f9020a7e75573f66c443084e422cf498f7743bf..7969edba45314be9d65f74746752f224967966bc 100644 (file)
--- a/include/wx/msw/registry.h
+++ b/include/wx/msw/registry.h
@@ -12,11 +12,11 @@
 #ifndef _WX_MSW_REGISTRY_H_
 #define _WX_MSW_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"

 
 

-class WXDLLIMPEXP_BASE wxOutputStream;
+#if wxUSE_REGKEY
+
+class WXDLLIMPEXP_FWD_BASE wxOutputStream;

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


@@ -52,16 +52,11 @@ public:
     HKCR,       // classes root
     HKCU,       // current user
     HKLM,       // local machine
     HKCR,       // classes root
     HKCU,       // current user
     HKLM,       // local machine

-    HKUSR       // users
-#ifndef __WXWINCE__
-    ,
-    HKPD        // performance data (WinNT/2K only)
-#endif
-#if WINVER >= 0x0400
-    ,
-    HKCC,       // current config (starting from Win95/NT 4.0)
-    HKDD        // dynamic data (Win95/98 only)
-#endif  // Winver
+    HKUSR,      // users
+    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


@@ -71,6 +66,22 @@ public:
       Write     // read and write
   };
 
       Write     // read and write
   };
 

+  // Different registry views supported under WOW64.
+  enum WOW64ViewMode
+  {
+      // 32 bit registry for 32 bit applications, 64 bit registry
+      // for 64 bit ones.
+      WOW64ViewMode_Default,
+
+      // Can be used in 64 bit apps to access 32 bit registry,
+      // has no effect (i.e. treated as default) in 32 bit apps.
+      WOW64ViewMode_32,
+
+      // Can be used in 32 bit apps to access 64 bit registry,
+      // has no effect (i.e. treated as default) in 64 bit apps.
+      WOW64ViewMode_64
+  };
+

   // information about standard (predefined) registry keys
     // number of standard keys
   static const size_t nStdKeys;
   // information about standard (predefined) registry keys
     // number of standard keys
   static const size_t nStdKeys;


@@ -81,17 +92,23 @@ public:
     // get StdKey from root HKEY
   static StdKey GetStdKeyFromHkey(WXHKEY hkey);
 
     // get StdKey from root HKEY
   static StdKey GetStdKeyFromHkey(WXHKEY hkey);
 

-  // extacts the std key prefix from the string (return value) and
+  // extracts the std key prefix from the string (return value) and

   // leaves only the part after it (i.e. modifies the string passed!)
   static StdKey ExtractKeyName(wxString& str);
 
   // ctors
     // root key is set to HKCR (the only root key under Win16)
   // leaves only the part after it (i.e. modifies the string passed!)
   static StdKey ExtractKeyName(wxString& str);
 
   // ctors
     // root key is set to HKCR (the only root key under Win16)

-  wxRegKey();
+    wxRegKey(WOW64ViewMode viewMode = WOW64ViewMode_Default);
+

     // strKey is the full name of the key (i.e. starting with HKEY_xxx...)
     // strKey is the full name of the key (i.e. starting with HKEY_xxx...)

-  wxRegKey(const wxString& strKey);
+    wxRegKey(const wxString& strKey,
+        WOW64ViewMode viewMode = WOW64ViewMode_Default);
+

     // strKey is the name of key under (standard key) keyParent
     // strKey is the name of key under (standard key) keyParent

-  wxRegKey(StdKey keyParent, const wxString& strKey);
+    wxRegKey(StdKey keyParent,
+        const wxString& strKey,
+        WOW64ViewMode viewMode = WOW64ViewMode_Default);
+

     // strKey is the name of key under (previously created) keyParent
   wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
     // dtor closes the key
     // strKey is the name of key under (previously created) keyParent
   wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
     // dtor closes the key


@@ -110,6 +127,8 @@ public:
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.
   wxString GetName(bool bShortPrefix = true) const;
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.
   wxString GetName(bool bShortPrefix = true) const;

+    // Retrieves the registry view used by this key.
+    WOW64ViewMode GetView() const { return m_viewMode; }

     // 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)


@@ -129,15 +148,16 @@ public:
     // create the key: will fail if the key already exists and !bOkIfExists
   bool  Create(bool bOkIfExists = true);
     // rename a value from old name to new one
     // create the key: will fail if the key already exists and !bOkIfExists
   bool  Create(bool bOkIfExists = true);
     // 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)


@@ -147,21 +167,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;
+  ValueType GetValueType(const wxString& szValue) const;

     // returns true if the value contains a number (else it's some string)
     // returns true if the value contains a number (else it's some string)

-  bool IsNumericValue(const wxChar *szValue) const;
+  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;


@@ -170,30 +188,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
+  bool  QueryValue(const wxString& szValue, wxString& strValue) const

     { return QueryValue(szValue, strValue, false); }
     // retrieve raw string value
     { return QueryValue(szValue, strValue, false); }
     // retrieve raw string value

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

     { return QueryValue(szValue, strValue, true); }
     // retrieve either raw or expanded string value
     { return QueryValue(szValue, strValue, true); }
     // 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;

 
     // 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;
+  bool  QueryValue(const wxString& szValue, long *plValue) const;

     // set the binary value
     // set the binary value

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

     // return the binary value
     // return the binary value

-  bool  QueryValue(const wxChar *szValue, wxMemoryBuffer& buf) const;
+  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


@@ -241,16 +259,18 @@ private:
   wxString FormatValue(const wxString& name) const;
 
 
   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)
-
-  AccessMode  m_mode;           // valid only if key is opened
-  long        m_dwLastError;    // last error (0 if none)
+  WXHKEY        m_hKey,          // our handle
+                m_hRootKey;      // handle of the top key (i.e. StdKey)
+  wxString      m_strKey;        // key name (relative to m_hRootKey)
+  WOW64ViewMode m_viewMode;      // which view to select under WOW64
+  AccessMode    m_mode;          // valid only if key is opened
+  long          m_dwLastError;   // last error (0 if none)

 
 
 
 

-  DECLARE_NO_COPY_CLASS(wxRegKey)
+  wxDECLARE_NO_COPY_CLASS(wxRegKey);

 };
 
 };
 

+#endif // wxUSE_REGKEY
+

 #endif // _WX_MSW_REGISTRY_H_
 
 #endif // _WX_MSW_REGISTRY_H_