Contents Up Previous Next

wxSystemSettings

wxSystemSettings allows the application to ask for details about the system. This can include settings such as standard colours, fonts, and user interface element sizes.

Derived from

wxObject

Include files

<wx/settings.h>

See also

wxFont, wxColour

Members

wxSystemSettings::wxSystemSettings
wxSystemSettings::GetColour
wxSystemSettings::GetFont
wxSystemSettings::GetMetric


wxSystemSettings::wxSystemSettings

wxSystemSettings()

Default constructor. You don't need to create an instance of wxSystemSettings since all of its functions are static.


wxSystemSettings::GetColour

static wxColour GetColour(wxSystemColour index)

Returns a system colour.

index can be one of:

wxSYS_COLOUR_SCROLLBAR The scrollbar grey area.
wxSYS_COLOUR_BACKGROUND The desktop colour.
wxSYS_COLOUR_ACTIVECAPTION Active window caption.
wxSYS_COLOUR_INACTIVECAPTION Inactive window caption.
wxSYS_COLOUR_MENU Menu background.
wxSYS_COLOUR_WINDOW Window background.
wxSYS_COLOUR_WINDOWFRAME Window frame.
wxSYS_COLOUR_MENUTEXT Menu text.
wxSYS_COLOUR_WINDOWTEXT Text in windows.
wxSYS_COLOUR_CAPTIONTEXT Text in caption, size box and scrollbar arrow box.
wxSYS_COLOUR_ACTIVEBORDER Active window border.
wxSYS_COLOUR_INACTIVEBORDER Inactive window border.
wxSYS_COLOUR_APPWORKSPACE Background colour MDI applications.
wxSYS_COLOUR_HIGHLIGHT Item(s) selected in a control.
wxSYS_COLOUR_HIGHLIGHTTEXT Text of item(s) selected in a control.
wxSYS_COLOUR_BTNFACE Face shading on push buttons.
wxSYS_COLOUR_BTNSHADOW Edge shading on push buttons.
wxSYS_COLOUR_GRAYTEXT Greyed (disabled) text.
wxSYS_COLOUR_BTNTEXT Text on push buttons.
wxSYS_COLOUR_INACTIVECAPTIONTEXT Colour of text in active captions.
wxSYS_COLOUR_BTNHIGHLIGHT Highlight colour for buttons (same as wxSYS_COLOUR_3DHILIGHT).
wxSYS_COLOUR_3DDKSHADOW Dark shadow for three-dimensional display elements.
wxSYS_COLOUR_3DLIGHT Light colour for three-dimensional display elements.
wxSYS_COLOUR_INFOTEXT Text colour for tooltip controls.
wxSYS_COLOUR_INFOBK Background colour for tooltip controls.
wxSYS_COLOUR_DESKTOP Same as wxSYS_COLOUR_BACKGROUND.
wxSYS_COLOUR_3DFACE Same as wxSYS_COLOUR_BTNFACE.
wxSYS_COLOUR_3DSHADOW Same as wxSYS_COLOUR_BTNSHADOW.
wxSYS_COLOUR_3DHIGHLIGHT Same as wxSYS_COLOUR_BTNHIGHLIGHT.
wxSYS_COLOUR_3DHILIGHT Same as wxSYS_COLOUR_BTNHIGHLIGHT.
wxSYS_COLOUR_BTNHILIGHT Same as wxSYS_COLOUR_BTNHIGHLIGHT.

wxPython note: This static method is implemented in Python as a standalone function named wxSystemSettings_GetColour


wxSystemSettings::GetFont

static wxFont GetFont(wxSystemFont index)

Returns a system font.

index can be one of:

wxSYS_OEM_FIXED_FONT Original equipment manufacturer dependent fixed-pitch font.
wxSYS_ANSI_FIXED_FONT Windows fixed-pitch font.
wxSYS_ANSI_VAR_FONT Windows variable-pitch (proportional) font.
wxSYS_SYSTEM_FONT System font.
wxSYS_DEVICE_DEFAULT_FONT Device-dependent font (Windows NT only).
wxSYS_DEFAULT_GUI_FONT Default font for user interface objects such as menus and dialog boxes. Note that with modern GUIs nothing guarantees that the same font is used for all GUI elements, so some controls might use a different font by default.

wxPython note: This static method is implemented in Python as a standalone function named wxSystemSettings_GetFont


wxSystemSettings::GetMetric

static int GetMetric(wxSystemMetric index)

Returns the value of a system metric, or -1 if the metric is not supported on the current platform.

index can be one of:

wxSYS_MOUSE_BUTTONS Number of buttons on mouse, or zero if no mouse was installed.
wxSYS_BORDER_X Width of single border.
wxSYS_BORDER_Y Height of single border.
wxSYS_CURSOR_X Width of cursor.
wxSYS_CURSOR_Y Height of cursor.
wxSYS_DCLICK_X Width in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
wxSYS_DCLICK_Y Height in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
wxSYS_DRAG_X Width in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.
wxSYS_DRAG_Y Height in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.
wxSYS_EDGE_X Width of a 3D border, in pixels.
wxSYS_EDGE_Y Height of a 3D border, in pixels.
wxSYS_HSCROLL_ARROW_X Width of arrow bitmap on horizontal scrollbar.
wxSYS_HSCROLL_ARROW_Y Height of arrow bitmap on horizontal scrollbar.
wxSYS_HTHUMB_X Width of horizontal scrollbar thumb.
wxSYS_ICON_X The default width of an icon.
wxSYS_ICON_Y The default height of an icon.
wxSYS_ICONSPACING_X Width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
wxSYS_ICONSPACING_Y Height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
wxSYS_WINDOWMIN_X Minimum width of a window.
wxSYS_WINDOWMIN_Y Minimum height of a window.
wxSYS_SCREEN_X Width of the screen in pixels.
wxSYS_SCREEN_Y Height of the screen in pixels.
wxSYS_FRAMESIZE_X Width of the window frame for a wxTHICK_FRAME window.
wxSYS_FRAMESIZE_Y Height of the window frame for a wxTHICK_FRAME window.
wxSYS_SMALLICON_X Recommended width of a small icon (in window captions, and small icon view).
wxSYS_SMALLICON_Y Recommended height of a small icon (in window captions, and small icon view).
wxSYS_HSCROLL_Y Height of horizontal scrollbar in pixels.
wxSYS_VSCROLL_X Width of vertical scrollbar in pixels.
wxSYS_VSCROLL_ARROW_X Width of arrow bitmap on a vertical scrollbar.
wxSYS_VSCROLL_ARROW_Y Height of arrow bitmap on a vertical scrollbar.
wxSYS_VTHUMB_Y Height of vertical scrollbar thumb.
wxSYS_CAPTION_Y Height of normal caption area.
wxSYS_MENU_Y Height of single-line menu bar.
wxSYS_NETWORK_PRESENT 1 if there is a network present, 0 otherwise.
wxSYS_PENWINDOWS_PRESENT 1 if PenWindows is installed, 0 otherwise.
wxSYS_SHOW_SOUNDS Non-zero if the user requires an application to present information visually in situations where it would otherwise present the information only in audible form; zero otherwise.
wxSYS_SWAP_BUTTONS Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.

wxPython note: This static method is implemented in Python as a standalone function named wxSystemSettings_GetMetric