A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://wxpython.org/Phoenix/docs/html/wx.SystemOptions.html below:

wx.SystemOptions — wxPython Phoenix 4.2.4a1 documentation

wx.SystemOptions¶

wx.SystemOptions 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 _option to set the given option for all wxWidgets applications or _appname_option to set it just for the application with the given name (as returned by wx.App.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 USE_SYSTEM_OPTIONS.

Class Hierarchy¶

Inheritance diagram for class

SystemOptions

:

Methods Summary¶ Class API¶
class wx.SystemOptions(Object)¶

Possible constructors:

SystemOptions stores option/value pairs that wxWidgets itself or applications can use to alter behaviour at run-time.


Methods¶
__init__(self)¶

Default constructor.

You don’t need to create an instance of wx.SystemOptions since all of its functions are static.

Return type:

None


static GetOption(name)¶

Gets an option.

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

Parameters:

name (string)

Return type:

str


static GetOptionInt(name)¶

Gets an option as an integer.

The function is case-insensitive to name. If the option hasn’t been set, this function returns 0.

Parameters:

name (string)

Return type:

int


static HasOption(name)¶

Returns True if the given option is present.

The function is case-insensitive to name.

Parameters:

name (string)

Return type:

bool


static IsFalse(name)¶

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.

Parameters:

name (string)

Return type:

bool


static SetOption(*args, **kw)¶

Sets an option.

The function is case-insensitive to name.

Overloaded Implementations:

SetOption (name, value)

Parameters:
  • name (string)

  • value (string)

Return type:

None

SetOption (name, value)

Parameters:
  • name (string)

  • value (int)

Return type:

None



RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4