Add test for undocumented 0x4D message sent on F1.
[wine] / dlls / user / defdlg.c
1 /*
2  * Default dialog procedure
3  *
4  * Copyright 1993, 1996 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include <stdarg.h>
22
23 #include "windef.h"
24 #include "winbase.h"
25 #include "wingdi.h"
26 #include "wine/winuser16.h"
27 #include "controls.h"
28 #include "win.h"
29 #include "winproc.h"
30 #include "wine/debug.h"
31
32 WINE_DEFAULT_DEBUG_CHANNEL(dialog);
33
34
35 /***********************************************************************
36  *           DEFDLG_GetDlgProc
37  */
38 static WNDPROC DEFDLG_GetDlgProc( HWND hwnd )
39 {
40     WNDPROC ret;
41     WND *wndPtr = WIN_GetPtr( hwnd );
42
43     if (!wndPtr) return 0;
44     if (wndPtr == WND_OTHER_PROCESS)
45     {
46         ERR( "cannot get dlg proc %p from other process\n", hwnd );
47         return 0;
48     }
49     ret = *(WNDPROC *)((char *)wndPtr->wExtra + DWLP_DLGPROC);
50     WIN_ReleasePtr( wndPtr );
51     return ret;
52 }
53
54 /***********************************************************************
55  *           DEFDLG_SetFocus
56  *
57  * Set the focus to a control of the dialog, selecting the text if
58  * the control is an edit dialog.
59  */
60 static void DEFDLG_SetFocus( HWND hwndDlg, HWND hwndCtrl )
61 {
62     HWND hwndPrev = GetFocus();
63
64     if (IsChild( hwndDlg, hwndPrev ))
65     {
66         if (SendMessageW( hwndPrev, WM_GETDLGCODE, 0, 0 ) & DLGC_HASSETSEL)
67             SendMessageW( hwndPrev, EM_SETSEL, -1, 0 );
68     }
69     if (SendMessageW( hwndCtrl, WM_GETDLGCODE, 0, 0 ) & DLGC_HASSETSEL)
70         SendMessageW( hwndCtrl, EM_SETSEL, 0, -1 );
71     SetFocus( hwndCtrl );
72 }
73
74
75 /***********************************************************************
76  *           DEFDLG_SaveFocus
77  */
78 static void DEFDLG_SaveFocus( HWND hwnd )
79 {
80     DIALOGINFO *infoPtr;
81     HWND hwndFocus = GetFocus();
82
83     if (!hwndFocus || !IsChild( hwnd, hwndFocus )) return;
84     if (!(infoPtr = DIALOG_get_info( hwnd, FALSE ))) return;
85     infoPtr->hwndFocus = hwndFocus;
86     /* Remove default button */
87 }
88
89
90 /***********************************************************************
91  *           DEFDLG_RestoreFocus
92  */
93 static void DEFDLG_RestoreFocus( HWND hwnd )
94 {
95     DIALOGINFO *infoPtr;
96
97     if (IsIconic( hwnd )) return;
98     if (!(infoPtr = DIALOG_get_info( hwnd, FALSE ))) return;
99     /* Don't set the focus back to controls if EndDialog is already called.*/
100     if (infoPtr->flags & DF_END) return;
101     if (!IsWindow(infoPtr->hwndFocus) || infoPtr->hwndFocus == hwnd) {
102         /* If no saved focus control exists, set focus to the first visible,
103            non-disabled, WS_TABSTOP control in the dialog */
104         infoPtr->hwndFocus = GetNextDlgTabItem( hwnd, 0, FALSE );
105        if (!IsWindow( infoPtr->hwndFocus )) return;
106     }
107     SetFocus( infoPtr->hwndFocus );
108
109     /* This used to set infoPtr->hwndFocus to NULL for no apparent reason,
110        sometimes losing focus when receiving WM_SETFOCUS messages. */
111 }
112
113
114 /***********************************************************************
115  *           DEFDLG_FindDefButton
116  *
117  * Find the current default push-button.
118  */
119 static HWND DEFDLG_FindDefButton( HWND hwndDlg )
120 {
121     HWND hwndChild, hwndTmp;
122
123     hwndChild = GetWindow( hwndDlg, GW_CHILD );
124     while (hwndChild)
125     {
126         if (SendMessageW( hwndChild, WM_GETDLGCODE, 0, 0 ) & DLGC_DEFPUSHBUTTON)
127             break;
128
129         /* Recurse into WS_EX_CONTROLPARENT controls */
130         if (GetWindowLongW( hwndChild, GWL_EXSTYLE ) & WS_EX_CONTROLPARENT)
131         {
132             LONG dsStyle = GetWindowLongW( hwndChild, GWL_STYLE );
133             if ((dsStyle & WS_VISIBLE) && !(dsStyle & WS_DISABLED) &&
134                 (hwndTmp = DEFDLG_FindDefButton(hwndChild)) != NULL)
135            return hwndTmp;
136         }
137         hwndChild = GetWindow( hwndChild, GW_HWNDNEXT );
138     }
139     return hwndChild;
140 }
141
142
143 /***********************************************************************
144  *           DEFDLG_SetDefId
145  *
146  * Set the default button id.
147  */
148 static BOOL DEFDLG_SetDefId( HWND hwndDlg, DIALOGINFO *dlgInfo, WPARAM wParam)
149 {
150     DWORD dlgcode=0; /* initialize just to avoid a warning */
151     HWND hwndOld, hwndNew = GetDlgItem(hwndDlg, wParam);
152     INT old_id = dlgInfo->idResult;
153
154     dlgInfo->idResult = wParam;
155     if (hwndNew &&
156         !((dlgcode=SendMessageW(hwndNew, WM_GETDLGCODE, 0, 0 ))
157             & (DLGC_UNDEFPUSHBUTTON | DLGC_BUTTON)))
158         return FALSE;  /* Destination is not a push button */
159
160     /* Make sure the old default control is a valid push button ID */
161     hwndOld = GetDlgItem( hwndDlg, old_id );
162     if (!hwndOld || !(SendMessageA( hwndOld, WM_GETDLGCODE, 0, 0) & DLGC_DEFPUSHBUTTON))
163         hwndOld = DEFDLG_FindDefButton( hwndDlg );
164     if (hwndOld && hwndOld != hwndNew)
165         SendMessageA( hwndOld, BM_SETSTYLE, BS_PUSHBUTTON, TRUE );
166
167     if (hwndNew)
168     {
169         if(dlgcode & DLGC_UNDEFPUSHBUTTON)
170             SendMessageA( hwndNew, BM_SETSTYLE, BS_DEFPUSHBUTTON, TRUE );
171     }
172     return TRUE;
173 }
174
175
176 /***********************************************************************
177  *           DEFDLG_SetDefButton
178  *
179  * Set the new default button to be hwndNew.
180  */
181 static BOOL DEFDLG_SetDefButton( HWND hwndDlg, DIALOGINFO *dlgInfo, HWND hwndNew )
182 {
183     DWORD dlgcode=0; /* initialize just to avoid a warning */
184     HWND hwndOld = GetDlgItem( hwndDlg, dlgInfo->idResult );
185
186     if (hwndNew &&
187         !((dlgcode=SendMessageW(hwndNew, WM_GETDLGCODE, 0, 0 ))
188             & (DLGC_UNDEFPUSHBUTTON | DLGC_DEFPUSHBUTTON)))
189     {
190         /**
191          * Need to draw only default push button rectangle.
192          * Since the next control is not a push button, need to draw the push
193          * button rectangle for the default control.
194          */
195         hwndNew = hwndOld;
196         dlgcode = SendMessageW(hwndNew, WM_GETDLGCODE, 0, 0 );
197     }
198
199     /* Make sure the old default control is a valid push button ID */
200     if (!hwndOld || !(SendMessageA( hwndOld, WM_GETDLGCODE, 0, 0) & DLGC_DEFPUSHBUTTON))
201         hwndOld = DEFDLG_FindDefButton( hwndDlg );
202     if (hwndOld && hwndOld != hwndNew)
203         SendMessageA( hwndOld, BM_SETSTYLE, BS_PUSHBUTTON, TRUE );
204
205     if (hwndNew)
206     {
207         if(dlgcode & DLGC_UNDEFPUSHBUTTON)
208             SendMessageA( hwndNew, BM_SETSTYLE, BS_DEFPUSHBUTTON, TRUE );
209     }
210     return TRUE;
211 }
212
213
214 /***********************************************************************
215  *           DEFDLG_Proc
216  *
217  * Implementation of DefDlgProc(). Only handle messages that need special
218  * handling for dialogs.
219  */
220 static LRESULT DEFDLG_Proc( HWND hwnd, UINT msg, WPARAM wParam,
221                             LPARAM lParam, DIALOGINFO *dlgInfo )
222 {
223     switch(msg)
224     {
225         case WM_ERASEBKGND:
226         {
227             HBRUSH brush = (HBRUSH)SendMessageW( hwnd, WM_CTLCOLORDLG, wParam, (LPARAM)hwnd );
228             if (!brush) brush = (HBRUSH)DefWindowProcW( hwnd, WM_CTLCOLORDLG, wParam, (LPARAM)hwnd );
229             if (brush)
230             {
231                 RECT rect;
232                 HDC hdc = (HDC)wParam;
233                 GetClientRect( hwnd, &rect );
234                 DPtoLP( hdc, (LPPOINT)&rect, 2 );
235                 FillRect( hdc, &rect, brush );
236             }
237             return 1;
238         }
239         case WM_NCDESTROY:
240             if ((dlgInfo = (DIALOGINFO *)SetWindowLongPtrW( hwnd, DWLP_WINE_DIALOGINFO, 0 )))
241             {
242                 /* Free dialog heap (if created) */
243                 if (dlgInfo->hDialogHeap)
244                 {
245                     GlobalUnlock16(dlgInfo->hDialogHeap);
246                     GlobalFree16(dlgInfo->hDialogHeap);
247                 }
248                 if (dlgInfo->hUserFont) DeleteObject( dlgInfo->hUserFont );
249                 if (dlgInfo->hMenu) DestroyMenu( dlgInfo->hMenu );
250                 HeapFree( GetProcessHeap(), 0, dlgInfo );
251             }
252               /* Window clean-up */
253             return DefWindowProcA( hwnd, msg, wParam, lParam );
254
255         case WM_SHOWWINDOW:
256             if (!wParam) DEFDLG_SaveFocus( hwnd );
257             return DefWindowProcA( hwnd, msg, wParam, lParam );
258
259         case WM_ACTIVATE:
260             if (wParam) DEFDLG_RestoreFocus( hwnd );
261             else DEFDLG_SaveFocus( hwnd );
262             return 0;
263
264         case WM_SETFOCUS:
265             DEFDLG_RestoreFocus( hwnd );
266             return 0;
267
268         case DM_SETDEFID:
269             if (dlgInfo && !(dlgInfo->flags & DF_END))
270                 DEFDLG_SetDefId( hwnd, dlgInfo, wParam );
271             return 1;
272
273         case DM_GETDEFID:
274             if (dlgInfo && !(dlgInfo->flags & DF_END))
275             {
276                 HWND hwndDefId;
277                 if (dlgInfo->idResult)
278                     return MAKELONG( dlgInfo->idResult, DC_HASDEFID );
279                 if ((hwndDefId = DEFDLG_FindDefButton( hwnd )))
280                     return MAKELONG( GetDlgCtrlID( hwndDefId ), DC_HASDEFID);
281             }
282             return 0;
283
284         case WM_NEXTDLGCTL:
285             if (dlgInfo)
286             {
287                 HWND hwndDest = (HWND)wParam;
288                 if (!lParam)
289                     hwndDest = GetNextDlgTabItem(hwnd, GetFocus(), wParam);
290                 if (hwndDest) DEFDLG_SetFocus( hwnd, hwndDest );
291                 DEFDLG_SetDefButton( hwnd, dlgInfo, hwndDest );
292             }
293             return 0;
294
295         case WM_ENTERMENULOOP:
296         case WM_LBUTTONDOWN:
297         case WM_NCLBUTTONDOWN:
298             {
299                 HWND hwndFocus = GetFocus();
300                 if (hwndFocus)
301                 {
302                     /* always make combo box hide its listbox control */
303                     if (!SendMessageA( hwndFocus, CB_SHOWDROPDOWN, FALSE, 0 ))
304                         SendMessageA( GetParent(hwndFocus), CB_SHOWDROPDOWN, FALSE, 0 );
305                 }
306             }
307             return DefWindowProcA( hwnd, msg, wParam, lParam );
308
309         case WM_GETFONT:
310             return dlgInfo ? (LRESULT)dlgInfo->hUserFont : 0;
311
312         case WM_CLOSE:
313             PostMessageA( hwnd, WM_COMMAND, MAKEWPARAM(IDCANCEL, BN_CLICKED),
314                             (LPARAM)GetDlgItem( hwnd, IDCANCEL ) );
315             return 0;
316
317         case WM_NOTIFYFORMAT:
318             return DefWindowProcA( hwnd, msg, wParam, lParam );
319     }
320     return 0;
321 }
322
323 /***********************************************************************
324  *           DEFDLG_Epilog
325  */
326 static LRESULT DEFDLG_Epilog(HWND hwnd, UINT msg, BOOL fResult)
327 {
328     /* see SDK 3.1 */
329
330     if ((msg >= WM_CTLCOLORMSGBOX && msg <= WM_CTLCOLORSTATIC) ||
331          msg == WM_CTLCOLOR || msg == WM_COMPAREITEM ||
332          msg == WM_VKEYTOITEM || msg == WM_CHARTOITEM ||
333          msg == WM_QUERYDRAGICON || msg == WM_INITDIALOG)
334         return fResult;
335
336     return GetWindowLongPtrW( hwnd, DWLP_MSGRESULT );
337 }
338
339 /***********************************************************************
340 *               DIALOG_get_info
341 *
342 * Get the DIALOGINFO structure of a window, allocating it if needed
343 * and 'create' is TRUE.
344 */
345 DIALOGINFO *DIALOG_get_info( HWND hwnd, BOOL create )
346 {
347     WND* wndPtr;
348     DIALOGINFO* dlgInfo = (DIALOGINFO *)GetWindowLongPtrW( hwnd, DWLP_WINE_DIALOGINFO );
349
350     if(!dlgInfo && create)
351     {
352         if (!(dlgInfo = HeapAlloc( GetProcessHeap(), 0, sizeof(*dlgInfo) ))) return NULL;
353         dlgInfo->hwndFocus   = 0;
354         dlgInfo->hUserFont   = 0;
355         dlgInfo->hMenu       = 0;
356         dlgInfo->xBaseUnit   = 0;
357         dlgInfo->yBaseUnit   = 0;
358         dlgInfo->idResult    = 0;
359         dlgInfo->flags       = 0;
360         dlgInfo->hDialogHeap = 0;
361         wndPtr = WIN_GetPtr( hwnd );
362         if (wndPtr && wndPtr != WND_OTHER_PROCESS && wndPtr != WND_DESKTOP)
363         {
364             wndPtr->flags |= WIN_ISDIALOG;
365             WIN_ReleasePtr( wndPtr );
366             SetWindowLongPtrW( hwnd, DWLP_WINE_DIALOGINFO, (ULONG_PTR)dlgInfo );
367         }
368         else
369         {
370             HeapFree( GetProcessHeap(), 0, dlgInfo );
371             return NULL;
372         }
373     }
374     return dlgInfo;
375 }
376
377 /***********************************************************************
378  *              DefDlgProc (USER.308)
379  */
380 LRESULT WINAPI DefDlgProc16( HWND16 hwnd, UINT16 msg, WPARAM16 wParam,
381                              LPARAM lParam )
382 {
383     DIALOGINFO *dlgInfo;
384     WNDPROC16 dlgproc;
385     HWND hwnd32 = WIN_Handle32( hwnd );
386     BOOL result = FALSE;
387
388     /* Perform DIALOGINFO intialization if not done */
389     if(!(dlgInfo = DIALOG_get_info(hwnd32, TRUE))) return -1;
390
391     SetWindowLongPtrW( hwnd32, DWLP_MSGRESULT, 0 );
392
393     if ((dlgproc = (WNDPROC16)DEFDLG_GetDlgProc( hwnd32 )))
394     {
395         /* Call dialog procedure */
396         result = CallWindowProc16( dlgproc, hwnd, msg, wParam, lParam );
397         /* 16 bit dlg procs only return BOOL16 */
398         if( WINPROC_GetProcType( (WNDPROC)dlgproc ) == WIN_PROC_16 )
399             result = LOWORD(result);
400     }
401
402     if (!result && IsWindow(hwnd32))
403     {
404         /* callback didn't process this message */
405
406         switch(msg)
407         {
408             case WM_ERASEBKGND:
409             case WM_SHOWWINDOW:
410             case WM_ACTIVATE:
411             case WM_SETFOCUS:
412             case DM_SETDEFID:
413             case DM_GETDEFID:
414             case WM_NEXTDLGCTL:
415             case WM_GETFONT:
416             case WM_CLOSE:
417             case WM_NCDESTROY:
418             case WM_ENTERMENULOOP:
419             case WM_LBUTTONDOWN:
420             case WM_NCLBUTTONDOWN:
421                 return DEFDLG_Proc( hwnd32, msg, (WPARAM)wParam, lParam, dlgInfo );
422             case WM_INITDIALOG:
423             case WM_VKEYTOITEM:
424             case WM_COMPAREITEM:
425             case WM_CHARTOITEM:
426                 break;
427
428             default:
429                 return DefWindowProc16( hwnd, msg, wParam, lParam );
430         }
431     }
432     return DEFDLG_Epilog( hwnd32, msg, result);
433 }
434
435
436 /***********************************************************************
437  *              DefDlgProcA (USER32.@)
438  */
439 LRESULT WINAPI DefDlgProcA( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam )
440 {
441     DIALOGINFO *dlgInfo;
442     WNDPROC dlgproc;
443     BOOL result = FALSE;
444
445     /* Perform DIALOGINFO initialization if not done */
446     if(!(dlgInfo = DIALOG_get_info( hwnd, TRUE ))) return -1;
447
448     SetWindowLongPtrW( hwnd, DWLP_MSGRESULT, 0 );
449
450     if ((dlgproc = DEFDLG_GetDlgProc( hwnd )))
451     {
452         /* Call dialog procedure */
453         result = CallWindowProcA( dlgproc, hwnd, msg, wParam, lParam );
454         /* 16 bit dlg procs only return BOOL16 */
455         if( WINPROC_GetProcType( dlgproc ) == WIN_PROC_16 )
456             result = LOWORD(result);
457     }
458
459     if (!result && IsWindow(hwnd))
460     {
461         /* callback didn't process this message */
462
463         switch(msg)
464         {
465             case WM_ERASEBKGND:
466             case WM_SHOWWINDOW:
467             case WM_ACTIVATE:
468             case WM_SETFOCUS:
469             case DM_SETDEFID:
470             case DM_GETDEFID:
471             case WM_NEXTDLGCTL:
472             case WM_GETFONT:
473             case WM_CLOSE:
474             case WM_NCDESTROY:
475             case WM_ENTERMENULOOP:
476             case WM_LBUTTONDOWN:
477             case WM_NCLBUTTONDOWN:
478                  return DEFDLG_Proc( hwnd, msg, wParam, lParam, dlgInfo );
479             case WM_INITDIALOG:
480             case WM_VKEYTOITEM:
481             case WM_COMPAREITEM:
482             case WM_CHARTOITEM:
483                  break;
484
485             default:
486                  return DefWindowProcA( hwnd, msg, wParam, lParam );
487         }
488     }
489     return DEFDLG_Epilog(hwnd, msg, result);
490 }
491
492
493 /***********************************************************************
494  *              DefDlgProcW (USER32.@)
495  */
496 LRESULT WINAPI DefDlgProcW( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam )
497 {
498     DIALOGINFO *dlgInfo;
499     BOOL result = FALSE;
500     WNDPROC dlgproc;
501
502     /* Perform DIALOGINFO intialization if not done */
503     if(!(dlgInfo = DIALOG_get_info( hwnd, TRUE ))) return -1;
504
505     SetWindowLongPtrW( hwnd, DWLP_MSGRESULT, 0 );
506
507     if ((dlgproc = DEFDLG_GetDlgProc( hwnd )))
508     {
509         /* Call dialog procedure */
510         result = CallWindowProcW( dlgproc, hwnd, msg, wParam, lParam );
511         /* 16 bit dlg procs only return BOOL16 */
512         if( WINPROC_GetProcType( dlgproc ) == WIN_PROC_16 )
513             result = LOWORD(result);
514     }
515
516     if (!result && IsWindow(hwnd))
517     {
518         /* callback didn't process this message */
519
520         switch(msg)
521         {
522             case WM_ERASEBKGND:
523             case WM_SHOWWINDOW:
524             case WM_ACTIVATE:
525             case WM_SETFOCUS:
526             case DM_SETDEFID:
527             case DM_GETDEFID:
528             case WM_NEXTDLGCTL:
529             case WM_GETFONT:
530             case WM_CLOSE:
531             case WM_NCDESTROY:
532             case WM_ENTERMENULOOP:
533             case WM_LBUTTONDOWN:
534             case WM_NCLBUTTONDOWN:
535                  return DEFDLG_Proc( hwnd, msg, wParam, lParam, dlgInfo );
536             case WM_INITDIALOG:
537             case WM_VKEYTOITEM:
538             case WM_COMPAREITEM:
539             case WM_CHARTOITEM:
540                  break;
541
542             default:
543                  return DefWindowProcW( hwnd, msg, wParam, lParam );
544         }
545     }
546     return DEFDLG_Epilog(hwnd, msg, result);
547 }