wxWidgets: wxSystemOptions Class Reference

| Version: 3.0.2

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | List of all members
wxSystemOptions Class Reference
Application and System configuration

`#include <wx/sysopt.h>`

Inheritance diagram for wxSystemOptions:
[legend]

## 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

- 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 wxApp::OnAssertFailure() but setting this option allows to change it without modifying the program code and also applies to asserts which may happen before the wxApp 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), wxToolBar 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 wxCLIP_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 wxStaticBox 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 wxDisplay. 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.
- wince.dialog.real-ok-cancel:
  The PocketPC guidelines recommend for Ok/Cancel dialogs to use an OK button located inside the caption bar and implement Cancel functionality through Undo outside the dialog. wxDialog::CreateButtonSizer will follow the native behaviour on WinCE but it can be overridden with real wxButtons by setting the option below to 1.

# GTK+

- gtk.tlw.can-set-transparent:
  wxTopLevelWindow::CanSetTransparent() method normally tries to detect automatically whether transparency for top level windows is currently supported, however this may sometimes fail and this option allows to override 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 wxBG_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 wxMAC_WINDOW_PLAIN_TRANSITION.
- window-default-variant:
  The default variant used by windows (cast to integer from the wxWindowVariant enum). Also known as wxWINDOW_DEFAULT_VARIANT.
- mac.listctrl.always_use_generic:
  Tells wxListCtrl to use the generic control even when it is capable of using the native control instead. Also known as wxMAC_ALWAYS_USE_GENERIC_LISTCTRL.
- mac.textcontrol-use-spell-checker:
  This option only has effect for Mac OS X 10.4 and higher. If 1 activates the spell checking in wxTextCtrl.
- osx.openfiledialog.always-show-types:
  Per default a wxFileDialog with wxFD_OPEN does not show a types-popup on OSX but allows the selection of files from any of the supported types. Setting this to 1 shows a wxChoice for selection (if there is more than one supported filetype).

# Motif

- motif.largebuttons:
  If 1, uses a bigger default size for wxButtons.

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

##

Library: wxBase
Category: Application and System configuration

See Also
  wxSystemSettings

## Public Member Functions
| wxSystemOptions ()
| Default constructor.
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data.
| wxObject (const wxObject &other)
| Copy ctor.
virtual | ~wxObject ()
| Destructor.
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class.
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj.
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone.
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer.
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data.
void | UnShare ()
| This is the same of AllocExclusive() but this method is public.
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

## 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.

## Additional Inherited Members
Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data.

## 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.

See Also
  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.

See Also
  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.

See Also
  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.