moved old TODO lists to the Wiki: http://www.wxwidgets.org/wiki/index.php/Development...

[wxWidgets.git] / interface / sysopt.h

diff --git a/interface/sysopt.h b/interface/sysopt.h
index 92065538d3077fa136ae893acbb92ec4c4d0a399..1c8286536aad34a06881a661105ebd4f406cde61 100644 (file)
--- a/interface/sysopt.h
+++ b/interface/sysopt.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sysopt.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sysopt.h

-// Purpose:     documentation for wxSystemOptions class
+// Purpose:     interface of wxSystemOptions

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,19 +9,18 @@
 /**
     @class wxSystemOptions
     @wxheader{sysopt.h}
 /**
     @class wxSystemOptions
     @wxheader{sysopt.h}

-    
+

     wxSystemOptions stores option/value pairs that wxWidgets itself or
     applications can use to alter behaviour at run-time. It can be
     used to optimize behaviour that doesn't deserve a distinct API,
     but is still important to be able to configure.
     wxSystemOptions stores option/value pairs that wxWidgets itself or
     applications can use to alter behaviour at run-time. It can be
     used to optimize behaviour that doesn't deserve a distinct API,
     but is still important to be able to configure.

-    
+

     These options are currently recognised by wxWidgets.
     These options are currently recognised by wxWidgets.

-    
+

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

-    
-    @seealso
-    wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
+
+    @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,

     wxSystemOptions::HasOption
 */
 class wxSystemOptions : public wxObject
     wxSystemOptions::HasOption
 */
 class wxSystemOptions : public wxObject


@@ -35,46 +34,45 @@ public:
 
     /**
         Gets an option. The function is case-insensitive to @e name.
 
     /**
         Gets an option. The function is case-insensitive to @e name.

-        

         Returns empty string if the option hasn't been set.
         Returns empty string if the option hasn't been set.

-        
-        @sa SetOption(), GetOptionInt(),
-              HasOption()
+
+        @see SetOption(), GetOptionInt(),
+             HasOption()

     */
     */

-    wxString GetOption(const wxString& name);
+    wxString GetOption(const wxString& name) const;

 
     /**
         Gets an option as an integer. The function is case-insensitive to @e name.
 
     /**
         Gets an option as an integer. The function is case-insensitive to @e name.

-        

         If the option hasn't been set, this function returns 0.
         If the option hasn't been set, this function returns 0.

-        
-        @sa SetOption(), GetOption(),
-              HasOption()
+
+        @see SetOption(), GetOption(),
+             HasOption()

     */
     */

-    int GetOptionInt(const wxString& name);
+    int GetOptionInt(const wxString& name) const;

 
     /**
         Returns @true if the given option is present. The function is
         case-insensitive to @e name.
 
     /**
         Returns @true if the given option is present. The function is
         case-insensitive to @e name.

-        
-        @sa SetOption(), GetOption(),
-              GetOptionInt()
+
+        @see SetOption(), GetOption(),
+             GetOptionInt()

     */
     */

-    bool HasOption(const wxString& name);
+    bool HasOption(const wxString& name) const;

 
     /**
 
     /**

-        Returns @true if the option with the given @e name had been set to 0
+        Returns @true if the option with the given @a name had been set to 0

         value. This is mostly useful for boolean options for which you can't use
         @c GetOptionInt(name) == 0 as this would also be @true if the option
         hadn't been set at all.
     */
         value. This is mostly useful for boolean options for which you can't use
         @c GetOptionInt(name) == 0 as this would also be @true if the option
         hadn't been set at all.
     */

-    bool IsFalse(const wxString& name);
+    bool IsFalse(const wxString& name) const;

 
     //@{
     /**
         Sets an option. The function is case-insensitive to @e name.
     */
     void SetOption(const wxString& name, const wxString& value);
 
     //@{
     /**
         Sets an option. The function is case-insensitive to @e name.
     */
     void SetOption(const wxString& name, const wxString& value);

-        void SetOption(const wxString& name, int value);
+    void SetOption(const wxString& name, int value);

     //@}
 };
     //@}
 };

+