X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/69e037ac390426c8db8186c875da7c15366b004c..e4431849b4f2097edf0e01c5d50bf0ed947befa9:/interface/wx/msw/registry.h diff --git a/interface/wx/msw/registry.h b/interface/wx/msw/registry.h index df367d6c73..5fd4be294f 100644 --- a/interface/wx/msw/registry.h +++ b/interface/wx/msw/registry.h @@ -32,9 +32,6 @@ @onlyfor{wxmsw} - @library{wxbase} - @category{misc} - @b Example: @code @@ -64,6 +61,10 @@ key->GetNextKey(key_name, 1); } @endcode + + + @library{wxbase} + @category{cfg} */ class wxRegKey { @@ -77,7 +78,7 @@ public: */ wxRegKey(const wxString& strKey); /** - 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. */ wxRegKey(StdKey keyParent, const wxString& strKey); @@ -96,7 +97,7 @@ public: Write ///< Read and Write }; - /** + /** The standard registry key enumerator. */ enum StdKey @@ -128,7 +129,7 @@ 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_Resource_requirements_list ///< + Type_Resource_requirements_list ///< }; /** @@ -138,39 +139,40 @@ public: /** 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 - using the key. + using the key. Returns @true if successful. */ bool Copy(wxRegKey& keyDst); - + /** 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); /** - 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); /** - 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); /** - Deletes this key and all of its subkeys and values recursively. + Deletes this key and all its subkeys and values recursively. */ 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); @@ -183,26 +185,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 - 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. + Returns @true if successful. */ bool Export(wxOutputStream& ostr) const; - + /** - Gets the first key. + Gets the first key. Returns @true if successful. */ 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); /** - Gets information about the key. + Gets information about the key. Returns @true if successful. @param pnSubKeys The number of subkeys. @@ -222,12 +225,12 @@ public: wxString GetName(bool bShortPrefix = true) const; /** - Gets the next key. + Gets the next key. Returns @true if successful. */ 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; @@ -235,7 +238,7 @@ public: Gets the value type. */ ValueType GetValueType(const wxString& szValue) const; - + /** Returns @true if given subkey exists. */ @@ -262,7 +265,7 @@ public: 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; @@ -272,44 +275,53 @@ public: 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); + /** + 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; /** - 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; /** - 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; /** - 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; /** - 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; /** - Renames the key. + Renames the key. Returns @true if successful. */ bool Rename(const wxString& szNewName); /** - Renames a value. + Renames a value. Returns @true if successful. */ bool RenameValue(const wxString& szValueOld, const wxString& szValueNew); @@ -317,13 +329,13 @@ public: /** 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 the full key name. The name is absolute. It should start with HKEY_xxx. @@ -337,20 +349,23 @@ public: 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); /** - 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); /** - 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); };