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