]> git.saurik.com Git - wxWidgets.git/blob - src/msw/settings.cpp
final sweep over docs - replace & with \&
[wxWidgets.git] / src / msw / settings.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/settings.cpp
3 // Purpose: wxSystemSettingsNative implementation for MSW
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/utils.h"
29 #include "wx/gdicmn.h"
30 #endif
31
32 #include "wx/settings.h"
33
34 #include "wx/msw/private.h"
35
36 #ifndef SPI_GETFLATMENU
37 #define SPI_GETFLATMENU 0x1022
38 #endif
39
40 #include "wx/module.h"
41 #include "wx/fontutil.h"
42
43 #ifdef __WXWINCE__ // for SM_CXCURSOR and SM_CYCURSOR
44 #include "wx/msw/wince/missing.h"
45 #endif // __WXWINCE__
46
47 // ----------------------------------------------------------------------------
48 // private classes
49 // ----------------------------------------------------------------------------
50
51 // the module which is used to clean up wxSystemSettingsNative data (this is a
52 // singleton class so it can't be done in the dtor)
53 class wxSystemSettingsModule : public wxModule
54 {
55 public:
56 virtual bool OnInit();
57 virtual void OnExit();
58
59 private:
60 DECLARE_DYNAMIC_CLASS(wxSystemSettingsModule)
61 };
62
63 // ----------------------------------------------------------------------------
64 // global data
65 // ----------------------------------------------------------------------------
66
67 // the font returned by GetFont(wxSYS_DEFAULT_GUI_FONT): it is created when
68 // GetFont() is called for the first time and deleted by wxSystemSettingsModule
69 static wxFont *gs_fontDefault = NULL;
70
71 // ============================================================================
72 // implementation
73 // ============================================================================
74
75 // TODO: see ::SystemParametersInfo for all sorts of Windows settings.
76 // Different args are required depending on the id. How does this differ
77 // from GetSystemMetric, and should it? Perhaps call it GetSystemParameter
78 // and pass an optional void* arg to get further info.
79 // Should also have SetSystemParameter.
80 // Also implement WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
81
82 // ----------------------------------------------------------------------------
83 // wxSystemSettingsModule
84 // ----------------------------------------------------------------------------
85
86 IMPLEMENT_DYNAMIC_CLASS(wxSystemSettingsModule, wxModule)
87
88 bool wxSystemSettingsModule::OnInit()
89 {
90 return true;
91 }
92
93 void wxSystemSettingsModule::OnExit()
94 {
95 delete gs_fontDefault;
96 gs_fontDefault = NULL;
97 }
98
99 // ----------------------------------------------------------------------------
100 // wxSystemSettingsNative
101 // ----------------------------------------------------------------------------
102
103 // ----------------------------------------------------------------------------
104 // colours
105 // ----------------------------------------------------------------------------
106
107 wxColour wxSystemSettingsNative::GetColour(wxSystemColour index)
108 {
109 // we use 0 as the default value just to avoid compiler warnings, as there
110 // is no invalid colour value we use hasCol as the real indicator of
111 // whether colSys was initialized or not
112 COLORREF colSys = 0;
113 bool hasCol = false;
114
115 // the default colours for the entries after BTNHIGHLIGHT
116 static const COLORREF s_defaultSysColors[] =
117 {
118 0x000000, // 3DDKSHADOW
119 0xdfdfdf, // 3DLIGHT
120 0x000000, // INFOTEXT
121 0xe1ffff, // INFOBK
122
123 0, // filler - no std colour with this index
124
125 // TODO: please fill in the standard values of those, I don't have them
126 0, // HOTLIGHT
127 0, // GRADIENTACTIVECAPTION
128 0, // GRADIENTINACTIVECAPTION
129 0, // MENU
130 0, // MENUBAR (unused)
131 };
132
133 if ( index == wxSYS_COLOUR_LISTBOX )
134 {
135 // there is no standard colour with this index, map to another one
136 index = wxSYS_COLOUR_WINDOW;
137 }
138 else if ( index > wxSYS_COLOUR_BTNHIGHLIGHT )
139 {
140 // the indices before BTNHIGHLIGHT are understood by GetSysColor() in
141 // all Windows version, for the other ones we have to check
142 bool useDefault;
143
144 int verMaj, verMin;
145 wxGetOsVersion(&verMaj, &verMin);
146 if ( verMaj < 4 )
147 {
148 // NT 3.5
149 useDefault = true;
150 }
151 else if ( verMaj == 4 )
152 {
153 // Win95/NT 4.0
154 useDefault = index > wxSYS_COLOUR_INFOBK;
155 }
156 else if ( verMaj == 5 && verMin == 0 )
157 {
158 // Win98/Win2K
159 useDefault = index > wxSYS_COLOUR_GRADIENTINACTIVECAPTION;
160 }
161 else // >= 5.1
162 {
163 // 5.1 is Windows XP
164 useDefault = false;
165 // Determine if we are using flat menus, only then allow wxSYS_COLOUR_MENUBAR
166 if ( index == wxSYS_COLOUR_MENUBAR )
167 {
168 BOOL isFlat ;
169 if ( SystemParametersInfo( SPI_GETFLATMENU , 0 ,&isFlat, 0 ) )
170 {
171 if ( !isFlat )
172 index = wxSYS_COLOUR_MENU ;
173 }
174 }
175 }
176
177 if ( useDefault )
178 {
179 // special handling for MENUBAR colour: we use this in wxToolBar
180 // and wxStatusBar to have correct bg colour under Windows XP
181 // (which uses COLOR_MENUBAR for them) but they should still look
182 // correctly under previous Windows versions as well
183 if ( index == wxSYS_COLOUR_MENUBAR )
184 {
185 index = wxSYS_COLOUR_3DFACE;
186 }
187 else // replace with default colour
188 {
189 unsigned int n = index - wxSYS_COLOUR_BTNHIGHLIGHT;
190
191 wxASSERT_MSG( n < WXSIZEOF(s_defaultSysColors),
192 _T("forgot tp update the default colours array") );
193
194 colSys = s_defaultSysColors[n];
195 hasCol = true;
196 }
197 }
198 }
199
200 if ( !hasCol )
201 {
202 #ifdef __WXWINCE__
203 colSys = ::GetSysColor(index|SYS_COLOR_INDEX_FLAG);
204 #else
205 colSys = ::GetSysColor(index);
206 #endif
207 }
208
209 return wxRGBToColour(colSys);
210 }
211
212 // ----------------------------------------------------------------------------
213 // fonts
214 // ----------------------------------------------------------------------------
215
216 wxFont wxCreateFontFromStockObject(int index)
217 {
218 wxFont font;
219
220 HFONT hFont = (HFONT) ::GetStockObject(index);
221 if ( hFont )
222 {
223 LOGFONT lf;
224 if ( ::GetObject(hFont, sizeof(LOGFONT), &lf) != 0 )
225 {
226 wxNativeFontInfo info;
227 info.lf = lf;
228 // Under MicroWindows we pass the HFONT as well
229 // because it's hard to convert HFONT -> LOGFONT -> HFONT
230 // It's OK to delete stock objects, the delete will be ignored.
231 #ifdef __WXMICROWIN__
232 font.Create(info, (WXHFONT) hFont);
233 #else
234 font.Create(info);
235 #endif
236 }
237 else
238 {
239 wxFAIL_MSG( _T("failed to get LOGFONT") );
240 }
241 }
242 else // GetStockObject() failed
243 {
244 wxFAIL_MSG( _T("stock font not found") );
245 }
246
247 return font;
248 }
249
250 wxFont wxSystemSettingsNative::GetFont(wxSystemFont index)
251 {
252 #ifdef __WXWINCE__
253 // under CE only a single SYSTEM_FONT exists
254 index;
255
256 if ( !gs_fontDefault )
257 {
258 gs_fontDefault = new wxFont(wxCreateFontFromStockObject(SYSTEM_FONT));
259 }
260
261 return *gs_fontDefault;
262 #else // !__WXWINCE__
263 // wxWindow ctor calls GetSystemFont(wxSYS_DEFAULT_GUI_FONT) so we're
264 // called fairly often -- this is why we cache this particular font
265 const bool isDefaultRequested = index == wxSYS_DEFAULT_GUI_FONT;
266 if ( isDefaultRequested )
267 {
268 if ( gs_fontDefault )
269 return *gs_fontDefault;
270 }
271
272 wxFont font = wxCreateFontFromStockObject(index);
273
274 if ( isDefaultRequested )
275 {
276 // if we got here it means we hadn't cached it yet - do now
277 gs_fontDefault = new wxFont(font);
278 }
279
280 return font;
281 #endif // __WXWINCE__/!__WXWINCE__
282 }
283
284 // ----------------------------------------------------------------------------
285 // system metrics/features
286 // ----------------------------------------------------------------------------
287
288 // TODO: some of the "metrics" clearly should be features now that we have
289 // HasFeature()!
290
291 // the conversion table from wxSystemMetric enum to GetSystemMetrics() param
292 //
293 // if the constant is not defined, put -1 in the table to indicate that it is
294 // unknown
295 static const int gs_metricsMap[] =
296 {
297 -1, // wxSystemMetric enums start at 1, so give a dummy value for pos 0.
298 #if defined(__WIN32__) && !defined(__WXWINCE__)
299 SM_CMOUSEBUTTONS,
300 #else
301 -1,
302 #endif
303
304 SM_CXBORDER,
305 SM_CYBORDER,
306 SM_CXCURSOR,
307 SM_CYCURSOR,
308 SM_CXDOUBLECLK,
309 SM_CYDOUBLECLK,
310 #if defined(__WIN32__) && defined(SM_CXDRAG)
311 SM_CXDRAG,
312 SM_CYDRAG,
313 SM_CXEDGE,
314 SM_CYEDGE,
315 #else
316 -1, -1, -1, -1,
317 #endif
318 SM_CXHSCROLL,
319 SM_CYHSCROLL,
320 #ifdef SM_CXHTHUMB
321 SM_CXHTHUMB,
322 #else
323 -1,
324 #endif
325 SM_CXICON,
326 SM_CYICON,
327 SM_CXICONSPACING,
328 SM_CYICONSPACING,
329 #ifdef SM_CXHTHUMB
330 SM_CXMIN,
331 SM_CYMIN,
332 #else
333 -1, -1,
334 #endif
335 SM_CXSCREEN,
336 SM_CYSCREEN,
337
338 #if defined(__WIN32__) && defined(SM_CXSIZEFRAME)
339 SM_CXSIZEFRAME,
340 SM_CYSIZEFRAME,
341 SM_CXSMICON,
342 SM_CYSMICON,
343 #else
344 -1, -1, -1, -1,
345 #endif
346 SM_CYHSCROLL,
347 SM_CXVSCROLL,
348 SM_CXVSCROLL,
349 SM_CYVSCROLL,
350 #ifdef SM_CYVTHUMB
351 SM_CYVTHUMB,
352 #else
353 -1,
354 #endif
355 SM_CYCAPTION,
356 SM_CYMENU,
357 #if defined(__WIN32__) && defined(SM_NETWORK)
358 SM_NETWORK,
359 #else
360 -1,
361 #endif
362 #ifdef SM_PENWINDOWS
363 SM_PENWINDOWS,
364 #else
365 -1,
366 #endif
367 #if defined(__WIN32__) && defined(SM_SHOWSOUNDS)
368 SM_SHOWSOUNDS,
369 #else
370 -1,
371 #endif
372 #ifdef SM_SWAPBUTTON
373 SM_SWAPBUTTON,
374 #else
375 -1
376 #endif
377 };
378
379 // Get a system metric, e.g. scrollbar size
380 int wxSystemSettingsNative::GetMetric(wxSystemMetric index)
381 {
382 #ifdef __WXMICROWIN__
383 // TODO: probably use wxUniv themes functionality
384 return 0;
385 #else // !__WXMICROWIN__
386 wxCHECK_MSG( index > 0 && (size_t)index < WXSIZEOF(gs_metricsMap), 0,
387 _T("invalid metric") );
388
389 int indexMSW = gs_metricsMap[index];
390 if ( indexMSW == -1 )
391 {
392 // not supported under current system
393 return -1;
394 }
395
396 int rc = ::GetSystemMetrics(indexMSW);
397 if ( index == wxSYS_NETWORK_PRESENT )
398 {
399 // only the last bit is significant according to the MSDN
400 rc &= 1;
401 }
402
403 return rc;
404 #endif // __WXMICROWIN__/!__WXMICROWIN__
405 }
406
407 bool wxSystemSettingsNative::HasFeature(wxSystemFeature index)
408 {
409 switch ( index )
410 {
411 case wxSYS_CAN_ICONIZE_FRAME:
412 case wxSYS_CAN_DRAW_FRAME_DECORATIONS:
413 return true;
414
415 default:
416 wxFAIL_MSG( _T("unknown system feature") );
417
418 return false;
419 }
420 }
421
422 // ----------------------------------------------------------------------------
423 // function from wx/msw/wrapcctl.h: there is really no other place for it...
424 // ----------------------------------------------------------------------------
425
426 #if wxUSE_LISTCTRL || wxUSE_TREECTRL
427
428 extern wxFont wxGetCCDefaultFont()
429 {
430 #ifndef __WXWINCE__
431 // under the systems enumerated below (anything released after Win98), the
432 // default font used for the common controls seems to be the desktop font
433 // which is also used for the icon titles and not the stock default GUI
434 // font
435 bool useIconFont;
436 int verMaj, verMin;
437 switch ( wxGetOsVersion(&verMaj, &verMin) )
438 {
439 case wxWIN95:
440 // 4.10 is Win98
441 useIconFont = verMin == 4 && verMin >= 10;
442 break;
443
444 case wxWINDOWS_NT:
445 // 5.0 is Win2k
446 useIconFont = verMaj >= 5;
447 break;
448
449 default:
450 useIconFont = false;
451 }
452
453 if ( useIconFont )
454 {
455 LOGFONT lf;
456 if ( ::SystemParametersInfo
457 (
458 SPI_GETICONTITLELOGFONT,
459 sizeof(lf),
460 &lf,
461 0
462 ) )
463 {
464 return wxFont(wxCreateFontFromLogFont(&lf));
465 }
466 else
467 {
468 wxLogLastError(_T("SystemParametersInfo(SPI_GETICONTITLELOGFONT"));
469 }
470 }
471 #endif // __WXWINCE__
472
473 // fall back to the default font for the normal controls
474 return wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
475 }
476
477 #endif // wxUSE_LISTCTRL || wxUSE_TREECTRL