wxSystemOptions Class Reference
[Application and System configuration]

#include <wx/sysopt.h>

Inheritance diagram for wxSystemOptions:
Inheritance graph
[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.

These options are currently recognised by wxWidgets:

Windows

GTK+

Mac

MGL

Motif

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.



void SetOption (const wxString &name, const wxString &value)
 Sets an option.
void SetOption (const wxString &name, int value)
 Sets an option.

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.

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.

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.

void wxSystemOptions::SetOption ( const wxString name,
int  value 
)

Sets an option.

The function is case-insensitive to name.

void wxSystemOptions::SetOption ( const wxString name,
const wxString value 
)

Sets an option.

The function is case-insensitive to name.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]