X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec5984e358c24f98cb690736fdb8e07dd4706ae3..a5655d37db9baabce654849fd66173f95f74e230:/interface/wx/sysopt.h

diff --git a/interface/wx/sysopt.h b/interface/wx/sysopt.h
index ec08a7d28a..069b1c6ef8 100644
--- a/interface/wx/sysopt.h
+++ b/interface/wx/sysopt.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxSystemOptions
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -14,8 +14,31 @@
     used to optimize behaviour that doesn't deserve a distinct API,
     but is still important to be able to configure.
 
+    System options can be set by the program itself using SetOption() method
+    and they also can be set from the program environment by defining an
+    environment variable @c wx_option to set the given option for all wxWidgets
+    applications or @c wx_appname_option to set it just for the application
+    with the given name (as returned by wxApp::GetAppName()). Notice that any
+    characters not allowed in the environment variables names, such as periods
+    and dashes, should be replaced with underscores. E.g. to define a system
+    option "foo-bar" you need to define the environment variable "wx_foo_bar".
+
+    The program may use system options for its own needs but they are mostly
+    used to control the behaviour of wxWidgets library itself.
+
     These options are currently recognised by wxWidgets:
 
+    @section sysopt_all All platforms
+
+    @beginFlagTable
+    @flag{exit-on-assert}
+        If set to non-zero value, abort the program if an assertion fails. The
+        default behaviour in case of assertion failure depends on the build mode
+        and can be changed by overriding wxApp::OnAssertFailure() but setting
+        this option allows to change it without modifying the program code and
+        also applies to asserts which may happen before the wxApp object
+        creation or after its destruction.
+    @endFlagTable
 
     @section sysopt_win Windows
 
@@ -92,10 +115,10 @@
     @flag{window-default-variant}
         The default variant used by windows (cast to integer from the wxWindowVariant enum).
         Also known as wxWINDOW_DEFAULT_VARIANT.
-    flag{mac.listctrl.always_use_generic}
+    @flag{mac.listctrl.always_use_generic}
         Tells wxListCtrl to use the generic control even when it is capable of
         using the native control instead. Also knwon as wxMAC_ALWAYS_USE_GENERIC_LISTCTRL.
-    flag{mac.textcontrol-use-spell-checker}
+    @flag{mac.textcontrol-use-spell-checker}
         This option only has effect for Mac OS X 10.4 and higher.
         If 1 activates the spell checking in wxTextCtrl.
     @endFlagTable
@@ -122,7 +145,7 @@
     The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see wxSystemSettings
 */