Mention wxConvLocal in wxString

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

diff --git a/interface/msw/registry.h b/interface/msw/registry.h
index e06511726a82fd2bb959db01ad9378f8ec934b86..1dc14d4eff6838a515ca8e5f6d6d974db9459594 100644 (file)
--- a/interface/msw/registry.h
+++ b/interface/msw/registry.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msw/registry.h
-// Purpose:     documentation for wxRegKey class
+// Purpose:     interface of wxRegKey
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,33 +9,34 @@
 /**
     @class wxRegKey
     @headerfile registry.h wx/msw/registry.h
-    
+
     wxRegKey is a class representing the Windows registry (it is only available
     under Windows). One can create, query and delete registry keys using this
     class.
-    
+
     The Windows registry is easy to understand. There are five registry keys,
     namely:
-    
+
      HKEY_CLASSES_ROOT (HKCR)
      HKEY_CURRENT_USER (HKCU)
      HKEY_LOCAL_MACHINE (HKLM)
      HKEY_CURRENT_CONFIG (HKCC)
      HKEY_USERS (HKU)
-    
+
     After creating a key, it can hold a value. The values can be:
-    
+
      String Value
      Binary Value
      DWORD Value
      Multi String Value
      Expandable String Value
-    
-    
+
+    @onlyfor{wxmsw}
+
     @library{wxbase}
     @category{FIXME}
 */
-class wxRegKey 
+class wxRegKey
 {
 public:
     //@{
@@ -44,8 +45,8 @@ public:
         parent.
     */
     wxRegKey();
-        wxRegKey(const wxString& strKey);
-        wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
+    wxRegKey(const wxString& strKey);
+    wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
     //@}
 
     /**
@@ -54,15 +55,15 @@ public:
     void Close();
 
     /**
-        Creates the key. Will fail if the key already exists and @e bOkIfExists is
+        Creates the key. Will fail if the key already exists and @a bOkIfExists is
         @false.
     */
-    bool Create(bool bOkIfExists = @true);
+    bool Create(bool bOkIfExists = true);
 
     /**
         Deletes the subkey with all of its subkeys/values recursively.
     */
-    void DeleteKey(const wxChar * szKey);
+    void DeleteKey(const wxChar* szKey);
 
     /**
         Deletes this key and all of its subkeys and values recursively.
@@ -72,12 +73,12 @@ public:
     /**
         Deletes the named value.
     */
-    void DeleteValue(const wxChar * szKey);
+    void DeleteValue(const wxChar* szKey);
 
     /**
         Returns @true if the key exists.
     */
-    static bool Exists();
+    static bool Exists() const;
 
     /**
         Gets the first key.
@@ -91,70 +92,67 @@ public:
 
     /**
         Gets information about the key.
-        
-        @param pnSubKeys 
-        The number of subkeys.
-        
-        @param pnMaxKeyLen 
-        The maximum length of the subkey name.
-        
-        @param pnValues 
-        The number of values.
-        
-        @param pnMaxValueLen 
-        The maximum length of a value.
-    */
-    bool GetKeyInfo(size_t * pnSubKeys, size_t * pnValues,
-                    size_t * pnMaxValueLen);
+
+        @param pnSubKeys
+            The number of subkeys.
+        @param pnMaxKeyLen
+            The maximum length of the subkey name.
+        @param pnValues
+            The number of values.
+        @param pnMaxValueLen
+            The maximum length of a value.
+    */
+    bool GetKeyInfo(size_t* pnSubKeys, size_t* pnValues,
+                    size_t* pnMaxValueLen) const;
 
     /**
         Gets the name of the registry key.
     */
-    wxString GetName(bool bShortPrefix = @true);
+    wxString GetName(bool bShortPrefix = true) const;
 
     /**
         Gets the next key.
     */
-    bool GetNextKey(wxString& strKeyName, long& lIndex);
+    bool GetNextKey(wxString& strKeyName, long& lIndex) const;
 
     /**
         Gets the next key value for this key.
     */
-    bool GetNextValue(wxString& strValueName, long& lIndex);
+    bool GetNextValue(wxString& strValueName, long& lIndex) const;
 
     /**
         Returns @true if given subkey exists.
     */
-    bool HasSubKey(const wxChar * szKey);
+    bool HasSubKey(const wxChar* szKey) const;
 
     /**
         Returns @true if any subkeys exist.
     */
-    bool HasSubKeys();
+    bool HasSubKeys() const;
 
     /**
         Returns @true if the value exists.
     */
-    bool HasValue(const wxChar * szValue);
+    bool HasValue(const wxChar* szValue) const;
 
     /**
         Returns @true if any values exist.
     */
-    bool HasValues();
+    bool HasValues() const;
 
     /**
         Returns @true if this key is empty, nothing under this key.
     */
-    bool IsEmpty();
+    bool IsEmpty() const;
 
     /**
         Returns @true if the key is opened.
     */
-    bool IsOpened();
+    bool IsOpened() const;
 
     /**
         Explicitly opens the key. This method also allows the key to be opened in
-        read-only mode by passing @c Read() instead of default 
+        read-only mode by passing @c Read() instead of default
         @c Write() parameter.
     */
     bool Open(AccessMode mode = Write);
@@ -163,30 +161,31 @@ public:
     /**
         Retrieves the numeric value.
     */
-    bool QueryValue(const wxChar * szValue, wxString& strValue);
-        bool QueryValue(const wxChar * szValue, long * plValue);
+    bool QueryValue(const wxChar* szValue, wxString& strValue) const;
+    const bool QueryValue(const wxChar* szValue, long* plValue) const;
     //@}
 
     /**
         Renames the key.
     */
-    bool Rename(const wxChar * szNewName);
+    bool Rename(const wxChar* szNewName);
 
     /**
         Renames a value.
     */
-    bool RenameValue(const wxChar * szValueOld,
-                     const wxChar * szValueNew);
+    bool RenameValue(const wxChar* szValueOld,
+                     const wxChar* szValueNew);
 
     //@{
     /**
-        Sets the given @e szValue which must be numeric, string or binary depending
+        Sets the given @a szValue which must be numeric, string or binary depending
         on the overload used. If the value doesn't exist, it is created.
     */
-    bool SetValue(const wxChar * szValue, long lValue);
-        bool SetValue(const wxChar * szValue,
-                      const wxString& strValue);
-        bool SetValue(const wxChar * szValue,
-                      const wxMemoryBuffer& buf);
+    bool SetValue(const wxChar* szValue, long lValue);
+    bool SetValue(const wxChar* szValue,
+                  const wxString& strValue);
+    bool SetValue(const wxChar* szValue,
+                  const wxMemoryBuffer& buf);
     //@}
 };
+