#include </home/zeitlin/src/wx/github/interface/wx/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.
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 wx_option
to set the given option for all wxWidgets applications or 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:
The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.
Public Member Functions | |
wxSystemOptions () | |
Default constructor. | |
Static Public Member Functions | |
static wxString | GetOption (const wxString &name) |
Gets an option. | |
static int | GetOptionInt (const wxString &name) |
Gets an option as an integer. | |
static bool | HasOption (const wxString &name) |
Returns true if the given option is present. | |
static bool | IsFalse (const wxString &name) |
Returns true if the option with the given name had been set to 0 value. | |
static void | SetOption (const wxString &name, const wxString &value) |
Sets an option. | |
static void | SetOption (const wxString &name, int value) |
Sets an option. |
wxSystemOptions::wxSystemOptions | ( | ) |
Default constructor.
You don't need to create an instance of wxSystemOptions since all of its functions are static.
Gets an option.
The function is case-insensitive to name. Returns empty string if the option hasn't been set.
static int wxSystemOptions::GetOptionInt | ( | const wxString & | name | ) | [static] |
Gets an option as an integer.
The function is case-insensitive to name. If the option hasn't been set, this function returns 0.
static bool wxSystemOptions::HasOption | ( | const wxString & | name | ) | [static] |
Returns true if the given option is present.
The function is case-insensitive to name.
static bool wxSystemOptions::IsFalse | ( | const wxString & | name | ) | [static] |
Returns true if the option with the given name had been set to 0 value.
This is mostly useful for boolean options for which you can't use GetOptionInt(name)
== 0 as this would also be true if the option hadn't been set at all.
Sets an option.
The function is case-insensitive to name.
static void wxSystemOptions::SetOption | ( | const wxString & | name, |
int | value | ||
) | [static] |
Sets an option.
The function is case-insensitive to name.