Version: 2.9.4
Public Member Functions | Static Public Member Functions
wxSystemOptions Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/sysopt.h>

Inheritance diagram for wxSystemOptions:

Detailed Description

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:

All platforms

Windows

GTK+

Mac

Motif

The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.

Library:  wxBase
Category:  Application and System configuration
参照:
wxSystemSettings

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.

List of all members.


Constructor & Destructor Documentation

wxSystemOptions::wxSystemOptions ( )

Default constructor.

You don't need to create an instance of wxSystemOptions since all of its functions are static.


Member Function Documentation

static wxString wxSystemOptions::GetOption ( const wxString name) [static]

Gets an option.

The function is case-insensitive to name. Returns empty string if the option hasn't been set.

参照:
SetOption(), GetOptionInt(), HasOption()
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.

参照:
SetOption(), GetOption(), HasOption()
static bool wxSystemOptions::HasOption ( const wxString name) [static]

Returns true if the given option is present.

The function is case-insensitive to name.

参照:
SetOption(), GetOption(), GetOptionInt()
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.

static void wxSystemOptions::SetOption ( const wxString name,
const wxString value 
) [static]

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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines