gdi32: Printer drivers don't use the character extra spacing if lpdx is supplied.
[wine] / dlls / user32 / button.c
1 /* File: button.c -- Button type widgets
2  *
3  * Copyright (C) 1993 Johannes Ruscheinski
4  * Copyright (C) 1993 David Metcalfe
5  * Copyright (C) 1994 Alexandre Julliard
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  *
21  * NOTES
22  *
23  * This code was audited for completeness against the documented features
24  * of Comctl32.dll version 6.0 on Oct. 3, 2004, by Dimitrie O. Paun.
25  * 
26  * Unless otherwise noted, we believe this code to be complete, as per
27  * the specification mentioned above.
28  * If you discover missing features, or bugs, please note them below.
29  * 
30  * TODO
31  *  Styles
32  *  - BS_NOTIFY: is it complete?
33  *  - BS_RIGHTBUTTON: same as BS_LEFTTEXT
34  *
35  *  Messages
36  *  - WM_CHAR: Checks a (manual or automatic) check box on '+' or '=', clears it on '-' key.
37  *  - WM_SETFOCUS: For (manual or automatic) radio buttons, send the parent window BN_CLICKED
38  *  - WM_NCCREATE: Turns any BS_OWNERDRAW button into a BS_PUSHBUTTON button.
39  *  - WM_SYSKEYUP
40  *  - BCM_GETIDEALSIZE
41  *  - BCM_GETIMAGELIST
42  *  - BCM_GETTEXTMARGIN
43  *  - BCM_SETIMAGELIST
44  *  - BCM_SETTEXTMARGIN
45  *  
46  *  Notifications
47  *  - BCN_HOTITEMCHANGE
48  *  - BN_DISABLE
49  *  - BN_PUSHED/BN_HILITE
50  *  + BN_KILLFOCUS: is it OK?
51  *  - BN_PAINT
52  *  + BN_SETFOCUS: is it OK?
53  *  - BN_UNPUSHED/BN_UNHILITE
54  *  - NM_CUSTOMDRAW
55  *
56  *  Structures/Macros/Definitions
57  *  - BUTTON_IMAGELIST
58  *  - NMBCHOTITEM
59  *  - Button_GetIdealSize
60  *  - Button_GetImageList
61  *  - Button_GetTextMargin
62  *  - Button_SetImageList
63  *  - Button_SetTextMargin
64  */
65
66 #include <stdarg.h>
67 #include <string.h>
68 #include <stdlib.h>
69
70 #define OEMRESOURCE
71
72 #include "windef.h"
73 #include "winbase.h"
74 #include "wingdi.h"
75 #include "controls.h"
76 #include "win.h"
77 #include "user_private.h"
78 #include "wine/debug.h"
79
80 WINE_DEFAULT_DEBUG_CHANNEL(button);
81
82 /* GetWindowLong offsets for window extra information */
83 #define STATE_GWL_OFFSET  0
84 #define HFONT_GWL_OFFSET  (sizeof(LONG))
85 #define HIMAGE_GWL_OFFSET (HFONT_GWL_OFFSET+sizeof(HFONT))
86 #define NB_EXTRA_BYTES    (HIMAGE_GWL_OFFSET+sizeof(HANDLE))
87
88 /* undocumented flags */
89 #define BUTTON_NSTATES         0x0F
90 #define BUTTON_BTNPRESSED      0x40
91 #define BUTTON_UNKNOWN2        0x20
92 #define BUTTON_UNKNOWN3        0x10
93
94 #define BUTTON_NOTIFY_PARENT(hWnd, code) \
95     do { /* Notify parent which has created this button control */ \
96         TRACE("notification " #code " sent to hwnd=%p\n", GetParent(hWnd)); \
97         SendMessageW(GetParent(hWnd), WM_COMMAND, \
98                      MAKEWPARAM(GetWindowLongPtrW((hWnd),GWLP_ID), (code)), \
99                      (LPARAM)(hWnd)); \
100     } while(0)
101
102 static UINT BUTTON_CalcLabelRect( HWND hwnd, HDC hdc, RECT *rc );
103 static void PB_Paint( HWND hwnd, HDC hDC, UINT action );
104 static void CB_Paint( HWND hwnd, HDC hDC, UINT action );
105 static void GB_Paint( HWND hwnd, HDC hDC, UINT action );
106 static void UB_Paint( HWND hwnd, HDC hDC, UINT action );
107 static void OB_Paint( HWND hwnd, HDC hDC, UINT action );
108 static void BUTTON_CheckAutoRadioButton( HWND hwnd );
109
110 #define MAX_BTN_TYPE  16
111
112 static const WORD maxCheckState[MAX_BTN_TYPE] =
113 {
114     BST_UNCHECKED,      /* BS_PUSHBUTTON */
115     BST_UNCHECKED,      /* BS_DEFPUSHBUTTON */
116     BST_CHECKED,        /* BS_CHECKBOX */
117     BST_CHECKED,        /* BS_AUTOCHECKBOX */
118     BST_CHECKED,        /* BS_RADIOBUTTON */
119     BST_INDETERMINATE,  /* BS_3STATE */
120     BST_INDETERMINATE,  /* BS_AUTO3STATE */
121     BST_UNCHECKED,      /* BS_GROUPBOX */
122     BST_UNCHECKED,      /* BS_USERBUTTON */
123     BST_CHECKED,        /* BS_AUTORADIOBUTTON */
124     BST_UNCHECKED,      /* BS_PUSHBOX */
125     BST_UNCHECKED       /* BS_OWNERDRAW */
126 };
127
128 typedef void (*pfPaint)( HWND hwnd, HDC hdc, UINT action );
129
130 static const pfPaint btnPaintFunc[MAX_BTN_TYPE] =
131 {
132     PB_Paint,    /* BS_PUSHBUTTON */
133     PB_Paint,    /* BS_DEFPUSHBUTTON */
134     CB_Paint,    /* BS_CHECKBOX */
135     CB_Paint,    /* BS_AUTOCHECKBOX */
136     CB_Paint,    /* BS_RADIOBUTTON */
137     CB_Paint,    /* BS_3STATE */
138     CB_Paint,    /* BS_AUTO3STATE */
139     GB_Paint,    /* BS_GROUPBOX */
140     UB_Paint,    /* BS_USERBUTTON */
141     CB_Paint,    /* BS_AUTORADIOBUTTON */
142     NULL,        /* BS_PUSHBOX */
143     OB_Paint     /* BS_OWNERDRAW */
144 };
145
146 static HBITMAP hbitmapCheckBoxes = 0;
147 static WORD checkBoxWidth = 0, checkBoxHeight = 0;
148
149
150 /*********************************************************************
151  * button class descriptor
152  */
153 static const WCHAR buttonW[] = {'B','u','t','t','o','n',0};
154 const struct builtin_class_descr BUTTON_builtin_class =
155 {
156     buttonW,             /* name */
157     CS_DBLCLKS | CS_VREDRAW | CS_HREDRAW | CS_PARENTDC, /* style  */
158     WINPROC_BUTTON,      /* proc */
159     NB_EXTRA_BYTES,      /* extra */
160     IDC_ARROW,           /* cursor */
161     0                    /* brush */
162 };
163
164
165 static inline LONG get_button_state( HWND hwnd )
166 {
167     return GetWindowLongW( hwnd, STATE_GWL_OFFSET );
168 }
169
170 static inline void set_button_state( HWND hwnd, LONG state )
171 {
172     SetWindowLongW( hwnd, STATE_GWL_OFFSET, state );
173 }
174
175 static inline HFONT get_button_font( HWND hwnd )
176 {
177     return (HFONT)GetWindowLongPtrW( hwnd, HFONT_GWL_OFFSET );
178 }
179
180 static inline void set_button_font( HWND hwnd, HFONT font )
181 {
182     SetWindowLongPtrW( hwnd, HFONT_GWL_OFFSET, (LONG_PTR)font );
183 }
184
185 static inline UINT get_button_type( LONG window_style )
186 {
187     return (window_style & BS_TYPEMASK);
188 }
189
190 /* paint a button of any type */
191 static inline void paint_button( HWND hwnd, LONG style, UINT action )
192 {
193     if (btnPaintFunc[style] && IsWindowVisible(hwnd))
194     {
195         HDC hdc = GetDC( hwnd );
196         btnPaintFunc[style]( hwnd, hdc, action );
197         ReleaseDC( hwnd, hdc );
198     }
199 }
200
201 /* retrieve the button text; returned buffer must be freed by caller */
202 static inline WCHAR *get_button_text( HWND hwnd )
203 {
204     INT len = 512;
205     WCHAR *buffer = HeapAlloc( GetProcessHeap(), 0, (len + 1) * sizeof(WCHAR) );
206     if (buffer) InternalGetWindowText( hwnd, buffer, len + 1 );
207     return buffer;
208 }
209
210 /***********************************************************************
211  *           ButtonWndProc_common
212  */
213 LRESULT ButtonWndProc_common(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL unicode )
214 {
215     RECT rect;
216     POINT pt;
217     LONG style = GetWindowLongW( hWnd, GWL_STYLE );
218     UINT btn_type = get_button_type( style );
219     LONG state;
220     HANDLE oldHbitmap;
221
222     if (!IsWindow( hWnd )) return 0;
223
224     pt.x = (short)LOWORD(lParam);
225     pt.y = (short)HIWORD(lParam);
226
227     switch (uMsg)
228     {
229     case WM_GETDLGCODE:
230         switch(btn_type)
231         {
232         case BS_USERBUTTON:
233         case BS_PUSHBUTTON:      return DLGC_BUTTON | DLGC_UNDEFPUSHBUTTON;
234         case BS_DEFPUSHBUTTON:   return DLGC_BUTTON | DLGC_DEFPUSHBUTTON;
235         case BS_RADIOBUTTON:
236         case BS_AUTORADIOBUTTON: return DLGC_BUTTON | DLGC_RADIOBUTTON;
237         case BS_GROUPBOX:        return DLGC_STATIC;
238         default:                 return DLGC_BUTTON;
239         }
240
241     case WM_ENABLE:
242         paint_button( hWnd, btn_type, ODA_DRAWENTIRE );
243         break;
244
245     case WM_CREATE:
246         if (!hbitmapCheckBoxes)
247         {
248             BITMAP bmp;
249             hbitmapCheckBoxes = LoadBitmapW(0, MAKEINTRESOURCEW(OBM_CHECKBOXES));
250             GetObjectW( hbitmapCheckBoxes, sizeof(bmp), &bmp );
251             checkBoxWidth  = bmp.bmWidth / 4;
252             checkBoxHeight = bmp.bmHeight / 3;
253         }
254         if (btn_type >= MAX_BTN_TYPE)
255             return -1; /* abort */
256
257         /* XP turns a BS_USERBUTTON into BS_PUSHBUTTON */
258         if (btn_type == BS_USERBUTTON )
259         {
260             style = (style & ~BS_TYPEMASK) | BS_PUSHBUTTON;
261             WIN_SetStyle( hWnd, style, BS_TYPEMASK & ~style );
262         }
263         set_button_state( hWnd, BST_UNCHECKED );
264         return 0;
265
266     case WM_ERASEBKGND:
267         if (btn_type == BS_OWNERDRAW)
268         {
269             HDC hdc = (HDC)wParam;
270             RECT rc;
271             HBRUSH hBrush;
272             HWND parent = GetParent(hWnd);
273             if (!parent) parent = hWnd;
274             hBrush = (HBRUSH)SendMessageW(parent, WM_CTLCOLORBTN, (WPARAM)hdc, (LPARAM)hWnd);
275             if (!hBrush) /* did the app forget to call defwindowproc ? */
276                 hBrush = (HBRUSH)DefWindowProcW(parent, WM_CTLCOLORBTN,
277                                                 (WPARAM)hdc, (LPARAM)hWnd);
278             GetClientRect(hWnd, &rc);
279             FillRect(hdc, &rc, hBrush);
280         }
281         return 1;
282
283     case WM_PRINTCLIENT:
284     case WM_PAINT:
285         if (btnPaintFunc[btn_type])
286         {
287             PAINTSTRUCT ps;
288             HDC hdc = wParam ? (HDC)wParam : BeginPaint( hWnd, &ps );
289             int nOldMode = SetBkMode( hdc, OPAQUE );
290             (btnPaintFunc[btn_type])( hWnd, hdc, ODA_DRAWENTIRE );
291             SetBkMode(hdc, nOldMode); /*  reset painting mode */
292             if( !wParam ) EndPaint( hWnd, &ps );
293         }
294         break;
295
296     case WM_KEYDOWN:
297         if (wParam == VK_SPACE)
298         {
299             SendMessageW( hWnd, BM_SETSTATE, TRUE, 0 );
300             set_button_state( hWnd, get_button_state( hWnd ) | BUTTON_BTNPRESSED );
301             SetCapture( hWnd );
302         }
303         break;
304
305     case WM_LBUTTONDBLCLK:
306         if(style & BS_NOTIFY ||
307            btn_type == BS_RADIOBUTTON ||
308            btn_type == BS_USERBUTTON ||
309            btn_type == BS_OWNERDRAW)
310         {
311             BUTTON_NOTIFY_PARENT(hWnd, BN_DOUBLECLICKED);
312             break;
313         }
314         /* fall through */
315     case WM_LBUTTONDOWN:
316         SetCapture( hWnd );
317         SetFocus( hWnd );
318         set_button_state( hWnd, get_button_state( hWnd ) | BUTTON_BTNPRESSED );
319         SendMessageW( hWnd, BM_SETSTATE, TRUE, 0 );
320         break;
321
322     case WM_KEYUP:
323         if (wParam != VK_SPACE)
324             break;
325         /* fall through */
326     case WM_LBUTTONUP:
327         state = get_button_state( hWnd );
328         if (!(state & BUTTON_BTNPRESSED)) break;
329         state &= BUTTON_NSTATES;
330         set_button_state( hWnd, state );
331         if (!(state & BST_PUSHED))
332         {
333             ReleaseCapture();
334             break;
335         }
336         SendMessageW( hWnd, BM_SETSTATE, FALSE, 0 );
337         ReleaseCapture();
338         GetClientRect( hWnd, &rect );
339         if (uMsg == WM_KEYUP || PtInRect( &rect, pt ))
340         {
341             state = get_button_state( hWnd );
342             switch(btn_type)
343             {
344             case BS_AUTOCHECKBOX:
345                 SendMessageW( hWnd, BM_SETCHECK, !(state & BST_CHECKED), 0 );
346                 break;
347             case BS_AUTORADIOBUTTON:
348                 SendMessageW( hWnd, BM_SETCHECK, TRUE, 0 );
349                 break;
350             case BS_AUTO3STATE:
351                 SendMessageW( hWnd, BM_SETCHECK,
352                                 (state & BST_INDETERMINATE) ? 0 : ((state & 3) + 1), 0 );
353                 break;
354             }
355             BUTTON_NOTIFY_PARENT(hWnd, BN_CLICKED);
356         }
357         break;
358
359     case WM_CAPTURECHANGED:
360         TRACE("WM_CAPTURECHANGED %p\n", hWnd);
361         state = get_button_state( hWnd );
362         if (state & BUTTON_BTNPRESSED)
363         {
364             state &= BUTTON_NSTATES;
365             set_button_state( hWnd, state );
366             if (state & BST_PUSHED) SendMessageW( hWnd, BM_SETSTATE, FALSE, 0 );
367         }
368         break;
369
370     case WM_MOUSEMOVE:
371         if ((wParam & MK_LBUTTON) && GetCapture() == hWnd)
372         {
373             GetClientRect( hWnd, &rect );
374             SendMessageW( hWnd, BM_SETSTATE, PtInRect(&rect, pt), 0 );
375         }
376         break;
377
378     case WM_SETTEXT:
379     {
380         /* Clear an old text here as Windows does */
381         HDC hdc = GetDC(hWnd);
382         HBRUSH hbrush;
383         RECT client, rc;
384         HWND parent = GetParent(hWnd);
385
386         if (!parent) parent = hWnd;
387         hbrush = (HBRUSH)SendMessageW(parent, WM_CTLCOLORSTATIC,
388                                       (WPARAM)hdc, (LPARAM)hWnd);
389         if (!hbrush) /* did the app forget to call DefWindowProc ? */
390             hbrush = (HBRUSH)DefWindowProcW(parent, WM_CTLCOLORSTATIC,
391                                             (WPARAM)hdc, (LPARAM)hWnd);
392
393         GetClientRect(hWnd, &client);
394         rc = client;
395         BUTTON_CalcLabelRect(hWnd, hdc, &rc);
396         /* Clip by client rect bounds */
397         if (rc.right > client.right) rc.right = client.right;
398         if (rc.bottom > client.bottom) rc.bottom = client.bottom;
399         FillRect(hdc, &rc, hbrush);
400         ReleaseDC(hWnd, hdc);
401
402         if (unicode) DefWindowProcW( hWnd, WM_SETTEXT, wParam, lParam );
403         else DefWindowProcA( hWnd, WM_SETTEXT, wParam, lParam );
404         if (btn_type == BS_GROUPBOX) /* Yes, only for BS_GROUPBOX */
405             InvalidateRect( hWnd, NULL, TRUE );
406         else
407             paint_button( hWnd, btn_type, ODA_DRAWENTIRE );
408         return 1; /* success. FIXME: check text length */
409     }
410
411     case WM_SETFONT:
412         set_button_font( hWnd, (HFONT)wParam );
413         if (lParam) InvalidateRect(hWnd, NULL, TRUE);
414         break;
415
416     case WM_GETFONT:
417         return (LRESULT)get_button_font( hWnd );
418
419     case WM_SETFOCUS:
420         TRACE("WM_SETFOCUS %p\n",hWnd);
421         set_button_state( hWnd, get_button_state(hWnd) | BST_FOCUS );
422         paint_button( hWnd, btn_type, ODA_FOCUS );
423         if (style & BS_NOTIFY)
424             BUTTON_NOTIFY_PARENT(hWnd, BN_SETFOCUS);
425         break;
426
427     case WM_KILLFOCUS:
428         TRACE("WM_KILLFOCUS %p\n",hWnd);
429         state = get_button_state( hWnd );
430         set_button_state( hWnd, state & ~BST_FOCUS );
431         paint_button( hWnd, btn_type, ODA_FOCUS );
432
433         if ((state & BUTTON_BTNPRESSED) && GetCapture() == hWnd)
434             ReleaseCapture();
435         if (style & BS_NOTIFY)
436             BUTTON_NOTIFY_PARENT(hWnd, BN_KILLFOCUS);
437
438         InvalidateRect( hWnd, NULL, FALSE );
439         break;
440
441     case WM_SYSCOLORCHANGE:
442         InvalidateRect( hWnd, NULL, FALSE );
443         break;
444
445     case BM_SETSTYLE:
446         if ((wParam & BS_TYPEMASK) >= MAX_BTN_TYPE) break;
447         btn_type = wParam & BS_TYPEMASK;
448         style = (style & ~BS_TYPEMASK) | btn_type;
449         WIN_SetStyle( hWnd, style, BS_TYPEMASK & ~style );
450
451         /* Only redraw if lParam flag is set.*/
452         if (lParam)
453             InvalidateRect( hWnd, NULL, TRUE );
454
455         break;
456
457     case BM_CLICK:
458         SendMessageW( hWnd, WM_LBUTTONDOWN, 0, 0 );
459         SendMessageW( hWnd, WM_LBUTTONUP, 0, 0 );
460         break;
461
462     case BM_SETIMAGE:
463         /* Check that image format matches button style */
464         switch (style & (BS_BITMAP|BS_ICON))
465         {
466         case BS_BITMAP:
467             if (wParam != IMAGE_BITMAP) return 0;
468             break;
469         case BS_ICON:
470             if (wParam != IMAGE_ICON) return 0;
471             break;
472         default:
473             return 0;
474         }
475         oldHbitmap = (HBITMAP)SetWindowLongPtrW( hWnd, HIMAGE_GWL_OFFSET, lParam );
476         InvalidateRect( hWnd, NULL, FALSE );
477         return (LRESULT)oldHbitmap;
478
479     case BM_GETIMAGE:
480         return GetWindowLongPtrW( hWnd, HIMAGE_GWL_OFFSET );
481
482     case BM_GETCHECK:
483         return get_button_state( hWnd ) & 3;
484
485     case BM_SETCHECK:
486         if (wParam > maxCheckState[btn_type]) wParam = maxCheckState[btn_type];
487         state = get_button_state( hWnd );
488         if ((btn_type == BS_RADIOBUTTON) || (btn_type == BS_AUTORADIOBUTTON))
489         {
490             if (wParam) WIN_SetStyle( hWnd, WS_TABSTOP, 0 );
491             else WIN_SetStyle( hWnd, 0, WS_TABSTOP );
492         }
493         if ((state & 3) != wParam)
494         {
495             set_button_state( hWnd, (state & ~3) | wParam );
496             paint_button( hWnd, btn_type, ODA_SELECT );
497         }
498         if ((btn_type == BS_AUTORADIOBUTTON) && (wParam == BST_CHECKED) && (style & WS_CHILD))
499             BUTTON_CheckAutoRadioButton( hWnd );
500         break;
501
502     case BM_GETSTATE:
503         return get_button_state( hWnd );
504
505     case BM_SETSTATE:
506         state = get_button_state( hWnd );
507         if (wParam)
508             set_button_state( hWnd, state | BST_PUSHED );
509         else
510             set_button_state( hWnd, state & ~BST_PUSHED );
511
512         paint_button( hWnd, btn_type, ODA_SELECT );
513         break;
514
515     case WM_NCHITTEST:
516         if(btn_type == BS_GROUPBOX) return HTTRANSPARENT;
517         /* fall through */
518     default:
519         return unicode ? DefWindowProcW(hWnd, uMsg, wParam, lParam) :
520                          DefWindowProcA(hWnd, uMsg, wParam, lParam);
521     }
522     return 0;
523 }
524
525 /**********************************************************************
526  * Convert button styles to flags used by DrawText.
527  */
528 static UINT BUTTON_BStoDT( DWORD style, DWORD ex_style )
529 {
530    UINT dtStyle = DT_NOCLIP;  /* We use SelectClipRgn to limit output */
531
532    /* "Convert" pushlike buttons to pushbuttons */
533    if (style & BS_PUSHLIKE)
534       style &= ~BS_TYPEMASK;
535
536    if (!(style & BS_MULTILINE))
537       dtStyle |= DT_SINGLELINE;
538    else
539       dtStyle |= DT_WORDBREAK;
540
541    switch (style & BS_CENTER)
542    {
543       case BS_LEFT:   /* DT_LEFT is 0 */    break;
544       case BS_RIGHT:  dtStyle |= DT_RIGHT;  break;
545       case BS_CENTER: dtStyle |= DT_CENTER; break;
546       default:
547          /* Pushbutton's text is centered by default */
548          if (get_button_type(style) <= BS_DEFPUSHBUTTON) dtStyle |= DT_CENTER;
549          /* all other flavours have left aligned text */
550    }
551
552    if (ex_style & WS_EX_RIGHT) dtStyle = DT_RIGHT | (dtStyle & ~(DT_LEFT | DT_CENTER));
553
554    /* DrawText ignores vertical alignment for multiline text,
555     * but we use these flags to align label manually.
556     */
557    if (get_button_type(style) != BS_GROUPBOX)
558    {
559       switch (style & BS_VCENTER)
560       {
561          case BS_TOP:     /* DT_TOP is 0 */      break;
562          case BS_BOTTOM:  dtStyle |= DT_BOTTOM;  break;
563          case BS_VCENTER: /* fall through */
564          default:         dtStyle |= DT_VCENTER; break;
565       }
566    }
567    else
568       /* GroupBox's text is always single line and is top aligned. */
569       dtStyle |= DT_SINGLELINE;
570
571    return dtStyle;
572 }
573
574 /**********************************************************************
575  *       BUTTON_CalcLabelRect
576  *
577  *   Calculates label's rectangle depending on button style.
578  *
579  * Returns flags to be passed to DrawText.
580  * Calculated rectangle doesn't take into account button state
581  * (pushed, etc.). If there is nothing to draw (no text/image) output
582  * rectangle is empty, and return value is (UINT)-1.
583  */
584 static UINT BUTTON_CalcLabelRect(HWND hwnd, HDC hdc, RECT *rc)
585 {
586    LONG style = GetWindowLongW( hwnd, GWL_STYLE );
587    LONG ex_style = GetWindowLongW( hwnd, GWL_EXSTYLE );
588    WCHAR *text;
589    ICONINFO    iconInfo;
590    BITMAP      bm;
591    UINT        dtStyle = BUTTON_BStoDT( style, ex_style );
592    RECT        r = *rc;
593    INT         n;
594
595    /* Calculate label rectangle according to label type */
596    switch (style & (BS_ICON|BS_BITMAP))
597    {
598       case BS_TEXT:
599           if (!(text = get_button_text( hwnd ))) goto empty_rect;
600           if (!text[0])
601           {
602               HeapFree( GetProcessHeap(), 0, text );
603               goto empty_rect;
604           }
605           DrawTextW(hdc, text, -1, &r, dtStyle | DT_CALCRECT);
606           HeapFree( GetProcessHeap(), 0, text );
607           break;
608
609       case BS_ICON:
610          if (!GetIconInfo((HICON)GetWindowLongPtrW( hwnd, HIMAGE_GWL_OFFSET ), &iconInfo))
611             goto empty_rect;
612
613          GetObjectW (iconInfo.hbmColor, sizeof(BITMAP), &bm);
614
615          r.right  = r.left + bm.bmWidth;
616          r.bottom = r.top  + bm.bmHeight;
617
618          DeleteObject(iconInfo.hbmColor);
619          DeleteObject(iconInfo.hbmMask);
620          break;
621
622       case BS_BITMAP:
623          if (!GetObjectW( (HANDLE)GetWindowLongPtrW( hwnd, HIMAGE_GWL_OFFSET ), sizeof(BITMAP), &bm))
624             goto empty_rect;
625
626          r.right  = r.left + bm.bmWidth;
627          r.bottom = r.top  + bm.bmHeight;
628          break;
629
630       default:
631       empty_rect:
632          rc->right = r.left;
633          rc->bottom = r.top;
634          return (UINT)-1;
635    }
636
637    /* Position label inside bounding rectangle according to
638     * alignment flags. (calculated rect is always left-top aligned).
639     * If label is aligned to any side - shift label in opposite
640     * direction to leave extra space for focus rectangle.
641     */
642    switch (dtStyle & (DT_CENTER|DT_RIGHT))
643    {
644       case DT_LEFT:    r.left++;  r.right++;  break;
645       case DT_CENTER:  n = r.right - r.left;
646                        r.left   = rc->left + ((rc->right - rc->left) - n) / 2;
647                        r.right  = r.left + n; break;
648       case DT_RIGHT:   n = r.right - r.left;
649                        r.right  = rc->right - 1;
650                        r.left   = r.right - n;
651                        break;
652    }
653
654    switch (dtStyle & (DT_VCENTER|DT_BOTTOM))
655    {
656       case DT_TOP:     r.top++;  r.bottom++;  break;
657       case DT_VCENTER: n = r.bottom - r.top;
658                        r.top    = rc->top + ((rc->bottom - rc->top) - n) / 2;
659                        r.bottom = r.top + n;  break;
660       case DT_BOTTOM:  n = r.bottom - r.top;
661                        r.bottom = rc->bottom - 1;
662                        r.top    = r.bottom - n;
663                        break;
664    }
665
666    *rc = r;
667    return dtStyle;
668 }
669
670
671 /**********************************************************************
672  *       BUTTON_DrawTextCallback
673  *
674  *   Callback function used by DrawStateW function.
675  */
676 static BOOL CALLBACK BUTTON_DrawTextCallback(HDC hdc, LPARAM lp, WPARAM wp, int cx, int cy)
677 {
678    RECT rc;
679    rc.left = 0;
680    rc.top = 0;
681    rc.right = cx;
682    rc.bottom = cy;
683
684    DrawTextW(hdc, (LPCWSTR)lp, -1, &rc, (UINT)wp);
685    return TRUE;
686 }
687
688
689 /**********************************************************************
690  *       BUTTON_DrawLabel
691  *
692  *   Common function for drawing button label.
693  */
694 static void BUTTON_DrawLabel(HWND hwnd, HDC hdc, UINT dtFlags, const RECT *rc)
695 {
696    DRAWSTATEPROC lpOutputProc = NULL;
697    LPARAM lp;
698    WPARAM wp = 0;
699    HBRUSH hbr = 0;
700    UINT flags = IsWindowEnabled(hwnd) ? DSS_NORMAL : DSS_DISABLED;
701    LONG state = get_button_state( hwnd );
702    LONG style = GetWindowLongW( hwnd, GWL_STYLE );
703    WCHAR *text = NULL;
704
705    /* FIXME: To draw disabled label in Win31 look-and-feel, we probably
706     * must use DSS_MONO flag and COLOR_GRAYTEXT brush (or maybe DSS_UNION).
707     * I don't have Win31 on hand to verify that, so I leave it as is.
708     */
709
710    if ((style & BS_PUSHLIKE) && (state & BST_INDETERMINATE))
711    {
712       hbr = GetSysColorBrush(COLOR_GRAYTEXT);
713       flags |= DSS_MONO;
714    }
715
716    switch (style & (BS_ICON|BS_BITMAP))
717    {
718       case BS_TEXT:
719          /* DST_COMPLEX -- is 0 */
720          lpOutputProc = BUTTON_DrawTextCallback;
721          if (!(text = get_button_text( hwnd ))) return;
722          lp = (LPARAM)text;
723          wp = dtFlags;
724          break;
725
726       case BS_ICON:
727          flags |= DST_ICON;
728          lp = GetWindowLongPtrW( hwnd, HIMAGE_GWL_OFFSET );
729          break;
730
731       case BS_BITMAP:
732          flags |= DST_BITMAP;
733          lp = GetWindowLongPtrW( hwnd, HIMAGE_GWL_OFFSET );
734          break;
735
736       default:
737          return;
738    }
739
740    DrawStateW(hdc, hbr, lpOutputProc, lp, wp, rc->left, rc->top,
741               rc->right - rc->left, rc->bottom - rc->top, flags);
742    HeapFree( GetProcessHeap(), 0, text );
743 }
744
745 /**********************************************************************
746  *       Push Button Functions
747  */
748 static void PB_Paint( HWND hwnd, HDC hDC, UINT action )
749 {
750     RECT     rc, r;
751     UINT     dtFlags, uState;
752     HPEN     hOldPen;
753     HBRUSH   hOldBrush;
754     INT      oldBkMode;
755     COLORREF oldTxtColor;
756     HFONT hFont;
757     LONG state = get_button_state( hwnd );
758     LONG style = GetWindowLongW( hwnd, GWL_STYLE );
759     BOOL pushedState = (state & BST_PUSHED);
760     HWND parent;
761     HRGN hrgn;
762
763     GetClientRect( hwnd, &rc );
764
765     /* Send WM_CTLCOLOR to allow changing the font (the colors are fixed) */
766     if ((hFont = get_button_font( hwnd ))) SelectObject( hDC, hFont );
767     parent = GetParent(hwnd);
768     if (!parent) parent = hwnd;
769     SendMessageW( parent, WM_CTLCOLORBTN, (WPARAM)hDC, (LPARAM)hwnd );
770
771     hrgn = set_control_clipping( hDC, &rc );
772
773     hOldPen = SelectObject(hDC, SYSCOLOR_GetPen(COLOR_WINDOWFRAME));
774     hOldBrush = SelectObject(hDC,GetSysColorBrush(COLOR_BTNFACE));
775     oldBkMode = SetBkMode(hDC, TRANSPARENT);
776
777     if (get_button_type(style) == BS_DEFPUSHBUTTON)
778     {
779         if (action != ODA_FOCUS)
780             Rectangle(hDC, rc.left, rc.top, rc.right, rc.bottom);
781         InflateRect( &rc, -1, -1 );
782     }
783
784     /* completely skip the drawing if only focus has changed */
785     if (action == ODA_FOCUS) goto draw_focus;
786
787     uState = DFCS_BUTTONPUSH;
788
789     if (style & BS_FLAT)
790         uState |= DFCS_MONO;
791     else if (pushedState)
792     {
793         if (get_button_type(style) == BS_DEFPUSHBUTTON )
794             uState |= DFCS_FLAT;
795         else
796             uState |= DFCS_PUSHED;
797     }
798
799     if (state & (BST_CHECKED | BST_INDETERMINATE))
800         uState |= DFCS_CHECKED;
801
802     DrawFrameControl( hDC, &rc, DFC_BUTTON, uState );
803
804     /* draw button label */
805     r = rc;
806     dtFlags = BUTTON_CalcLabelRect(hwnd, hDC, &r);
807
808     if (dtFlags == (UINT)-1L)
809        goto cleanup;
810
811     if (pushedState)
812        OffsetRect(&r, 1, 1);
813
814     oldTxtColor = SetTextColor( hDC, GetSysColor(COLOR_BTNTEXT) );
815
816     BUTTON_DrawLabel(hwnd, hDC, dtFlags, &r);
817
818     SetTextColor( hDC, oldTxtColor );
819
820 draw_focus:
821     if (action == ODA_FOCUS || (state & BST_FOCUS))
822     {
823         InflateRect( &rc, -2, -2 );
824         DrawFocusRect( hDC, &rc );
825     }
826
827  cleanup:
828     SelectObject( hDC, hOldPen );
829     SelectObject( hDC, hOldBrush );
830     SetBkMode(hDC, oldBkMode);
831     SelectClipRgn( hDC, hrgn );
832     if (hrgn) DeleteObject( hrgn );
833 }
834
835 /**********************************************************************
836  *       Check Box & Radio Button Functions
837  */
838
839 static void CB_Paint( HWND hwnd, HDC hDC, UINT action )
840 {
841     RECT rbox, rtext, client;
842     HBRUSH hBrush;
843     int delta;
844     UINT dtFlags;
845     HFONT hFont;
846     LONG state = get_button_state( hwnd );
847     LONG style = GetWindowLongW( hwnd, GWL_STYLE );
848     HWND parent;
849     HRGN hrgn;
850
851     if (style & BS_PUSHLIKE)
852     {
853         PB_Paint( hwnd, hDC, action );
854         return;
855     }
856
857     GetClientRect(hwnd, &client);
858     rbox = rtext = client;
859
860     if ((hFont = get_button_font( hwnd ))) SelectObject( hDC, hFont );
861
862     parent = GetParent(hwnd);
863     if (!parent) parent = hwnd;
864     hBrush = (HBRUSH)SendMessageW(parent, WM_CTLCOLORSTATIC,
865                                   (WPARAM)hDC, (LPARAM)hwnd);
866     if (!hBrush) /* did the app forget to call defwindowproc ? */
867         hBrush = (HBRUSH)DefWindowProcW(parent, WM_CTLCOLORSTATIC,
868                                         (WPARAM)hDC, (LPARAM)hwnd );
869     hrgn = set_control_clipping( hDC, &client );
870
871     if (style & BS_LEFTTEXT)
872     {
873         /* magic +4 is what CTL3D expects */
874
875         rtext.right -= checkBoxWidth + 4;
876         rbox.left = rbox.right - checkBoxWidth;
877     }
878     else
879     {
880         rtext.left += checkBoxWidth + 4;
881         rbox.right = checkBoxWidth;
882     }
883
884     /* Since WM_ERASEBKGND does nothing, first prepare background */
885     if (action == ODA_SELECT) FillRect( hDC, &rbox, hBrush );
886     if (action == ODA_DRAWENTIRE) FillRect( hDC, &client, hBrush );
887
888     /* Draw label */
889     client = rtext;
890     dtFlags = BUTTON_CalcLabelRect(hwnd, hDC, &rtext);
891     
892     /* Only adjust rbox when rtext is valid */
893     if (dtFlags != (UINT)-1L)
894     {
895         rbox.top = rtext.top;
896         rbox.bottom = rtext.bottom;
897     }
898
899     /* Draw the check-box bitmap */
900     if (action == ODA_DRAWENTIRE || action == ODA_SELECT)
901     {
902         UINT flags;
903
904         if ((get_button_type(style) == BS_RADIOBUTTON) ||
905             (get_button_type(style) == BS_AUTORADIOBUTTON)) flags = DFCS_BUTTONRADIO;
906         else if (state & BST_INDETERMINATE) flags = DFCS_BUTTON3STATE;
907         else flags = DFCS_BUTTONCHECK;
908
909         if (state & (BST_CHECKED | BST_INDETERMINATE)) flags |= DFCS_CHECKED;
910         if (state & BST_PUSHED) flags |= DFCS_PUSHED;
911
912         if (style & WS_DISABLED) flags |= DFCS_INACTIVE;
913
914         /* rbox must have the correct height */
915         delta = rbox.bottom - rbox.top - checkBoxHeight;
916         
917         if (style & BS_TOP) {
918             if (delta > 0) {
919                 rbox.bottom = rbox.top + checkBoxHeight;
920             } else { 
921                 rbox.top -= -delta/2 + 1;
922                 rbox.bottom = rbox.top + checkBoxHeight;
923             }
924         } else if (style & BS_BOTTOM) {
925             if (delta > 0) {
926                 rbox.top = rbox.bottom - checkBoxHeight;
927             } else {
928                 rbox.bottom += -delta/2 + 1;
929                 rbox.top = rbox.bottom - checkBoxHeight;
930             }
931         } else { /* Default */
932             if (delta > 0) {
933                 int ofs = (delta / 2);
934                 rbox.bottom -= ofs + 1;
935                 rbox.top = rbox.bottom - checkBoxHeight;
936             } else if (delta < 0) {
937                 int ofs = (-delta / 2);
938                 rbox.top -= ofs + 1;
939                 rbox.bottom = rbox.top + checkBoxHeight;
940             }
941         }
942
943         DrawFrameControl( hDC, &rbox, DFC_BUTTON, flags );
944     }
945
946     if (dtFlags == (UINT)-1L) /* Noting to draw */
947         return;
948
949     if (action == ODA_DRAWENTIRE)
950         BUTTON_DrawLabel(hwnd, hDC, dtFlags, &rtext);
951
952     /* ... and focus */
953     if (action == ODA_FOCUS || (state & BST_FOCUS))
954     {
955         rtext.left--;
956         rtext.right++;
957         IntersectRect(&rtext, &rtext, &client);
958         DrawFocusRect( hDC, &rtext );
959     }
960     SelectClipRgn( hDC, hrgn );
961     if (hrgn) DeleteObject( hrgn );
962 }
963
964
965 /**********************************************************************
966  *       BUTTON_CheckAutoRadioButton
967  *
968  * hwnd is checked, uncheck every other auto radio button in group
969  */
970 static void BUTTON_CheckAutoRadioButton( HWND hwnd )
971 {
972     HWND parent, sibling, start;
973
974     parent = GetParent(hwnd);
975     /* make sure that starting control is not disabled or invisible */
976     start = sibling = GetNextDlgGroupItem( parent, hwnd, TRUE );
977     do
978     {
979         if (!sibling) break;
980         if ((hwnd != sibling) &&
981             ((GetWindowLongW( sibling, GWL_STYLE) & BS_TYPEMASK) == BS_AUTORADIOBUTTON))
982             SendMessageW( sibling, BM_SETCHECK, BST_UNCHECKED, 0 );
983         sibling = GetNextDlgGroupItem( parent, sibling, FALSE );
984     } while (sibling != start);
985 }
986
987
988 /**********************************************************************
989  *       Group Box Functions
990  */
991
992 static void GB_Paint( HWND hwnd, HDC hDC, UINT action )
993 {
994     RECT rc, rcFrame;
995     HBRUSH hbr;
996     HFONT hFont;
997     UINT dtFlags;
998     TEXTMETRICW tm;
999     LONG style = GetWindowLongW( hwnd, GWL_STYLE );
1000     HWND parent;
1001     HRGN hrgn;
1002
1003     if ((hFont = get_button_font( hwnd ))) SelectObject( hDC, hFont );
1004     /* GroupBox acts like static control, so it sends CTLCOLORSTATIC */
1005     parent = GetParent(hwnd);
1006     if (!parent) parent = hwnd;
1007     hbr = (HBRUSH)SendMessageW(parent, WM_CTLCOLORSTATIC, (WPARAM)hDC, (LPARAM)hwnd);
1008     if (!hbr) /* did the app forget to call defwindowproc ? */
1009         hbr = (HBRUSH)DefWindowProcW(parent, WM_CTLCOLORSTATIC,
1010                                      (WPARAM)hDC, (LPARAM)hwnd);
1011     GetClientRect( hwnd, &rc);
1012     rcFrame = rc;
1013     hrgn = set_control_clipping( hDC, &rc );
1014
1015     GetTextMetricsW (hDC, &tm);
1016     rcFrame.top += (tm.tmHeight / 2) - 1;
1017     DrawEdge (hDC, &rcFrame, EDGE_ETCHED, BF_RECT | ((style & BS_FLAT) ? BF_FLAT : 0));
1018
1019     InflateRect(&rc, -7, 1);
1020     dtFlags = BUTTON_CalcLabelRect(hwnd, hDC, &rc);
1021
1022     if (dtFlags != (UINT)-1)
1023     {
1024         /* Because buttons have CS_PARENTDC class style, there is a chance
1025          * that label will be drawn out of client rect.
1026          * But Windows doesn't clip label's rect, so do I.
1027          */
1028
1029         /* There is 1-pixel margin at the left, right, and bottom */
1030         rc.left--; rc.right++; rc.bottom++;
1031         FillRect(hDC, &rc, hbr);
1032         rc.left++; rc.right--; rc.bottom--;
1033
1034         BUTTON_DrawLabel(hwnd, hDC, dtFlags, &rc);
1035     }
1036     SelectClipRgn( hDC, hrgn );
1037     if (hrgn) DeleteObject( hrgn );
1038 }
1039
1040
1041 /**********************************************************************
1042  *       User Button Functions
1043  */
1044
1045 static void UB_Paint( HWND hwnd, HDC hDC, UINT action )
1046 {
1047     RECT rc;
1048     HBRUSH hBrush;
1049     HFONT hFont;
1050     LONG state = get_button_state( hwnd );
1051     HWND parent;
1052
1053     GetClientRect( hwnd, &rc);
1054
1055     if ((hFont = get_button_font( hwnd ))) SelectObject( hDC, hFont );
1056
1057     parent = GetParent(hwnd);
1058     if (!parent) parent = hwnd;
1059     hBrush = (HBRUSH)SendMessageW(parent, WM_CTLCOLORBTN, (WPARAM)hDC, (LPARAM)hwnd);
1060     if (!hBrush) /* did the app forget to call defwindowproc ? */
1061         hBrush = (HBRUSH)DefWindowProcW(parent, WM_CTLCOLORBTN,
1062                                         (WPARAM)hDC, (LPARAM)hwnd);
1063
1064     FillRect( hDC, &rc, hBrush );
1065     if (action == ODA_FOCUS || (state & BST_FOCUS))
1066         DrawFocusRect( hDC, &rc );
1067
1068     switch (action)
1069     {
1070     case ODA_FOCUS:
1071         BUTTON_NOTIFY_PARENT( hwnd, (state & BST_FOCUS) ? BN_SETFOCUS : BN_KILLFOCUS );
1072         break;
1073
1074     case ODA_SELECT:
1075         BUTTON_NOTIFY_PARENT( hwnd, (state & BST_PUSHED) ? BN_HILITE : BN_UNHILITE );
1076         break;
1077
1078     default:
1079         BUTTON_NOTIFY_PARENT( hwnd, BN_PAINT );
1080         break;
1081     }
1082 }
1083
1084
1085 /**********************************************************************
1086  *       Ownerdrawn Button Functions
1087  */
1088
1089 static void OB_Paint( HWND hwnd, HDC hDC, UINT action )
1090 {
1091     LONG state = get_button_state( hwnd );
1092     DRAWITEMSTRUCT dis;
1093     LONG_PTR id = GetWindowLongPtrW( hwnd, GWLP_ID );
1094     HWND parent;
1095     HFONT hFont, hPrevFont = 0;
1096     HRGN hrgn;
1097
1098     dis.CtlType    = ODT_BUTTON;
1099     dis.CtlID      = id;
1100     dis.itemID     = 0;
1101     dis.itemAction = action;
1102     dis.itemState  = ((state & BST_FOCUS) ? ODS_FOCUS : 0) |
1103                      ((state & BST_PUSHED) ? ODS_SELECTED : 0) |
1104                      (IsWindowEnabled(hwnd) ? 0: ODS_DISABLED);
1105     dis.hwndItem   = hwnd;
1106     dis.hDC        = hDC;
1107     dis.itemData   = 0;
1108     GetClientRect( hwnd, &dis.rcItem );
1109
1110     if ((hFont = get_button_font( hwnd ))) hPrevFont = SelectObject( hDC, hFont );
1111     parent = GetParent(hwnd);
1112     if (!parent) parent = hwnd;
1113     SendMessageW( parent, WM_CTLCOLORBTN, (WPARAM)hDC, (LPARAM)hwnd );
1114
1115     hrgn = set_control_clipping( hDC, &dis.rcItem );
1116
1117     SendMessageW( GetParent(hwnd), WM_DRAWITEM, id, (LPARAM)&dis );
1118     if (hPrevFont) SelectObject(hDC, hPrevFont);
1119     SelectClipRgn( hDC, hrgn );
1120     if (hrgn) DeleteObject( hrgn );
1121 }