]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/msw/registry.h
Mention wxConvLocal in wxString
[wxWidgets.git] / interface / msw / registry.h
index 5515b4443bf8c2f430c0b5d0c84484c9991660ba..1dc14d4eff6838a515ca8e5f6d6d974db9459594 100644 (file)
@@ -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
@@ -31,6 +31,7 @@
      Multi String Value
      Expandable String Value
 
+    @onlyfor{wxmsw}
 
     @library{wxbase}
     @category{FIXME}
@@ -77,7 +78,7 @@ public:
     /**
         Returns @true if the key exists.
     */
-    static bool Exists();
+    static bool Exists() const;
 
     /**
         Gets the first key.
@@ -91,7 +92,7 @@ public:
 
     /**
         Gets information about the key.
-        
+
         @param pnSubKeys
             The number of subkeys.
         @param pnMaxKeyLen
@@ -102,52 +103,52 @@ public:
             The maximum length of a value.
     */
     bool GetKeyInfo(size_t* pnSubKeys, size_t* pnValues,
-                    size_t* pnMaxValueLen);
+                    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
@@ -160,8 +161,8 @@ 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;
     //@}
 
     /**
@@ -187,3 +188,4 @@ public:
                   const wxMemoryBuffer& buf);
     //@}
 };
+