comctl32: Added header message sequence test cases.
[wine] / dlls / comctl32 / tests / tab.c
1 /* Unit test suite for tab control.
2  *
3  * Copyright 2003 Vitaliy Margolen
4  * Copyright 2007 Hagop Hagopian
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include <assert.h>
22 #include <windows.h>
23 #include <commctrl.h>
24 #include <stdio.h>
25
26 #include "wine/test.h"
27
28 #define DEFAULT_MIN_TAB_WIDTH 54
29 #define TAB_DEFAULT_WIDTH 96
30 #define TAB_PADDING_X 6
31 #define EXTRA_ICON_PADDING 3
32 #define MAX_TABLEN 32
33
34 #define expect(expected, got) ok ( expected == got, "Expected %d, got %d\n", expected, got)
35 #define expect_str(expected, got)\
36  ok ( strcmp(expected, got) == 0, "Expected '%s', got '%s'\n", expected, got)
37
38 #define TabWidthPadded(padd_x, num) (DEFAULT_MIN_TAB_WIDTH - (TAB_PADDING_X - (padd_x)) * num)
39
40 #define TabCheckSetSize(hwnd, SetWidth, SetHeight, ExpWidth, ExpHeight, Msg)\
41     SendMessage (hwnd, TCM_SETITEMSIZE, 0,\
42         (LPARAM) MAKELPARAM((SetWidth >= 0) ? SetWidth:0, (SetHeight >= 0) ? SetHeight:0));\
43     if (winetest_interactive) RedrawWindow (hwnd, NULL, 0, RDW_UPDATENOW);\
44     CheckSize(hwnd, ExpWidth, ExpHeight, Msg);
45
46 #define CheckSize(hwnd,width,height,msg)\
47     SendMessage (hwnd, TCM_GETITEMRECT, 0, (LPARAM) &rTab);\
48     if ((width  >= 0) && (height < 0))\
49         ok (width  == rTab.right  - rTab.left, "%s: Expected width [%d] got [%d]\n",\
50         msg, (int)width,  rTab.right  - rTab.left);\
51     else if ((height >= 0) && (width  < 0))\
52         ok (height == rTab.bottom - rTab.top,  "%s: Expected height [%d] got [%d]\n",\
53         msg, (int)height, rTab.bottom - rTab.top);\
54     else\
55         ok ((width  == rTab.right  - rTab.left) &&\
56             (height == rTab.bottom - rTab.top ),\
57             "%s: Expected [%d,%d] got [%d,%d]\n", msg, (int)width, (int)height,\
58             rTab.right - rTab.left, rTab.bottom - rTab.top);
59
60 static HFONT hFont = 0;
61
62 static HWND
63 create_tabcontrol (DWORD style, DWORD mask)
64 {
65     HWND handle;
66     TCITEM tcNewTab;
67     static char text1[] = "Tab 1",
68     text2[] = "Wide Tab 2",
69     text3[] = "T 3";
70
71     handle = CreateWindow (
72         WC_TABCONTROLA,
73         "TestTab",
74         WS_CLIPSIBLINGS | WS_CLIPCHILDREN | TCS_FOCUSNEVER | style,
75         10, 10, 300, 100,
76         NULL, NULL, NULL, 0);
77
78     assert (handle);
79
80     SetWindowLong(handle, GWL_STYLE, WS_CLIPSIBLINGS | WS_CLIPCHILDREN | TCS_FOCUSNEVER | style);
81     SendMessage (handle, WM_SETFONT, 0, (LPARAM) hFont);
82
83     tcNewTab.mask = mask;
84     tcNewTab.pszText = text1;
85     tcNewTab.iImage = 0;
86     SendMessage (handle, TCM_INSERTITEM, 0, (LPARAM) &tcNewTab);
87     tcNewTab.pszText = text2;
88     tcNewTab.iImage = 1;
89     SendMessage (handle, TCM_INSERTITEM, 1, (LPARAM) &tcNewTab);
90     tcNewTab.pszText = text3;
91     tcNewTab.iImage = 2;
92     SendMessage (handle, TCM_INSERTITEM, 2, (LPARAM) &tcNewTab);
93
94     if (winetest_interactive)
95     {
96         ShowWindow (handle, SW_SHOW);
97         RedrawWindow (handle, NULL, 0, RDW_UPDATENOW);
98         Sleep (1000);
99     }
100
101     return handle;
102 }
103
104 static HWND createFilledTabControl(DWORD style, DWORD mask, INT nTabs)
105 {
106     HWND tabHandle;
107     TCITEM tcNewTab;
108     INT i;
109
110     tabHandle = CreateWindow (
111         WC_TABCONTROLA,
112         "TestTab",
113         WS_CLIPSIBLINGS | WS_CLIPCHILDREN | TCS_FOCUSNEVER | style,
114         0, 0, 300, 100,
115         NULL, NULL, NULL, 0);
116
117     assert(tabHandle);
118
119     SetWindowLong(tabHandle, GWL_STYLE, WS_CLIPSIBLINGS | WS_CLIPCHILDREN | TCS_FOCUSNEVER | style);
120     SendMessage (tabHandle, WM_SETFONT, 0, (LPARAM) hFont);
121
122     tcNewTab.mask = mask;
123
124     for (i = 0; i < nTabs; i++)
125     {
126         char tabName[MAX_TABLEN];
127
128         sprintf(tabName, "Tab %d", i+1);
129         tcNewTab.pszText = tabName;
130         tcNewTab.iImage = i;
131         SendMessage (tabHandle, TCM_INSERTITEM, i, (LPARAM) &tcNewTab);
132     }
133
134     if (winetest_interactive)
135     {
136         ShowWindow (tabHandle, SW_SHOW);
137         RedrawWindow (tabHandle, NULL, 0, RDW_UPDATENOW);
138         Sleep (1000);
139     }
140
141     return tabHandle;
142 }
143
144 static HWND create_tooltip (HWND hTab, char toolTipText[])
145 {
146     HWND hwndTT;
147
148     TOOLINFO ti;
149     LPTSTR lptstr = toolTipText;
150     RECT rect;
151
152     /* Creating a tooltip window*/
153     hwndTT = CreateWindowEx(
154         WS_EX_TOPMOST,
155         TOOLTIPS_CLASS,
156         NULL,
157         WS_POPUP | TTS_NOPREFIX | TTS_ALWAYSTIP,
158         CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
159         hTab, NULL, 0, NULL);
160
161     SetWindowPos(
162         hwndTT,
163         HWND_TOPMOST,
164         0, 0, 0, 0,
165         SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
166
167     GetClientRect (hTab, &rect);
168
169     /* Initialize members of toolinfo*/
170     ti.cbSize = sizeof(TOOLINFO);
171     ti.uFlags = TTF_SUBCLASS;
172     ti.hwnd = hTab;
173     ti.hinst = 0;
174     ti.uId = 0;
175     ti.lpszText = lptstr;
176
177     ti.rect = rect;
178
179     /* Add toolinfo structure to the tooltip control */
180     SendMessage(hwndTT, TTM_ADDTOOL, 0, (LPARAM) (LPTOOLINFO) &ti);
181
182     return hwndTT;
183 }
184
185 static void test_tab(INT nMinTabWidth)
186 {
187     HWND hwTab;
188     RECT rTab;
189     HIMAGELIST himl = ImageList_Create(21, 21, ILC_COLOR, 3, 4);
190     SIZE size;
191     HDC hdc;
192     HFONT hOldFont;
193     INT i;
194
195     hwTab = create_tabcontrol(TCS_FIXEDWIDTH, TCIF_TEXT|TCIF_IMAGE);
196     SendMessage(hwTab, TCM_SETMINTABWIDTH, 0, nMinTabWidth);
197
198     hdc = GetDC(hwTab);
199     hOldFont = SelectObject(hdc, (HFONT)SendMessage(hwTab, WM_GETFONT, 0, 0));
200     GetTextExtentPoint32A(hdc, "Tab 1", strlen("Tab 1"), &size);
201     trace("Tab1 text size: size.cx=%d size.cy=%d\n", size.cx, size.cy);
202     SelectObject(hdc, hOldFont);
203     ReleaseDC(hwTab, hdc);
204
205     trace ("  TCS_FIXEDWIDTH tabs no icon...\n");
206     CheckSize(hwTab, TAB_DEFAULT_WIDTH, -1, "default width");
207     TabCheckSetSize(hwTab, 50, 20, 50, 20, "set size");
208     TabCheckSetSize(hwTab, 0, 1, 0, 1, "min size");
209
210     SendMessage(hwTab, TCM_SETIMAGELIST, 0, (LPARAM)himl);
211
212     trace ("  TCS_FIXEDWIDTH tabs with icon...\n");
213     TabCheckSetSize(hwTab, 50, 30, 50, 30, "set size > icon");
214     TabCheckSetSize(hwTab, 20, 20, 25, 20, "set size < icon");
215     TabCheckSetSize(hwTab, 0, 1, 25, 1, "min size");
216
217     DestroyWindow (hwTab);
218
219     hwTab = create_tabcontrol(TCS_FIXEDWIDTH | TCS_BUTTONS, TCIF_TEXT|TCIF_IMAGE);
220     SendMessage(hwTab, TCM_SETMINTABWIDTH, 0, nMinTabWidth);
221
222     trace ("  TCS_FIXEDWIDTH buttons no icon...\n");
223     CheckSize(hwTab, TAB_DEFAULT_WIDTH, -1, "default width");
224     TabCheckSetSize(hwTab, 20, 20, 20, 20, "set size 1");
225     TabCheckSetSize(hwTab, 10, 50, 10, 50, "set size 2");
226     TabCheckSetSize(hwTab, 0, 1, 0, 1, "min size");
227
228     SendMessage(hwTab, TCM_SETIMAGELIST, 0, (LPARAM)himl);
229
230     trace ("  TCS_FIXEDWIDTH buttons with icon...\n");
231     TabCheckSetSize(hwTab, 50, 30, 50, 30, "set size > icon");
232     TabCheckSetSize(hwTab, 20, 20, 25, 20, "set size < icon");
233     TabCheckSetSize(hwTab, 0, 1, 25, 1, "min size");
234     SendMessage(hwTab, TCM_SETPADDING, 0, MAKELPARAM(4,4));
235     TabCheckSetSize(hwTab, 0, 1, 25, 1, "set padding, min size");
236
237     DestroyWindow (hwTab);
238
239     hwTab = create_tabcontrol(TCS_FIXEDWIDTH | TCS_BOTTOM, TCIF_TEXT|TCIF_IMAGE);
240     SendMessage(hwTab, TCM_SETMINTABWIDTH, 0, nMinTabWidth);
241
242     trace ("  TCS_FIXEDWIDTH | TCS_BOTTOM tabs...\n");
243     CheckSize(hwTab, TAB_DEFAULT_WIDTH, -1, "no icon, default width");
244
245     TabCheckSetSize(hwTab, 20, 20, 20, 20, "no icon, set size 1");
246     TabCheckSetSize(hwTab, 10, 50, 10, 50, "no icon, set size 2");
247     TabCheckSetSize(hwTab, 0, 1, 0, 1, "no icon, min size");
248
249     SendMessage(hwTab, TCM_SETIMAGELIST, 0, (LPARAM)himl);
250
251     TabCheckSetSize(hwTab, 50, 30, 50, 30, "with icon, set size > icon");
252     TabCheckSetSize(hwTab, 20, 20, 25, 20, "with icon, set size < icon");
253     TabCheckSetSize(hwTab, 0, 1, 25, 1, "with icon, min size");
254     SendMessage(hwTab, TCM_SETPADDING, 0, MAKELPARAM(4,4));
255     TabCheckSetSize(hwTab, 0, 1, 25, 1, "set padding, min size");
256
257     DestroyWindow (hwTab);
258
259     hwTab = create_tabcontrol(0, TCIF_TEXT|TCIF_IMAGE);
260     SendMessage(hwTab, TCM_SETMINTABWIDTH, 0, nMinTabWidth);
261
262     trace ("  non fixed width, with text...\n");
263     CheckSize(hwTab, max(size.cx +TAB_PADDING_X*2, (nMinTabWidth < 0) ? DEFAULT_MIN_TAB_WIDTH : nMinTabWidth), -1,
264               "no icon, default width");
265     for (i=0; i<8; i++)
266     {
267         INT nTabWidth = (nMinTabWidth < 0) ? TabWidthPadded(i, 2) : nMinTabWidth;
268
269         SendMessage(hwTab, TCM_SETIMAGELIST, 0, 0);
270         SendMessage(hwTab, TCM_SETPADDING, 0, MAKELPARAM(i,i));
271
272         TabCheckSetSize(hwTab, 50, 20, max(size.cx + i*2, nTabWidth), 20, "no icon, set size");
273         TabCheckSetSize(hwTab, 0, 1, max(size.cx + i*2, nTabWidth), 1, "no icon, min size");
274
275         SendMessage(hwTab, TCM_SETIMAGELIST, 0, (LPARAM)himl);
276         nTabWidth = (nMinTabWidth < 0) ? TabWidthPadded(i, 3) : nMinTabWidth;
277
278         TabCheckSetSize(hwTab, 50, 30, max(size.cx + 21 + i*3, nTabWidth), 30, "with icon, set size > icon");
279         TabCheckSetSize(hwTab, 20, 20, max(size.cx + 21 + i*3, nTabWidth), 20, "with icon, set size < icon");
280         TabCheckSetSize(hwTab, 0, 1, max(size.cx + 21 + i*3, nTabWidth), 1, "with icon, min size");
281     }
282     DestroyWindow (hwTab);
283
284     hwTab = create_tabcontrol(0, TCIF_IMAGE);
285     SendMessage(hwTab, TCM_SETMINTABWIDTH, 0, nMinTabWidth);
286
287     trace ("  non fixed width, no text...\n");
288     CheckSize(hwTab, (nMinTabWidth < 0) ? DEFAULT_MIN_TAB_WIDTH : nMinTabWidth, -1, "no icon, default width");
289     for (i=0; i<8; i++)
290     {
291         INT nTabWidth = (nMinTabWidth < 0) ? TabWidthPadded(i, 2) : nMinTabWidth;
292
293         SendMessage(hwTab, TCM_SETIMAGELIST, 0, 0);
294         SendMessage(hwTab, TCM_SETPADDING, 0, MAKELPARAM(i,i));
295
296         TabCheckSetSize(hwTab, 50, 20, nTabWidth, 20, "no icon, set size");
297         TabCheckSetSize(hwTab, 0, 1, nTabWidth, 1, "no icon, min size");
298
299         SendMessage(hwTab, TCM_SETIMAGELIST, 0, (LPARAM)himl);
300         if (i > 1 && nMinTabWidth > 0 && nMinTabWidth < DEFAULT_MIN_TAB_WIDTH)
301             nTabWidth += EXTRA_ICON_PADDING *(i-1);
302
303         TabCheckSetSize(hwTab, 50, 30, nTabWidth, 30, "with icon, set size > icon");
304         TabCheckSetSize(hwTab, 20, 20, nTabWidth, 20, "with icon, set size < icon");
305         TabCheckSetSize(hwTab, 0, 1, nTabWidth, 1, "with icon, min size");
306     }
307
308     DestroyWindow (hwTab);
309
310     ImageList_Destroy(himl);
311     DeleteObject(hFont);
312 }
313
314 static void test_getters_setters(INT nTabs)
315 {
316     HWND hTab;
317     RECT rTab;
318     INT nTabsRetrieved;
319     INT rowCount;
320
321     hTab = createFilledTabControl(TCS_FIXEDWIDTH, TCIF_TEXT|TCIF_IMAGE, nTabs);
322     ok(hTab != NULL, "Failed to create tab control\n");
323
324     todo_wine{
325         expect(DEFAULT_MIN_TAB_WIDTH, (int)SendMessage(hTab, TCM_SETMINTABWIDTH, 0, -1));
326     }
327     /* Testing GetItemCount */
328     nTabsRetrieved = SendMessage(hTab, TCM_GETITEMCOUNT, 0, 0);
329     expect(nTabs, nTabsRetrieved);
330
331     /* Testing GetRowCount */
332     rowCount = SendMessage(hTab, TCM_GETROWCOUNT, 0, 0);
333     expect(1, rowCount);
334
335     /* Testing GetItemRect */
336     ok(SendMessage(hTab, TCM_GETITEMRECT, 0, (LPARAM) &rTab), "GetItemRect failed.\n");
337     CheckSize(hTab, TAB_DEFAULT_WIDTH, -1 , "Default Width");
338
339     /* Testing CurFocus */
340     {
341         INT focusIndex;
342
343         /* Testing CurFocus with largest appropriate value */
344         SendMessage(hTab, TCM_SETCURFOCUS, nTabs-1, 0);
345         focusIndex = SendMessage(hTab, TCM_GETCURFOCUS, 0, 0);
346             expect(nTabs-1, focusIndex);
347
348         /* Testing CurFocus with negative value */
349         SendMessage(hTab, TCM_SETCURFOCUS, -10, 0);
350         focusIndex = SendMessage(hTab, TCM_GETCURFOCUS, 0, 0);
351         todo_wine{
352             expect(-1, focusIndex);
353         }
354
355         /* Testing CurFocus with value larger than number of tabs */
356         focusIndex = SendMessage(hTab, TCM_SETCURSEL, 1, 0);
357         todo_wine{
358             expect(-1, focusIndex);
359         }
360         SendMessage(hTab, TCM_SETCURFOCUS, nTabs+1, 0);
361         focusIndex = SendMessage(hTab, TCM_GETCURFOCUS, 0, 0);
362         todo_wine{
363             expect(1, focusIndex);
364         }
365     }
366
367     /* Testing CurSel */
368     {
369         INT selectionIndex;
370
371         /* Testing CurSel with largest appropriate value */
372         selectionIndex = SendMessage(hTab, TCM_SETCURSEL, nTabs-1, 0);
373             expect(1, selectionIndex);
374         selectionIndex = SendMessage(hTab, TCM_GETCURSEL, 0, 0);
375             expect(nTabs-1, selectionIndex);
376
377         /* Testing CurSel with negative value */
378         SendMessage(hTab, TCM_SETCURSEL, -10, 0);
379         selectionIndex = SendMessage(hTab, TCM_GETCURSEL, 0, 0);
380         todo_wine{
381             expect(-1, selectionIndex);
382         }
383
384         /* Testing CurSel with value larger than number of tabs */
385         selectionIndex = SendMessage(hTab, TCM_SETCURSEL, 1, 0);
386         todo_wine{
387             expect(-1, selectionIndex);
388         }
389         selectionIndex = SendMessage(hTab, TCM_SETCURSEL, nTabs+1, 0);
390             expect(-1, selectionIndex);
391         selectionIndex = SendMessage(hTab, TCM_GETCURFOCUS, 0, 0);
392         todo_wine{
393             expect(1, selectionIndex);
394         }
395     }
396
397     /* Testing ExtendedStyle */
398     {
399         DWORD prevExtendedStyle;
400         DWORD extendedStyle;
401
402         /* Testing Flat Seperators */
403         extendedStyle = SendMessage(hTab, TCM_GETEXTENDEDSTYLE, 0, 0);
404         prevExtendedStyle = SendMessage(hTab, TCM_SETEXTENDEDSTYLE, 0, TCS_EX_FLATSEPARATORS);
405             expect(extendedStyle, prevExtendedStyle);
406
407         extendedStyle = SendMessage(hTab, TCM_GETEXTENDEDSTYLE, 0, 0);
408         todo_wine{
409             expect(TCS_EX_FLATSEPARATORS, extendedStyle);
410         }
411
412         /* Testing Register Drop */
413         prevExtendedStyle = SendMessage(hTab, TCM_SETEXTENDEDSTYLE, 0, TCS_EX_REGISTERDROP);
414             expect(extendedStyle, prevExtendedStyle);
415
416         extendedStyle = SendMessage(hTab, TCM_GETEXTENDEDSTYLE, 0, 0);
417         todo_wine{
418             expect(TCS_EX_REGISTERDROP, extendedStyle);
419         }
420     }
421
422     /* Testing UnicodeFormat */
423     {
424         INT unicodeFormat;
425
426         unicodeFormat = SendMessage(hTab, TCM_SETUNICODEFORMAT, TRUE, 0);
427         todo_wine{
428             expect(0, unicodeFormat);
429         }
430         unicodeFormat = SendMessage(hTab, TCM_GETUNICODEFORMAT, 0, 0);
431             expect(1, unicodeFormat);
432
433         unicodeFormat = SendMessage(hTab, TCM_SETUNICODEFORMAT, FALSE, 0);
434             expect(1, unicodeFormat);
435         unicodeFormat = SendMessage(hTab, TCM_GETUNICODEFORMAT, 0, 0);
436             expect(0, unicodeFormat);
437
438         unicodeFormat = SendMessage(hTab, TCM_SETUNICODEFORMAT, TRUE, 0);
439             expect(0, unicodeFormat);
440     }
441
442     /* Testing GetSet Item */
443     {
444         TCITEM tcItem;
445         char szText[32] = "New Label";
446
447         tcItem.mask = TCIF_TEXT;
448         tcItem.pszText = &szText[0];
449         tcItem.cchTextMax = sizeof(szText);
450
451         ok ( SendMessage(hTab, TCM_SETITEM, 0, (LPARAM) &tcItem), "Setting new item failed.\n");
452         ok ( SendMessage(hTab, TCM_GETITEM, 0, (LPARAM) &tcItem), "Getting item failed.\n");
453         expect_str("New Label", tcItem.pszText);
454
455         ok ( SendMessage(hTab, TCM_GETITEM, 1, (LPARAM) &tcItem), "Getting item failed.\n");
456         expect_str("Tab 2", tcItem.pszText);
457     }
458
459     /* Testing GetSet ToolTip */
460     {
461         HWND toolTip;
462         char toolTipText[32] = "ToolTip Text Test";
463
464         toolTip = create_tooltip(hTab, toolTipText);
465         SendMessage(hTab, TCM_SETTOOLTIPS, (LPARAM) toolTip, 0);
466         ok (toolTip == (HWND) SendMessage(hTab,TCM_GETTOOLTIPS,0,0), "ToolTip was set incorrectly.");
467
468         SendMessage(hTab, TCM_SETTOOLTIPS, (LPARAM) NULL, 0);
469         ok (NULL  == (HWND) SendMessage(hTab,TCM_GETTOOLTIPS,0,0), "ToolTip was set incorrectly.");
470     }
471
472     DestroyWindow(hTab);
473 }
474
475 START_TEST(tab)
476 {
477     LOGFONTA logfont;
478
479     lstrcpyA(logfont.lfFaceName, "Arial");
480     memset(&logfont, 0, sizeof(logfont));
481     logfont.lfHeight = -12;
482     logfont.lfWeight = FW_NORMAL;
483     logfont.lfCharSet = ANSI_CHARSET;
484     hFont = CreateFontIndirectA(&logfont);
485
486     InitCommonControls();
487
488     trace ("Testing with default MinWidth\n");
489     test_tab(-1);
490     trace ("Testing with MinWidth set to -3\n");
491     test_tab(-3);
492     trace ("Testing with MinWidth set to 24\n");
493     test_tab(24);
494     trace ("Testing with MinWidth set to 54\n");
495     test_tab(54);
496     trace ("Testing with MinWidth set to 94\n");
497     test_tab(94);
498
499     /* Testing getters and setters with 5 tabs */
500     test_getters_setters(5);
501 }