// Purpose: interface of wxSystemOptions
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
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
appearance but not all fonts are available in this quality,
e.g. the Terminal font in small sizes is not and this option may be
used if wider fonts selection is more important than higher quality.
+ @flag{wince.dialog.real-ok-cancel}
+ The PocketPC guidelines recommend for Ok/Cancel dialogs to use an OK button
+ located inside the caption bar and implement Cancel functionality through
+ Undo outside the dialog.
+ wxDialog::CreateButtonSizer will follow the native behaviour on WinCE but
+ it can be overridden with real wxButtons by setting the option below to 1.
@endFlagTable
@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}
+ This option only has effect for Mac OS X 10.4 and higher.
+ If 1 activates the spell checking in wxTextCtrl.
@endFlagTable
The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.
@library{wxbase}
- @category{misc}
+ @category{cfg}
- @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
- wxSystemOptions::HasOption
+ @see wxSystemSettings
*/
class wxSystemOptions : public wxObject
{