settings.h File Reference


Classes

class  wxSystemSettings
 wxSystemSettings allows the application to ask for details about the system. More...

Enumerations

enum  wxSystemFont {
  wxSYS_OEM_FIXED_FONT = 10,
  wxSYS_ANSI_FIXED_FONT,
  wxSYS_ANSI_VAR_FONT,
  wxSYS_SYSTEM_FONT,
  wxSYS_DEVICE_DEFAULT_FONT,
  wxSYS_DEFAULT_GUI_FONT
}
 Possible values for wxSystemSettings::GetFont() parameter. More...
enum  wxSystemColour {
  wxSYS_COLOUR_SCROLLBAR,
  wxSYS_COLOUR_DESKTOP,
  wxSYS_COLOUR_ACTIVECAPTION,
  wxSYS_COLOUR_INACTIVECAPTION,
  wxSYS_COLOUR_MENU,
  wxSYS_COLOUR_WINDOW,
  wxSYS_COLOUR_WINDOWFRAME,
  wxSYS_COLOUR_MENUTEXT,
  wxSYS_COLOUR_WINDOWTEXT,
  wxSYS_COLOUR_CAPTIONTEXT,
  wxSYS_COLOUR_ACTIVEBORDER,
  wxSYS_COLOUR_INACTIVEBORDER,
  wxSYS_COLOUR_APPWORKSPACE,
  wxSYS_COLOUR_HIGHLIGHT,
  wxSYS_COLOUR_HIGHLIGHTTEXT,
  wxSYS_COLOUR_BTNFACE,
  wxSYS_COLOUR_BTNSHADOW,
  wxSYS_COLOUR_GRAYTEXT,
  wxSYS_COLOUR_BTNTEXT,
  wxSYS_COLOUR_INACTIVECAPTIONTEXT,
  wxSYS_COLOUR_BTNHIGHLIGHT,
  wxSYS_COLOUR_3DDKSHADOW,
  wxSYS_COLOUR_3DLIGHT,
  wxSYS_COLOUR_INFOTEXT,
  wxSYS_COLOUR_INFOBK,
  wxSYS_COLOUR_LISTBOX,
  wxSYS_COLOUR_HOTLIGHT,
  wxSYS_COLOUR_GRADIENTACTIVECAPTION,
  wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
  wxSYS_COLOUR_MENUHILIGHT,
  wxSYS_COLOUR_MENUBAR,
  wxSYS_COLOUR_LISTBOXTEXT,
  wxSYS_COLOUR_BACKGROUND = wxSYS_COLOUR_DESKTOP,
  wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
  wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
  wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  wxSYS_COLOUR_FRAMEBK = wxSYS_COLOUR_BTNFACE
}
 Possible values for wxSystemSettings::GetColour() parameter. More...
enum  wxSystemMetric {
  wxSYS_MOUSE_BUTTONS,
  wxSYS_BORDER_X,
  wxSYS_BORDER_Y,
  wxSYS_CURSOR_X,
  wxSYS_CURSOR_Y,
  wxSYS_DCLICK_X,
  wxSYS_DCLICK_Y,
  wxSYS_DCLICK_MSEC,
  wxSYS_DRAG_X,
  wxSYS_DRAG_Y,
  wxSYS_EDGE_X,
  wxSYS_EDGE_Y,
  wxSYS_HSCROLL_ARROW_X,
  wxSYS_HSCROLL_ARROW_Y,
  wxSYS_HTHUMB_X,
  wxSYS_ICON_X,
  wxSYS_ICON_Y,
  wxSYS_ICONSPACING_X,
  wxSYS_ICONSPACING_Y,
  wxSYS_WINDOWMIN_X,
  wxSYS_WINDOWMIN_Y,
  wxSYS_SCREEN_X,
  wxSYS_SCREEN_Y,
  wxSYS_FRAMESIZE_X,
  wxSYS_FRAMESIZE_Y,
  wxSYS_SMALLICON_X,
  wxSYS_SMALLICON_Y,
  wxSYS_HSCROLL_Y,
  wxSYS_VSCROLL_X,
  wxSYS_VSCROLL_ARROW_X,
  wxSYS_VSCROLL_ARROW_Y,
  wxSYS_VTHUMB_Y,
  wxSYS_CAPTION_Y,
  wxSYS_MENU_Y,
  wxSYS_NETWORK_PRESENT,
  wxSYS_PENWINDOWS_PRESENT,
  wxSYS_SHOW_SOUNDS,
  wxSYS_SWAP_BUTTONS,
  wxSYS_DCLICK_MSEC
}
 Possible values for wxSystemSettings::GetMetric() index parameter. More...
enum  wxSystemFeature {
  wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
  wxSYS_CAN_ICONIZE_FRAME,
  wxSYS_TABLET_PRESENT
}
 Possible values for wxSystemSettings::HasFeature() parameter. More...
enum  wxSystemScreenType {
  wxSYS_SCREEN_NONE = 0,
  wxSYS_SCREEN_TINY,
  wxSYS_SCREEN_PDA,
  wxSYS_SCREEN_SMALL,
  wxSYS_SCREEN_DESKTOP
}
 Values for different screen designs. More...

Enumeration Type Documentation

Possible values for wxSystemSettings::GetColour() parameter.

These values map 1:1 the native values supported by the Windows' GetSysColor function. Note that other ports (other than wxMSW) will try to provide meaningful colours but they usually map the same colour to various wxSYS_COLOUR_* values.

Enumerator:
wxSYS_COLOUR_SCROLLBAR  The scrollbar grey area.
wxSYS_COLOUR_DESKTOP  The desktop colour.
wxSYS_COLOUR_ACTIVECAPTION  Active window caption colour.
wxSYS_COLOUR_INACTIVECAPTION  Inactive window caption colour.
wxSYS_COLOUR_MENU  Menu background colour.
wxSYS_COLOUR_WINDOW  Window background colour.
wxSYS_COLOUR_WINDOWFRAME  Window frame colour.
wxSYS_COLOUR_MENUTEXT  Colour of the text used in the menus.
wxSYS_COLOUR_WINDOWTEXT  Colour of the text used in generic windows.
wxSYS_COLOUR_CAPTIONTEXT  Colour of the text used in captions, size boxes and scrollbar arrow boxes.
wxSYS_COLOUR_ACTIVEBORDER  Active window border colour.
wxSYS_COLOUR_INACTIVEBORDER  Inactive window border colour.
wxSYS_COLOUR_APPWORKSPACE  Background colour for MDI applications.
wxSYS_COLOUR_HIGHLIGHT  Colour of item(s) selected in a control.
wxSYS_COLOUR_HIGHLIGHTTEXT  Colour of the text of item(s) selected in a control.
wxSYS_COLOUR_BTNFACE  Face shading colour on push buttons.
wxSYS_COLOUR_BTNSHADOW  Edge shading colour on push buttons.
wxSYS_COLOUR_GRAYTEXT  Colour of greyed (disabled) text.
wxSYS_COLOUR_BTNTEXT  Colour of the text on push buttons.
wxSYS_COLOUR_INACTIVECAPTIONTEXT  Colour of the text in active captions.
wxSYS_COLOUR_BTNHIGHLIGHT  Highlight colour for buttons.
wxSYS_COLOUR_3DDKSHADOW  Dark shadow colour 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_LISTBOX  Background colour for list-like contols.
wxSYS_COLOUR_HOTLIGHT  Colour for a hyperlink or hot-tracked item.
wxSYS_COLOUR_GRADIENTACTIVECAPTION  Right side colour in the color gradient of an active window's title bar.

wxSYS_COLOUR_ACTIVECAPTION specifies the left side color.

wxSYS_COLOUR_GRADIENTINACTIVECAPTION  Right side colour in the color gradient of an inactive window's title bar.

wxSYS_COLOUR_INACTIVECAPTION specifies the left side color.

wxSYS_COLOUR_MENUHILIGHT  The colour used to highlight menu items when the menu appears as a flat menu.

The highlighted menu item is outlined with wxSYS_COLOUR_HIGHLIGHT.

wxSYS_COLOUR_MENUBAR  The background colour for the menu bar when menus appear as flat menus.

However, wxSYS_COLOUR_MENU continues to specify the background color of the menu popup.

wxSYS_COLOUR_LISTBOXTEXT  Text colour for list-like controls.

Since:
2.9.0
wxSYS_COLOUR_BACKGROUND  Synonym for wxSYS_COLOUR_DESKTOP.
wxSYS_COLOUR_3DFACE  Synonym for wxSYS_COLOUR_BTNFACE.
wxSYS_COLOUR_3DSHADOW  Synonym for wxSYS_COLOUR_BTNSHADOW.
wxSYS_COLOUR_BTNHILIGHT  Synonym for wxSYS_COLOUR_BTNHIGHLIGHT.
wxSYS_COLOUR_3DHIGHLIGHT  Synonym for wxSYS_COLOUR_BTNHIGHLIGHT.
wxSYS_COLOUR_3DHILIGHT  Synonym for wxSYS_COLOUR_BTNHIGHLIGHT.
wxSYS_COLOUR_FRAMEBK  Synonim for wxSYS_COLOUR_BTNFACE.

On wxMSW this colour should be used as the background colour of wxFrames which are used as containers of controls; this is in fact the same colour used for the borders of controls like e.g. wxNotebook or for the background of e.g. wxPanel.

Since:
2.9.0

Possible values for wxSystemSettings::HasFeature() parameter.

Enumerator:
wxSYS_CAN_DRAW_FRAME_DECORATIONS 
wxSYS_CAN_ICONIZE_FRAME 
wxSYS_TABLET_PRESENT 

Possible values for wxSystemSettings::GetFont() parameter.

These values map 1:1 the native values supported by the Windows' GetStockObject function. Note that other ports (other than wxMSW) will try to provide meaningful fonts but they usually map the same font to various wxSYS_*_FONT values.

Enumerator:
wxSYS_OEM_FIXED_FONT  Original equipment manufacturer dependent fixed-pitch font.
wxSYS_ANSI_FIXED_FONT  Windows fixed-pitch (monospaced) font.
wxSYS_ANSI_VAR_FONT  Windows variable-pitch (proportional) font.
wxSYS_SYSTEM_FONT  System font.

By default, the system uses the system font to draw menus, dialog box controls, and text.

wxSYS_DEVICE_DEFAULT_FONT  Device-dependent font (Windows NT and later 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.

Possible values for wxSystemSettings::GetMetric() index parameter.

Enumerator:
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_DCLICK_MSEC  Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated.
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.
wxSYS_DCLICK_MSEC  Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated.

Values for different screen designs.

See wxSystemSettings::GetScreenType().

Enumerator:
wxSYS_SCREEN_NONE  Undefined screen type.
wxSYS_SCREEN_TINY  Tiny screen, less than 320x240.
wxSYS_SCREEN_PDA  PDA screen, 320x240 or more but less than 640x480.
wxSYS_SCREEN_SMALL  Small screen, 640x480 or more but less than 800x600.
wxSYS_SCREEN_DESKTOP  Desktop screen, 800x600 or more.



wxWidgets logo

[ top ]