synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/msw/registry.h b/interface/wx/msw/registry.h
index 5fd4be294f949ff0575e98c870c72b4383fad42d..d3447ea75e79d62c53ad9dcdfbefabdb766820b0 100644 (file)
--- a/interface/wx/msw/registry.h
+++ b/interface/wx/msw/registry.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxRegKey
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxRegKey
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -35,30 +35,28 @@
     @b Example:
 
     @code
     @b Example:
 
     @code

-    wxRegKey *key = new wxRegKey("HKEY_LOCAL_MACHINE\\Software\\MyKey");
+    // This assume that the key already exists, use HasSubKey() to check
+    // for the key existence if necessary.
+    wxRegKey key(wxRegKey::HKLM, "Software\\MyKey");

 
 

-    // Create the key if it does not exist.
-    if( !key->Exists() )
-        key->Create();
-
-    // Create a new value "MYVALUE" and set it to 12.
-    key->SetValue("MYVALUE", 12);
+    // Create a new value "MyValue" and set it to 12.
+    key.SetValue("MyValue", 12);

 
     // Read the value back.
     long value;
 
     // Read the value back.
     long value;

-    key->QueryValue("MYVALUE", &value);
+    key.QueryValue("MyValue", &value);

     wxMessageBox(wxString::Format("%d", value), "Registry Value", wxOK);
 
     // Get the number of subkeys and enumerate them.
     size_t subkeys;
     wxMessageBox(wxString::Format("%d", value), "Registry Value", wxOK);
 
     // Get the number of subkeys and enumerate them.
     size_t subkeys;

-    key->GetKeyInfo(&subkeys, NULL, NULL, NULL);
+    key.GetKeyInfo(&subkeys, NULL, NULL, NULL);

 
     wxString key_name;
 
     wxString key_name;

-    key->GetFirstKey(key_name, 1);
+    key.GetFirstKey(key_name, 1);

     for(int i = 0; i < subkeys; i++)
     {
         wxMessageBox(key_name, "Subkey Name", wxOK);
     for(int i = 0; i < subkeys; i++)
     {
         wxMessageBox(key_name, "Subkey Name", wxOK);

-        key->GetNextKey(key_name, 1);
+        key.GetNextKey(key_name, 1);

     }
     @endcode
 
     }
     @endcode
 


@@ -71,20 +69,27 @@ class wxRegKey
 public:
     /**
         Default constructor, initializes to @c HKEY_CLASSES_ROOT.
 public:
     /**
         Default constructor, initializes to @c HKEY_CLASSES_ROOT.

+
+        The @a viewMode parameter is new since wxWidgets 2.9.2.

     */
     */

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

     /**
         The constructor to set the full name of the key.
     /**
         The constructor to set the full name of the key.

+
+        The @a viewMode parameter is new since wxWidgets 2.9.2.

     */
     */

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

     /**
         The constructor to set the full name of the key using one of the
         standard keys, that is, HKCR, HKCU, HKLM, HKUSR, HKPD, HKCC or HKDD.
     /**
         The constructor to set the full name of the key using one of the
         standard keys, that is, HKCR, HKCU, HKLM, HKUSR, HKPD, HKCC or HKDD.

+        The @a viewMode parameter is new since wxWidgets 2.9.2.

     */
     */

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

     /**
     /**

-        The constructor to set the full name of the key under a previously created
-        parent.
+        The constructor to set the full name of the key under a previously
+        created parent. The registry view is inherited from the parent.

     */
     wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
 
     */
     wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
 


@@ -132,6 +137,33 @@ public:
     Type_Resource_requirements_list ///<
     };
 
     Type_Resource_requirements_list ///<
     };
 

+    /**
+        Used to determine how the registry will be viewed, either as
+        32-bit or 64-bit.
+
+        @since 2.9.2
+    */
+    enum WOW64ViewMode
+    {
+        /**
+            Uses 32-bit registry for 32-bit applications and
+            64-bit registry for 64-bit ones.
+        */
+        WOW64ViewMode_Default,
+
+        /**
+            Can be used in 64-bit apps to access the 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 the 64-bit registry,
+            has no effect (i.e. treated as default) in 64-bit apps.
+        */
+        WOW64ViewMode_64
+    };
+

     /**
         Closes the key.
     */
     /**
         Closes the key.
     */


@@ -224,6 +256,15 @@ public:
     */
     wxString GetName(bool bShortPrefix = true) const;
 
     */
     wxString GetName(bool bShortPrefix = true) const;
 

+    /**
+        Retrieves the registry view used by this key.
+
+        @since 2.9.2
+
+        @return The registry view given at the object's construction.
+    */
+    WOW64ViewMode GetView() const { return m_viewMode; }
+

     /**
         Gets the next key. Returns @true if successful.
     */
     /**
         Gets the next key. Returns @true if successful.
     */


@@ -247,7 +288,7 @@ public:
     /**
         Returns @true if any subkeys exist.
     */
     /**
         Returns @true if any subkeys exist.
     */

-    bool HasSubKeys() const;
+    bool HasSubkeys() const;

 
     /**
         Returns @true if the value exists.
 
     /**
         Returns @true if the value exists.