**************** wx.SystemOptions **************** Inheritance diagram for `wx.SystemOptions`: | .. inheritance-diagram:: wx.SystemOptions | Description =========== `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. These options are currently recognised by wxWidgets: **All platforms** ============================================== ============================================================== Option Value ============================================== ============================================================== filesys.no-mimetypesmanager Set to 1 to avoid using the mime types manager in `wx.FileSystemHandler `_. This can cut down loading time when loading an XRC file at startup, for example. 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 ``wx.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 `wx.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.display.directdraw If set to 1, use DirectDraw-based implementation of `wx.Display `_. By default the standard Win32 functions are used. 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. ============================================== ============================================================== **Windows** ============================================== ============================================================== Option Value ============================================== ============================================================== 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 cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver. msw.remap If 1 (the default), `wx.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 ``wx.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 `wx.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.display.directdraw If set to 1, use DirectDraw-based implementation of `wx.Display `_. By default the standard Win32 functions are used. 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. ============================================== ============================================================== **GTK+** ============================================== ============================================================== Option Value ============================================== ============================================================== gtk.window.force-background-colour If 1, the backgrounds of windows with the ``wx.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** ============================================== ============================================================== Option Value ============================================== ============================================================== mac.window-plain-transition If 1, uses a plainer transition when showing a window. window-default-variant The default variant used by windows (cast to integer from the `wx.WindowVariant` enum). Also known as ``wx.WINDOW_DEFAULT_VARIANT``. mac.listctrl.always_use_generic Tells `wx.ListCtrl `_ to use the generic control even when it is capable of using the native control instead. Also knwon as ``wx.MAC_ALWAYS_USE_GENERIC_LISTCTRL``. ============================================== ============================================================== **MGL** ============================================== ============================================================== Option Value ============================================== ============================================================== mgl.aa-threshold Set this integer option to point size below which fonts are not antialiased. Default: 10. mgl.screen-refresh Screen refresh rate in Hz. A reasonable default is used if not specified. ============================================== ============================================================== **Motif** ============================================== ============================================================== Option Value ============================================== ============================================================== motif.largebuttons If 1, uses a bigger default size for `wx.Buttons `_. ============================================== ============================================================== Derived From ^^^^^^^^^^^^^ * `wx.Object `_ Methods Summary ^^^^^^^^^^^^^^^ * `__init__ <#__init__>`_ * `GetOption <#GetOption>`_ * `GetOptionInt <#GetOptionInt>`_ * `HasOption <#HasOption>`_ * `IsFalse <#IsFalse>`_ * `SetOption <#SetOption>`_ * `SetOptionInt <#SetOptionInt>`_ Class API ========= Methods ^^^^^^^ .. method:: __init__() Default constructor. You don't need to create an instance of `wx.SystemOptions` since all of its functions are static. -------- .. method:: 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) | **Returns:** `string` .. seealso:: `SetOption <#SetOption>`_, `GetOptionInt <#GetOptionInt>`_, `HasOption <#HasOption>`_ -------- .. method:: 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) | **Returns:** `int` .. seealso:: `SetOption <#SetOption>`_, `GetOption <#GetOption>`_, `HasOption <#HasOption>`_ -------- .. method:: HasOption(name) Returns ``True`` if the given option is present. The function is case-insensitive to `name`. **Parameters:** * `name` (string) | **Returns:** `bool` .. seealso:: `SetOption <#SetOption>`_, `GetOption <#GetOption>`_, `GetOptionInt <#GetOptionInt>`_ -------- .. method:: 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) | **Returns:** `bool` -------- .. method:: SetOption(name, value) Sets an option. The function is case-insensitive to `name`. **Parameters:** * `name` (string) * `value` (string) -------- .. method:: SetOptionInt(name, value) Sets an option as an integer. The function is case-insensitive to `name`. **Parameters:** * `name` (string) * `value` (int)