added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/sysopt.h

@@ -0,0 +1,80 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        sysopt.h
+// Purpose:     documentation for wxSystemOptions class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @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.
+    
+    These options are currently recognised by wxWidgets.
+    
+    @library{wxbase}
+    @category{misc}
+    
+    @seealso
+    wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
+    wxSystemOptions::HasOption
+*/
+class wxSystemOptions : public wxObject
+{
+public:
+    /**
+        Default constructor. You don't need to create an instance of wxSystemOptions
+        since all of its functions are static.
+    */
+    wxSystemOptions();
+
+    /**
+        Gets an option. The function is case-insensitive to @e name.
+        
+        Returns empty string if the option hasn't been set.
+        
+        @sa SetOption(), GetOptionInt(),
+              HasOption()
+    */
+    wxString GetOption(const wxString& 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.
+        
+        @sa SetOption(), GetOption(),
+              HasOption()
+    */
+    int GetOptionInt(const wxString& name);
+
+    /**
+        Returns @true if the given option is present. The function is
+        case-insensitive to @e name.
+        
+        @sa SetOption(), GetOption(),
+              GetOptionInt()
+    */
+    bool HasOption(const wxString& name);
+
+    /**
+        Returns @true if the option with the given @e 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.
+    */
+    bool IsFalse(const wxString& name);
+
+    //@{
+    /**
+        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);
+    //@}
+};