Move code removing "-psn_xxx" command line arguments to common code.

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

diff --git a/interface/wx/msw/registry.h b/interface/wx/msw/registry.h
index df367d6c735cb176ed4b91715135be669b67c744..915adfdf63b237b8de03eb7fe956d870c559613f 100644 (file)
--- a/interface/wx/msw/registry.h
+++ b/interface/wx/msw/registry.h
@@ -2,8 +2,7 @@
 // Name:        msw/registry.h
 // Purpose:     interface of wxRegKey
 // Author:      wxWidgets team
 // Name:        msw/registry.h
 // Purpose:     interface of wxRegKey
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

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


@@ -32,58 +31,64 @@
 
     @onlyfor{wxmsw}
 
 
     @onlyfor{wxmsw}
 

-    @library{wxbase}
-    @category{misc}
-

     @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

+
+
+    @library{wxbase}
+    @category{cfg}

 */
 class wxRegKey
 {
 public:
     /**
         Default constructor, initializes to @c HKEY_CLASSES_ROOT.
 */
 class wxRegKey
 {
 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 
+        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.
         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);
 


@@ -96,7 +101,7 @@ public:
         Write ///< Read and Write
     };
 
         Write ///< Read and Write
     };
 

-    /** 
+    /**

         The standard registry key enumerator.
     */
     enum StdKey
         The standard registry key enumerator.
     */
     enum StdKey


@@ -128,7 +133,34 @@ public:
     Type_Multi_String,        ///< Multiple Unicode strings
     Type_Resource_list,       ///< Resource list in the resource map
     Type_Full_resource_descriptor,  ///< Resource list in the hardware description
     Type_Multi_String,        ///< Multiple Unicode strings
     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_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

     };
 
     /**
     };
 
     /**


@@ -138,39 +170,40 @@ public:
 
     /**
         Copy the entire contents of the key recursively to another location
 
     /**
         Copy the entire contents of the key recursively to another location

-        using the name.
+        using the name. Returns @true if successful.

     */
     bool Copy(const wxString& szNewName);
     /**
         Copy the entire contents of the key recursively to another location
     */
     bool Copy(const wxString& szNewName);
     /**
         Copy the entire contents of the key recursively to another location

-        using the key.
+        using the key. Returns @true if successful.

     */
     bool Copy(wxRegKey& keyDst);
     */
     bool Copy(wxRegKey& keyDst);

-    
+

     /**
         Copy the value to another key, possibly changing its name. By default
     /**
         Copy the value to another key, possibly changing its name. By default

-        it will remain the same.
+        it will remain the same. Returns @true if successful.

     */
     */

-    bool CopyValue(const wxString& szValue, wxRegKey& keyDst,    
+    bool CopyValue(const wxString& szValue, wxRegKey& keyDst,

                   const wxString& szNewName = wxEmptyString);
     /**
                   const wxString& szNewName = wxEmptyString);
     /**

-        Creates the key. Will fail if the key already exists and @a bOkIfExists is
-        @false.
+        Creates the key. Will fail if the key already exists and @a bOkIfExists
+        is @false. Returns @true if successful.

     */
     bool Create(bool bOkIfExists = true);
 
     /**
     */
     bool Create(bool bOkIfExists = true);
 
     /**

-        Deletes the subkey with all of its subkeys/values recursively.
+        Deletes the subkey with all its subkeys and values recursively.

     */
     void DeleteKey(const wxString& szKey);
 
     /**
     */
     void DeleteKey(const wxString& szKey);
 
     /**

-        Deletes this key and all of its subkeys and values recursively.
+        Deletes this key and all its subkeys and values recursively.

     */
     void DeleteSelf();
 
     /**
     */
     void DeleteSelf();
 
     /**

-        Deletes the named value.
+        Deletes the named value or use an empty string argument to remove the
+        default value of the key.

     */
     void DeleteValue(const wxString& szKey);
 
     */
     void DeleteValue(const wxString& szKey);
 


@@ -183,26 +216,27 @@ public:
         Write the contents of this key and all its subkeys to the given file.
         (The file will not be overwritten; it's an error if it already exists.)
         Note that we export the key in REGEDIT4 format, not RegSaveKey() binary
         Write the contents of this key and all its subkeys to the given file.
         (The file will not be overwritten; it's an error if it already exists.)
         Note that we export the key in REGEDIT4 format, not RegSaveKey() binary

-        format nor the newer REGEDIT5.
+        format nor the newer REGEDIT5. Returns @true if successful.

     */
     bool Export(const wxString& filename) const;
     /**
         Write the contents of this key and all its subkeys to the opened stream.
     */
     bool Export(const wxString& filename) const;
     /**
         Write the contents of this key and all its subkeys to the opened stream.

+        Returns @true if successful.

     */
     bool Export(wxOutputStream& ostr) const;
     */
     bool Export(wxOutputStream& ostr) const;

-    
+

     /**
     /**

-        Gets the first key.
+        Gets the first key. Returns @true if successful.

     */
     bool GetFirstKey(wxString& strKeyName, long& lIndex);
 
     /**
     */
     bool GetFirstKey(wxString& strKeyName, long& lIndex);
 
     /**

-        Gets the first value of this key.
+        Gets the first value of this key. Returns @true if successful.

     */
     bool GetFirstValue(wxString& strValueName, long& lIndex);
 
     /**
     */
     bool GetFirstValue(wxString& strValueName, long& lIndex);
 
     /**

-        Gets information about the key.
+        Gets information about the key. Returns @true if successful.

 
         @param pnSubKeys
             The number of subkeys.
 
         @param pnSubKeys
             The number of subkeys.


@@ -222,12 +256,21 @@ public:
     wxString GetName(bool bShortPrefix = true) const;
 
     /**
     wxString GetName(bool bShortPrefix = true) const;
 
     /**

-        Gets the next key.
+        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.

     */
     bool GetNextKey(wxString& strKeyName, long& lIndex) const;
 
     /**
     */
     bool GetNextKey(wxString& strKeyName, long& lIndex) const;
 
     /**

-        Gets the next key value for this key.
+        Gets the next key value for this key. Returns @true if successful.

     */
     bool GetNextValue(wxString& strValueName, long& lIndex) const;
 
     */
     bool GetNextValue(wxString& strValueName, long& lIndex) const;
 


@@ -235,7 +278,7 @@ public:
         Gets the value type.
     */
     ValueType GetValueType(const wxString& szValue) const;
         Gets the value type.
     */
     ValueType GetValueType(const wxString& szValue) const;

-    
+

     /**
         Returns @true if given subkey exists.
     */
     /**
         Returns @true if given subkey exists.
     */


@@ -244,7 +287,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.


@@ -262,7 +305,7 @@ public:
     bool IsEmpty() const;
 
     /**
     bool IsEmpty() const;
 
     /**

-        Returns true if the value contains a number.
+        Returns @true if the value contains a number.

     */
     bool IsNumericValue(const wxString& szValue) const;
 
     */
     bool IsNumericValue(const wxString& szValue) const;
 


@@ -272,44 +315,53 @@ public:
     bool IsOpened() const;
 
     /**
     bool IsOpened() const;
 
     /**

-        Explicitly opens the key. This method also allows the key to be opened in
-        read-only mode by passing wxRegKey::Read instead of default
-        wxRegKey::Write parameter.
+        Explicitly opens the key. This method also allows the key to be opened
+        in read-only mode by passing wxRegKey::Read instead of default
+        wxRegKey::Write parameter. Returns @true if successful.

     */
     bool Open(AccessMode mode = Write);
 
     */
     bool Open(AccessMode mode = Write);
 

+    /**
+        Assignment operator to set the default value of the key.
+    */
+    wxRegKey& operator=(const wxString& strValue);
+

     /**
         Return the default value of the key.
     */
     wxString QueryDefaultValue() const;
 
     /**
     /**
         Return the default value of the key.
     */
     wxString QueryDefaultValue() const;
 
     /**

-        Retrieves the raw string value.
+        Retrieves the raw string value. Returns @true if successful.
+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
 
     /**
     */
     bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
 
     /**

-        Retrieves the raw or expanded string value.
+        Retrieves the raw or expanded string value. Returns @true if successful.
+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
 
     /**
     */
     bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
 
     /**

-        Retrieves the numeric value.
+        Retrieves the numeric value. Returns @true if successful.
+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, long* plValue) const;
 
     /**
     */
     bool QueryValue(const wxString& szValue, long* plValue) const;
 
     /**

-        Retrieves the binary structure.
+        Retrieves the binary structure. Returns @true if successful.
+        An empty @a szValue queries the default/unnamed key value.

     */
     bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
 
     /**
     */
     bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
 
     /**

-        Renames the key.
+        Renames the key. Returns @true if successful.

     */
     bool Rename(const wxString& szNewName);
 
     /**
     */
     bool Rename(const wxString& szNewName);
 
     /**

-        Renames a value.
+        Renames a value. Returns @true if successful.

     */
     bool RenameValue(const wxString& szValueOld,
                      const wxString& szValueNew);
     */
     bool RenameValue(const wxString& szValueOld,
                      const wxString& szValueNew);


@@ -317,13 +369,13 @@ public:
     /**
         Preallocate some memory for the name. For wxRegConfig usage only.
     */
     /**
         Preallocate some memory for the name. For wxRegConfig usage only.
     */

-    void ReserveMemoryForName(size_t bytes); 
+    void ReserveMemoryForName(size_t bytes);

 
     /**
         Set or change the HKEY handle.
     */
     void SetHkey(WXHKEY hKey);
 
     /**
         Set or change the HKEY handle.
     */
     void SetHkey(WXHKEY hKey);

-    
+

     /**
         Set the full key name. The name is absolute. It should start with
         HKEY_xxx.
     /**
         Set the full key name. The name is absolute. It should start with
         HKEY_xxx.


@@ -337,20 +389,23 @@ public:
         Set the name relative to the parent key
     */
     void SetName(const wxRegKey& keyParent, const wxString& strKey);
         Set the name relative to the parent key
     */
     void SetName(const wxRegKey& keyParent, const wxString& strKey);

-    
+

     /**
     /**

-        Sets the given @a szValue which must be numeric.
-        If the value doesn't exist, it is created.
+        Sets the given @a szValue which must be numeric. If the value doesn't
+        exist, it is created. Returns @true if successful.
+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, long lValue);
     /**
     */
     bool SetValue(const wxString& szValue, long lValue);
     /**

-        Sets the given @a szValue which must be string.
-        If the value doesn't exist, it is created.
+        Sets the given @a szValue which must be string. If the value doesn't
+        exist, it is created. Returns @true if successful.
+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, const wxString& strValue);
     /**
     */
     bool SetValue(const wxString& szValue, const wxString& strValue);
     /**

-        Sets the given @a szValue which must be binary.
-        If the value doesn't exist, it is created.
+        Sets the given @a szValue which must be binary. If the value doesn't
+        exist, it is created. Returns @true if successful.
+        An empty @a szValue sets the default/unnamed key value.

     */
     bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
 };
     */
     bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
 };