projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxSystemSettings}}\label{wxsystemsettings} |
| 2 | ||
| 3 | wxSystemSettings allows the application to ask for details about | |
| 4 | the system. This can include settings such as standard colours, fonts, | |
| 5 | and user interface element sizes. | |
| 6 | ||
| 7 | \wxheading{Derived from} | |
| 8 | ||
| 9 | \helpref{wxObject}{wxobject} | |
| 10 | ||
| 11 | \wxheading{See also} | |
| 12 | ||
| 13 | \helpref{wxFont}{wxfont}, \helpref{wxColour}{wxcolour} | |
| 14 | ||
| 15 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 16 | ||
| 17 | \membersection{wxSystemSettings::wxSystemSettings} | |
| 18 | ||
| 19 | \func{}{wxSystemSettings}{\void} | |
| 20 | ||
| 21 | Default constructor. You don't need to create an instance of wxSystemSettings | |
| 22 | since all of its functions are static. | |
| 23 | ||
| 24 | \membersection{wxSystemSettings::GetSystemColour}\label{wxsystemsettingsgetsystemcolour} | |
| 25 | ||
| 26 | \func{static wxColour}{GetSystemColour}{\param{int}{ index}} | |
| 27 | ||
| 28 | Returns a system colour. | |
| 29 | ||
| 30 | {\it index} can be one of: | |
| 31 | ||
| 32 | \twocolwidtha{7cm} | |
| 33 | \begin{twocollist}\itemsep=0pt | |
| 34 | \twocolitem{{\bf wxSYS\_COLOUR\_SCROLLBAR}}{The scrollbar grey area.} | |
| 35 | \twocolitem{{\bf wxSYS\_COLOUR\_BACKGROUND}}{The desktop colour.} | |
| 36 | \twocolitem{{\bf wxSYS\_COLOUR\_ACTIVECAPTION}}{Active window caption.} | |
| 37 | \twocolitem{{\bf wxSYS\_COLOUR\_INACTIVECAPTION}}{Inactive window caption.} | |
| 38 | \twocolitem{{\bf wxSYS\_COLOUR\_MENU}}{Menu background.} | |
| 39 | \twocolitem{{\bf wxSYS\_COLOUR\_WINDOW}}{Window background.} | |
| 40 | \twocolitem{{\bf wxSYS\_COLOUR\_WINDOWFRAME}}{Window frame.} | |
| 41 | \twocolitem{{\bf wxSYS\_COLOUR\_MENUTEXT}}{Menu text.} | |
| 42 | \twocolitem{{\bf wxSYS\_COLOUR\_WINDOWTEXT}}{Text in windows.} | |
| 43 | \twocolitem{{\bf wxSYS\_COLOUR\_CAPTIONTEXT}}{Text in caption, size box and scrollbar arrow box.} | |
| 44 | \twocolitem{{\bf wxSYS\_COLOUR\_ACTIVEBORDER}}{Active window border.} | |
| 45 | \twocolitem{{\bf wxSYS\_COLOUR\_INACTIVEBORDER}}{Inactive window border.} | |
| 46 | \twocolitem{{\bf wxSYS\_COLOUR\_APPWORKSPACE}}{Background colour MDI applications.} | |
| 47 | \twocolitem{{\bf wxSYS\_COLOUR\_HIGHLIGHT}}{Item(s) selected in a control.} | |
| 48 | \twocolitem{{\bf wxSYS\_COLOUR\_HIGHLIGHTTEXT}}{Text of item(s) selected in a control.} | |
| 49 | \twocolitem{{\bf wxSYS\_COLOUR\_BTNFACE}}{Face shading on push buttons.} | |
| 50 | \twocolitem{{\bf wxSYS\_COLOUR\_BTNSHADOW}}{Edge shading on push buttons.} | |
| 51 | \twocolitem{{\bf wxSYS\_COLOUR\_GRAYTEXT}}{Greyed (disabled) text.} | |
| 52 | \twocolitem{{\bf wxSYS\_COLOUR\_BTNTEXT}}{Text on push buttons.} | |
| 53 | \twocolitem{{\bf wxSYS\_COLOUR\_INACTIVECAPTIONTEXT}}{Colour of text in active captions.} | |
| 54 | \twocolitem{{\bf wxSYS\_COLOUR\_BTNHIGHLIGHT}}{Highlight colour for buttons (same as wxSYS\_COLOUR\_3DHILIGHT).} | |
| 55 | \twocolitem{{\bf wxSYS\_COLOUR\_3DDKSHADOW}}{Dark shadow for three-dimensional dispaly elements.} | |
| 56 | \twocolitem{{\bf wxSYS\_COLOUR\_3DLIGHT}}{Light colour for three-dimensional display elements.} | |
| 57 | \twocolitem{{\bf wxSYS\_COLOUR\_INFOTEXT}}{Text colour for tooltip controls.} | |
| 58 | \twocolitem{{\bf wxSYS\_COLOUR\_INFOBK}}{Background colour for tooltip controls.} | |
| 59 | \twocolitem{{\bf wxSYS\_COLOUR\_DESKTOP}}{Same as wxSYS\_COLOUR\_BACKGROUND.} | |
| 60 | \twocolitem{{\bf wxSYS\_COLOUR\_3DFACE}}{Same as wxSYS\_COLOUR\_BTNFACE.} | |
| 61 | \twocolitem{{\bf wxSYS\_COLOUR\_3DSHADOW}}{Same as wxSYS\_COLOUR\_BTNSHADOW.} | |
| 62 | \twocolitem{{\bf wxSYS\_COLOUR\_3DHIGHLIGHT}}{Same as wxSYS\_COLOUR\_BTNHIGHLIGHT.} | |
| 63 | \twocolitem{{\bf wxSYS\_COLOUR\_3DHILIGHT}}{Same as wxSYS\_COLOUR\_BTNHIGHLIGHT.} | |
| 64 | \twocolitem{{\bf wxSYS\_COLOUR\_BTNHILIGHT}}{Same as wxSYS\_COLOUR\_BTNHIGHLIGHT.} | |
| 65 | \end{twocollist} | |
| 66 | ||
| 67 | \membersection{wxSystemSettings::GetSystemFont}\label{wxsystemsettingsgetsystemfont} | |
| 68 | ||
| 69 | \func{static wxFont}{GetSystemFont}{\param{int}{ index}} | |
| 70 | ||
| 71 | Returns a system font. | |
| 72 | ||
| 73 | {\it index} can be one of: | |
| 74 | ||
| 75 | \twocolwidtha{7cm} | |
| 76 | \begin{twocollist}\itemsep=0pt | |
| 77 | \twocolitem{{\bf wxSYS\_OEM\_FIXED\_FONT}}{Original equipment manufacturer dependent fixed-pitch font.} | |
| 78 | \twocolitem{{\bf wxSYS\_ANSI\_FIXED\_FONT}}{Windows fixed-pitch font.} | |
| 79 | \twocolitem{{\bf wxSYS\_ANSI\_VAR\_FONT}}{Windows variable-pitch (proportional) font.} | |
| 80 | \twocolitem{{\bf wxSYS\_SYSTEM\_FONT}}{System font.} | |
| 81 | \twocolitem{{\bf wxSYS\_DEVICE\_DEFAULT\_FONT}}{Device-dependent font (Windows NT only).} | |
| 82 | \twocolitem{{\bf wxSYS\_DEFAULT\_GUI\_FONT}}{Default font for user interface objects such as menus and dialog boxes. | |
| 83 | Not available in versions of Windows earlier than Windows 95 or Windows NT 4.0.} | |
| 84 | \end{twocollist} | |
| 85 | ||
| 86 | \membersection{wxSystemSettings::GetSystemMetric}\label{wxsystemsettingsgetsystemmetric} | |
| 87 | ||
| 88 | \func{static int}{GetSystemMetric}{\param{int}{ index}} | |
| 89 | ||
| 90 | Returns a system metric. | |
| 91 | ||
| 92 | {\it index} can be one of: | |
| 93 | ||
| 94 | \twocolwidtha{7cm} | |
| 95 | \begin{twocollist}\itemsep=0pt | |
| 96 | \twocolitem{{\bf wxSYS\_MOUSE\_BUTTONS}}{Number of buttons on mouse, or zero if no mouse was installed.} | |
| 97 | \twocolitem{{\bf wxSYS\_BORDER\_X}}{Width of single border.} | |
| 98 | \twocolitem{{\bf wxSYS\_BORDER\_Y}}{Height of single border.} | |
| 99 | \twocolitem{{\bf wxSYS\_CURSOR\_X}}{Width of cursor.} | |
| 100 | \twocolitem{{\bf wxSYS\_CURSOR\_Y}}{Height of cursor.} | |
| 101 | \twocolitem{{\bf wxSYS\_DCLICK\_X}}{Width in pixels of rectangle within which two successive mouse | |
| 102 | clicks must fall to generate a double-click.} | |
| 103 | \twocolitem{{\bf wxSYS\_DCLICK\_Y}}{Height in pixels of rectangle within which two successive mouse | |
| 104 | clicks must fall to generate a double-click.} | |
| 105 | \twocolitem{{\bf wxSYS\_DRAG\_X}}{Width in pixels of a rectangle centered on a drag point | |
| 106 | to allow for limited movement of the mouse pointer before a drag operation begins.} | |
| 107 | \twocolitem{{\bf wxSYS\_DRAG\_Y}}{Height in pixels of a rectangle centered on a drag point | |
| 108 | to allow for limited movement of the mouse pointer before a drag operation begins.} | |
| 109 | \twocolitem{{\bf wxSYS\_EDGE\_X}}{Width of a 3D border, in pixels. } | |
| 110 | \twocolitem{{\bf wxSYS\_EDGE\_Y}}{Height of a 3D border, in pixels. } | |
| 111 | \twocolitem{{\bf wxSYS\_HSCROLL\_ARROW\_X}}{Width of arrow bitmap on horizontal scrollbar.} | |
| 112 | \twocolitem{{\bf wxSYS\_HSCROLL\_ARROW\_Y}}{Height of arrow bitmap on horizontal scrollbar.} | |
| 113 | \twocolitem{{\bf wxSYS\_HTHUMB\_X}}{Width of horizontal scrollbar thumb.} | |
| 114 | \twocolitem{{\bf wxSYS\_ICON\_X}}{The default width of an icon.} | |
| 115 | \twocolitem{{\bf wxSYS\_ICON\_Y}}{The default height of an icon.} | |
| 116 | \twocolitem{{\bf wxSYS\_ICONSPACING\_X}}{Width of a grid cell for items in large icon view, | |
| 117 | in pixels. Each item fits into a rectangle of this size when arranged.} | |
| 118 | \twocolitem{{\bf wxSYS\_ICONSPACING\_Y}}{Height of a grid cell for items in large icon view, | |
| 119 | in pixels. Each item fits into a rectangle of this size when arranged.} | |
| 120 | \twocolitem{{\bf wxSYS\_WINDOWMIN\_X}}{Minimum width of a window.} | |
| 121 | \twocolitem{{\bf wxSYS\_WINDOWMIN\_Y}}{Minimum height of a window.} | |
| 122 | \twocolitem{{\bf wxSYS\_SCREEN\_X}}{Width of the screen in pixels.} | |
| 123 | \twocolitem{{\bf wxSYS\_SCREEN\_Y}}{Height of the screen in pixels.} | |
| 124 | \twocolitem{{\bf wxSYS\_FRAMESIZE\_X}}{Width of the window frame for a wxTHICK\_FRAME window.} | |
| 125 | \twocolitem{{\bf wxSYS\_FRAMESIZE\_Y}}{Height of the window frame for a wxTHICK\_FRAME window.} | |
| 126 | \twocolitem{{\bf wxSYS\_SMALLICON\_X}}{Recommended width of a small icon (in window captions, and small icon view).} | |
| 127 | \twocolitem{{\bf wxSYS\_SMALLICON\_Y}}{Recommended height of a small icon (in window captions, and small icon view).} | |
| 128 | \twocolitem{{\bf wxSYS\_HSCROLL\_Y}}{Height of horizontal scrollbar in pixels.} | |
| 129 | \twocolitem{{\bf wxSYS\_VSCROLL\_X}}{Width of vertical scrollbar in pixels.} | |
| 130 | \twocolitem{{\bf wxSYS\_VSCROLL\_ARROW\_X}}{Width of arrow bitmap on a vertical scrollbar.} | |
| 131 | \twocolitem{{\bf wxSYS\_VSCROLL\_ARROW\_Y}}{Height of arrow bitmap on a vertical scrollbar.} | |
| 132 | \twocolitem{{\bf wxSYS\_VTHUMB\_Y}}{Height of vertical scrollbar thumb.} | |
| 133 | \twocolitem{{\bf wxSYS\_CAPTION\_Y}}{Height of normal caption area.} | |
| 134 | \twocolitem{{\bf wxSYS\_MENU\_Y}}{Height of single-line menu bar.} | |
| 135 | \twocolitem{{\bf wxSYS\_NETWORK\_PRESENT}}{1 if there is a network present, 0 otherwise.} | |
| 136 | \twocolitem{{\bf wxSYS\_PENWINDOWS\_PRESENT}}{1 if PenWindows is installed, 0 otherwise.} | |
| 137 | \twocolitem{{\bf wxSYS\_SHOW\_SOUNDS}}{Non-zero if the user requires an application to present information visually in situations | |
| 138 | where it would otherwise present the information only in audible form; zero otherwise.} | |
| 139 | \twocolitem{{\bf wxSYS\_SWAP\_BUTTONS}}{Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.} | |
| 140 | \end{twocollist} | |
| 141 |