Class: Wx::SystemOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/system_options.rb

Overview

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 SystemOptions.set_option 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 App#get_app_name). 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 “_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

  • 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 App#on_assert_failure but setting this option allows changing it without modifying the program code and also applies to asserts which may happen before the App object creation or after its destruction.

Windows

  • no-maskblt: 1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0. In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using DC caching. By default, MaskBlt will be used where it is implemented by the operating system and driver.

  • msw.remap: If 1 (the default), ToolBar bitmap colours will be remapped to the current theme's values. Set this to 0 to disable this functionality, for example if you're using more than 16 colours in your tool bitmaps.

  • msw.window.no-clip-children: If 1, windows will not automatically get the WS_CLIPCHILDREN style. This restores the way windows are refreshed back to the method used in versions of wxWidgets earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may still specify CLIP_CHILDREN for individual windows.

  • msw.notebook.themed-background: If set to 0, globally disables themed backgrounds on notebook pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no pages).

  • msw.staticbox.optimized-paint: If set to 0, switches off optimized StaticBox painting. Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box (the optimized refresh causes any such drawing to disappear).

  • msw.font.no-proof-quality: If set to 1, use default fonts quality instead of proof quality when creating fonts. With proof quality the fonts have slightly better 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.

  • msw.native-dialogs-pmdpi: Some native win32 dialogs (like the font and colour pickers) are not per-monitor DPI aware, and wxWidgets will forcefully show them as system DPI aware when there are monitors with different DPI connected. If set to 1, these dialogs will always be shown as per-monitor DPI aware (when enabled in the manifest).

GTK+

  • gtk.tlw.can-set-transparent: TopLevelWindow#can_set_transparent method normally tries to detect automatically whether transparency for top level windows is currently supported, however this may sometimes fail and this option allows overriding the automatic detection. Setting it to 1 makes the transparency be always available (setting it can still fail, of course) and setting it to 0 makes it always unavailable.

  • gtk.desktop: This option can be set to override the default desktop environment determination. Supported values are GNOME and KDE.

  • gtk.window.force-background-colour: If 1, the backgrounds of windows with the BackgroundStyle::BG_STYLE_COLOUR background style are cleared forcibly instead of relying on the underlying GTK+ window colour. This works around a display problem when running applications under KDE with the gtk-qt theme installed (0.6 and below).

Mac

  • mac.window-plain-transition: If 1, uses a plainer transition when showing a window. You can also use the symbol MAC_WINDOW_PLAIN_TRANSITION.

  • window-default-variant: The default variant used by windows (cast to integer from the WindowVariant enum). Also known as WINDOW_DEFAULT_VARIANT.

  • mac.textcontrol-use-spell-checker: If 1 activates the spell checking in TextCtrl.

  • osx.openfiledialog.always-show-types: Per default a FileDialog with FD_OPEN does not show a types-popup on macOS but allows the selection of files from any of the supported types. Setting this to 1 shows a Choice for selection (if there is more than one supported filetype).

Motif

  • motif.largebuttons: If 1, uses a bigger default size for Buttons.

The compile-time option to include or exclude this functionality is Wx::Setup::USE_SYSTEM_OPTIONS.

Category: Application and System configuration

See Also:

Requires:

  • USE_SYSTEM_OPTIONS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::SystemOptions

Default constructor.

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



87
 
# File 'lib/wx/doc/gen/system_options.rb', line 87

def initialize; end

Class Method Details

.get_option(name) ⇒ String

Gets an option.

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

Parameters:

  • name (String)

Returns:

  • (String)

See Also:



97
 
# File 'lib/wx/doc/gen/system_options.rb', line 97

def self.get_option(name) end

.get_option_int(name) ⇒ Integer

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)

Returns:

  • (Integer)

See Also:



107
 
# File 'lib/wx/doc/gen/system_options.rb', line 107

def self.get_option_int(name) end

.has_option(name) ⇒ Boolean

Returns true if the given option is present.

The function is case-insensitive to name.

Parameters:

  • name (String)

Returns:

  • (Boolean)

See Also:



117
 
# File 'lib/wx/doc/gen/system_options.rb', line 117

def self.has_option(name) end

.is_false(name) ⇒ Boolean

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)

Returns:

  • (Boolean) 


124
 
# File 'lib/wx/doc/gen/system_options.rb', line 124

def self.is_false(name) end

.self.set_option(name, value) ⇒ void .self.set_option(name, value) ⇒ void

Overloads:

  • .self.set_option(name, value) ⇒ void

    This method returns an undefined value.

    Sets an option.

    The function is case-insensitive to name.

    Parameters:

    • name (String)
    • value (String)
  • .self.set_option(name, value) ⇒ void

    This method returns an undefined value.

    Sets an option.

    The function is case-insensitive to name.

    Parameters:

    • name (String)
    • value (Integer) 


81
 
# File 'lib/wx/doc/gen/system_options.rb', line 81

def self.set_option(*args) end