Context Navigation

source: trunk/src/helpers/cctl_tooltip.c@ 232

Visit:

Last change on this file since 232 was 232, checked in by umoeller, 23 years ago
New toolbar control.
Property svn:eol-style set to `CRLF` Property svn:keywords set to `Author Date Id Revision`
File size: 68.0 KB

Line
1
2	/*
3	*@@sourcefile cctl_tooltip.c:
4	* implementation for the "tooltip" common control.
5	* See comctl.c for an overview.
6	*
7	* This has been extracted from comctl.c with V0.9.3 (2000-05-21) [umoeller].
8	*
9	* Note: Version numbering in this file relates to XWorkplace version
10	* numbering.
11	*
12	*@@header "helpers\comctl.h"
13	*@@added V0.9.3 (2000-05-21) [umoeller].
14	*/
15
16	/*
17	* Copyright (C) 1997-2002 Ulrich Mller.
18	* This file is part of the "XWorkplace helpers" source package.
19	* This is free software; you can redistribute it and/or modify
20	* it under the terms of the GNU General Public License as published
21	* by the Free Software Foundation, in version 2 as it comes in the
22	* "COPYING" file of the XWorkplace main distribution.
23	* This program is distributed in the hope that it will be useful,
24	* but WITHOUT ANY WARRANTY; without even the implied warranty of
25	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26	* GNU General Public License for more details.
27	*/
28
29	#define OS2EMX_PLAIN_CHAR
30	// this is needed for "os2emx.h"; if this is defined,
31	// emx will define PSZ as _signed_ char, otherwise
32	// as unsigned char
33
34	#define INCL_DOSEXCEPTIONS
35	#define INCL_DOSPROCESS
36	#define INCL_DOSSEMAPHORES
37	#define INCL_DOSERRORS
38
39	#define INCL_WINWINDOWMGR
40	#define INCL_WINFRAMEMGR
41	#define INCL_WINMESSAGEMGR
42	#define INCL_WININPUT
43	#define INCL_WINPOINTERS
44	#define INCL_WINTRACKRECT
45	#define INCL_WINTIMER
46	#define INCL_WINSYS
47
48	#define INCL_WINRECTANGLES /// xxx temporary
49
50	#define INCL_WINMENUS
51	#define INCL_WINSTATICS
52	#define INCL_WINBUTTONS
53	#define INCL_WINSTDCNR
54
55	#define INCL_GPIPRIMITIVES
56	#define INCL_GPILOGCOLORTABLE
57	#define INCL_GPILCIDS
58	#define INCL_GPIPATHS
59	#define INCL_GPIREGIONS
60	#define INCL_GPIBITMAPS // added V0.9.1 (2000-01-04) [umoeller]: needed for EMX headers
61	#include <os2.h>
62
63	#include <stdlib.h>
64	#include <stdio.h>
65	#include <string.h>
66	#include <setjmp.h> // needed for except.h
67	#include <assert.h> // needed for except.h
68
69	#include "setup.h" // code generation and debugging options
70
71	#include "helpers\cnrh.h"
72	#include "helpers\except.h" // exception handling
73	#include "helpers\gpih.h"
74	#include "helpers\linklist.h"
75	#include "helpers\winh.h"
76
77	#include "helpers\comctl.h"
78
79	#pragma hdrstop
80
81	/*
82	*@@category: Helpers\PM helpers\Window classes\Tooltips
83	* See cctl_tooltip.c.
84	*/
85
86	/* ******************************************************************
87	*
88	* Global variables
89	*
90	********************************************************************/
91
92	// linked list of all tools which were subclassed for tooltip
93	HMTX G_hmtxSubclassedTools = NULLHANDLE;
94	LINKLIST G_llSubclassedTools; // linked list of SUBCLASSEDTOOL items
95
96	/* ******************************************************************
97	*
98	* "Tooltip" control
99	*
100	********************************************************************/
101
102	/*
103	*@@ ctlRegisterTooltip:
104	* this registers the Tooltip window class (ctl_fnwpTooltip)
105	* for an application. This is required before the tooltip
106	* control can be used.
107	*
108	*@@added V0.9.0 [umoeller]
109	*/
110
111	BOOL ctlRegisterTooltip(HAB hab)
112	{
113	return WinRegisterClass(hab,
114	WC_CCTL_TOOLTIP,
115	ctl_fnwpTooltip,
116	CS_HITTEST, // class styles;
117	// CS_FRAME not working,
118	// CS_CLIPSIBLINGS not working
119	sizeof(PVOID) * 2); // addt'l bytes to reserve:
120	// one pointer for QWL_USER,
121	// one more for instance data
122	}
123
124	/* ******************************************************************
125	*
126	* Subclassing
127	*
128	********************************************************************/
129
130	/*
131	*@@ LockSubclassedTools:
132	* locks the global list of subclassed tools.
133	*
134	*@@added V0.9.12 (2001-04-28) [umoeller]
135	*/
136
137	STATIC BOOL LockSubclassedTools(VOID)
138	{
139	if (!G_hmtxSubclassedTools)
140	{
141	// first call:
142
143	// initialize the list
144	lstInit(&G_llSubclassedTools,
145	TRUE); // auto-free
146
147	// create mutex and request it right away
148	return (!DosCreateMutexSem(NULL,
149	&G_hmtxSubclassedTools,
150	0,
151	TRUE)); // request!
152	}
153
154	return !DosRequestMutexSem(G_hmtxSubclassedTools, SEM_INDEFINITE_WAIT);
155	}
156
157	/*
158	*@@ UnlockSubclassedTools:
159	* unlocks the global list of subclassed tools.
160	*
161	*@@added V0.9.12 (2001-04-28) [umoeller]
162	*@@changed V0.9.12 (2001-05-03) [umoeller]: this did nothing... fixed
163	*/
164
165	STATIC VOID UnlockSubclassedTools(VOID)
166	{
167	DosReleaseMutexSem(G_hmtxSubclassedTools); // was missing V0.9.12 (2001-05-03) [umoeller]
168	}
169
170	/*
171	*@@ SUBCLASSEDTOOL:
172	* structure created for each control which is
173	* subclassed by the tooltip control (ctl_fnwpTooltip).
174	*
175	*@@added V0.9.0 [umoeller]
176	*/
177
178	typedef struct _SUBCLASSEDTOOL
179	{
180	HWND hwndTool;
181	PFNWP pfnwpOrig;
182	HWND hwndTooltip;
183	HAB hab;
184	} SUBCLASSEDTOOL, *PSUBCLASSEDTOOL;
185
186	/*
187	*@@ FindSubclassedTool:
188	* returns the SUBCLASSEDTOOL struct from the
189	* global list which matches hwndTool or NULL
190	* if not found.
191	*
192	* Preconditions: Caller must hold the subclassed
193	* tools mutex.
194	*
195	*@@added V0.9.12 (2001-04-28) [umoeller]
196	*/
197
198	STATIC PSUBCLASSEDTOOL FindSubclassedTool(HWND hwndTool)
199	{
200	PLISTNODE pNode = lstQueryFirstNode(&G_llSubclassedTools);
201	while (pNode)
202	{
203	PSUBCLASSEDTOOL pstThis = (PSUBCLASSEDTOOL)pNode->pItemData;
204	if (pstThis->hwndTool == hwndTool)
205	return pstThis;
206
207	pNode = pNode->pNext;
208	}
209
210	return NULL;
211	}
212
213	/*
214	*@@ ctl_fnwpSubclassedTool:
215	* window procedure for tools which were subclassed
216	* to support tooltips.
217	*
218	*@@added V0.9.0 [umoeller]
219	*@@changed V0.9.12 (2001-04-28) [umoeller]: added mutex protection
220	*/
221
222	MRESULT EXPENTRY ctl_fnwpSubclassedTool(HWND hwndTool, ULONG msg, MPARAM mp1, MPARAM mp2)
223	{
224	MRESULT mrc = 0;
225
226	PFNWP pfnwpOrig = NULL;
227
228	if (LockSubclassedTools())
229	{
230	PSUBCLASSEDTOOL pst;
231
232	if (pst = FindSubclassedTool(hwndTool))
233	{
234	pfnwpOrig = pst->pfnwpOrig; // call default
235
236	switch (msg)
237	{
238	case WM_MOUSEMOVE:
239	case WM_BUTTON1DOWN:
240	case WM_BUTTON1UP:
241	case WM_BUTTON2DOWN:
242	case WM_BUTTON2UP:
243	case WM_BUTTON3DOWN:
244	case WM_BUTTON3UP:
245	{
246	QMSG qmsg;
247	qmsg.hwnd = hwndTool;
248	qmsg.msg = msg;
249	qmsg.mp1 = mp1;
250	qmsg.mp2 = mp2;
251	// _Pmpf((__FUNCTION__ ": sending TTM_RELAYEVENT"));
252	WinSendMsg(pst->hwndTooltip,
253	TTM_RELAYEVENT,
254	(MPARAM)0,
255	(MPARAM)&qmsg);
256	}
257	break;
258
259	case WM_DESTROY:
260	lstRemoveItem(&G_llSubclassedTools, pst);
261	// this frees the item
262	break;
263	}
264	}
265
266	UnlockSubclassedTools();
267	}
268
269	if (pfnwpOrig)
270	mrc = pfnwpOrig(hwndTool, msg, mp1, mp2);
271
272	return mrc;
273	}
274
275	/*
276	*@@ SubclassTool:
277	* this gets called from ctl_fnwpTooltip if a control
278	* is to be subclassed to support mouse messaging
279	* (TTF_SUBCLASS flag).
280	*
281	* Preconditions: Caller must hold the subclassed
282	* tools mutex.
283	*
284	*@@added V0.9.0 [umoeller]
285	*@@changed V0.9.12 (2001-04-28) [umoeller]: renamed from SubclassToolForToolInfo
286	*/
287
288	STATIC BOOL SubclassTool(HWND hwndTooltip,
289	HWND hwndTool)
290	{
291	BOOL brc = FALSE;
292
293	// make sure the tool is not on the list yet
294	// V0.9.12 (2001-04-28) [umoeller]
295	if (!FindSubclassedTool(hwndTool))
296	{
297	PFNWP pfnwpOrig;
298	if (pfnwpOrig = WinSubclassWindow(hwndTool,
299	ctl_fnwpSubclassedTool))
300	{
301	PSUBCLASSEDTOOL pst;
302	if (pst = (PSUBCLASSEDTOOL)malloc(sizeof(SUBCLASSEDTOOL)))
303	{
304	pst->pfnwpOrig = pfnwpOrig;
305	pst->hwndTooltip = hwndTooltip;
306	pst->hwndTool = hwndTool;
307	pst->hab = WinQueryAnchorBlock(hwndTool);
308
309	brc = !!lstAppendItem(&G_llSubclassedTools, pst);
310	}
311	}
312	}
313
314	return brc;
315	}
316
317	/*
318	*@@ UnSubclassTool:
319	* un-subclasses a tool previously subclassed by
320	* SubclassToolForToolinfo.
321	*
322	* Preconditions: Caller must hold the subclassed
323	* tools mutex.
324	*
325	*@@added V0.9.12 (2001-04-28) [umoeller]
326	*/
327
328	STATIC BOOL UnSubclassTool(HWND hwndTool)
329	{
330	PSUBCLASSEDTOOL pst;
331	if (pst = FindSubclassedTool(hwndTool))
332	{
333	WinSubclassWindow(hwndTool,
334	pst->pfnwpOrig);
335	// orig winproc == un-subclass
336	return lstRemoveItem(&G_llSubclassedTools, pst);
337	// this frees the item
338	}
339
340	return FALSE;
341	}
342
343	/* ******************************************************************
344	*
345	* Implementation
346	*
347	********************************************************************/
348
349	/*
350	*@@ TOOLTIPDATA:
351	* private data structure stored in the window
352	* words of ctl_fnwpTooltip to hold information for
353	* a tooltip instance.
354	*
355	*@@added V0.9.0 [umoeller]
356	*/
357
358	typedef struct _TOOLTIPDATA
359	{
360	HWND hwndOwner; // from WM_CREATE
361	HAB hab; // from WM_CREATE
362	USHORT usTooltipID; // from WM_CREATE
363
364	BOOL fIsActive; // TRUE per default; changed by TTM_ACTIVATE
365
366	ULONG idTimerInitial, // if != 0, "initial" timer is running
367	idTimerAutopop; // if != 0, "autopop" (hide) timer is running
368
369	ULONG ulTimeoutInitial, // "initial" timer timeout (ms)
370	ulTimeoutAutopop, // "autopop" (hide) timer timeout (ms)
371	ulTimeoutReshow; // "reshow" timer timeout (ms)
372
373	LINKLIST llTools; // linked list of TOOLINFO structures
374	// containing the tools
375	FONTMETRICS fontmetrics; // current font
376	LONG lForeColor, // current foreground color
377	lBackColor, // current background color
378	l3DHiColor, // 3D border light color
379	l3DLoColor; // 3D border dark color
380	PSZ pszPaintText; // text to paint (new buffer)
381
382	POINTL ptlPointerLast; // last mouse pointer position
383
384	PTOOLINFO ptiMouseOver; // tool info over which the mouse resides
385
386	BOOL fIsVisible; // TRUE if tooltip is visible
387
388	// CHAR szTextBuf[256]; // static buffer for copying/loading strings
389	} TOOLTIPDATA, *PTOOLTIPDATA;
390
391	// timer IDs
392	#define TOOLTIP_ID_TIMER_INITIAL 1
393	#define TOOLTIP_ID_TIMER_AUTOPOP 2
394
395	// tooltip window border (free spaces)
396	#define TOOLTIP_CX_BORDER 5
397	#define TOOLTIP_CY_BORDER 3
398
399	/*
400	*@@ UpdateTooltipPresColors:
401	* this gets called during WM_CREATE and WM_PRESPARAMCHANGED
402	* in ctl_fnwpTooltip to set the colors in TOOLTIPDATA according
403	* to the control's presparams.
404	*/
405
406	STATIC VOID UpdateTooltipPresColors(HWND hwndTooltip) // in: tooltip control
407	{
408	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
409
410	// tooltip background color:
411	pttd->lBackColor = winhQueryPresColor(hwndTooltip,
412	PP_MENUBACKGROUNDCOLOR,
413	FALSE, // no inherit
414	SYSCLR_ENTRYFIELD);
415	// tooltip text color:
416	pttd->lForeColor = winhQueryPresColor(hwndTooltip,
417	PP_MENUFOREGROUNDCOLOR,
418	FALSE, // no inherit
419	SYSCLR_WINDOWTEXT);
420	// 3D border light color:
421	pttd->l3DHiColor = winhQueryPresColor(hwndTooltip,
422	PP_MENUHILITEFGNDCOLOR,
423	FALSE, // no inherit
424	SYSCLR_WINDOWTEXT);
425	// 3D border dark color:
426	pttd->l3DLoColor = winhQueryPresColor(hwndTooltip,
427	PP_MENUHILITEBGNDCOLOR,
428	FALSE, // no inherit
429	SYSCLR_WINDOWTEXT);
430	}
431
432	/*
433	*@@ TtmCreate:
434	* implementation for WM_CREATE in ctl_fnwpTooltip.
435	*
436	*@@added V0.9.13 (2001-06-21) [umoeller]
437	*/
438
439	STATIC MRESULT TtmCreate(HWND hwndTooltip,
440	MPARAM mp2)
441	{
442	PTOOLTIPDATA pttd;
443	PCREATESTRUCT pcs = (PCREATESTRUCT)mp2;
444
445	// allocate and initialize tooltip data
446	if (pttd = (PTOOLTIPDATA)malloc(sizeof(TOOLTIPDATA)))
447	{
448	CHAR szFont[256];
449	memset(pttd, 0, sizeof(TOOLTIPDATA));
450	WinSetWindowPtr(hwndTooltip, 1, pttd);
451
452	pttd->hwndOwner = pcs->hwndOwner;
453	pttd->hab = WinQueryAnchorBlock(hwndTooltip);
454	pttd->usTooltipID = pcs->id;
455
456	pttd->fIsActive = TRUE;
457
458	// default timeouts
459	pttd->ulTimeoutInitial = 1000;
460	pttd->ulTimeoutAutopop = 5000;
461	pttd->ulTimeoutReshow = 500;
462
463	// get colors from presparams/syscolors
464	UpdateTooltipPresColors(hwndTooltip);
465
466	// check if font presparam set
467	if (WinQueryPresParam(hwndTooltip,
468	PP_FONTNAMESIZE, 0,
469	NULL,
470	sizeof(szFont),
471	szFont,
472	QPF_NOINHERIT)
473	== 0)
474	{
475	// no: set default font presparam
476	// (we never want the System Proportional font)
477	winhSetWindowFont(hwndTooltip,
478	NULL); // default (WarpSans or 8.Helv)
479	}
480
481	pttd->pszPaintText = strdup("undefined");
482
483	lstInit(&pttd->llTools, TRUE); // auto-free items
484
485	// override CREATESTRUCT
486	WinSetWindowPos(hwndTooltip,
487	HWND_TOP,
488	50, 50,
489	100, 100,
490	SWP_MOVE \| SWP_SIZE \| SWP_ZORDER \| SWP_HIDE);
491
492	return (MPARAM)FALSE;
493	}
494
495	// malloc failed:
496	return (MPARAM)TRUE;
497	}
498
499	/*
500	*@@ TtmTimer:
501	* implementation for WM_TIMER in ctl_fnwpTooltip.
502	*
503	*@@added V0.9.13 (2001-06-21) [umoeller]
504	*/
505
506	STATIC BOOL TtmTimer(HWND hwndTooltip, MPARAM mp1)
507	{
508	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
509	USHORT usTimer = SHORT1FROMMP(mp1);
510
511	switch (usTimer)
512	{
513	case TOOLTIP_ID_TIMER_INITIAL:
514	// _Pmpf(("WM_TIMER: Stopping initial timer: %d", usTimer));
515	// _Pmpf((__FUNCTION__ ": TOOLTIP_ID_TIMER_INITIAL"));
516	WinStopTimer(pttd->hab,
517	hwndTooltip,
518	usTimer);
519	pttd->idTimerInitial = 0;
520
521	if (pttd->fIsActive)
522	// show tooltip
523	WinPostMsg(hwndTooltip, TTM_SHOWTOOLTIPNOW, (MPARAM)TRUE, 0);
524	break;
525
526	case TOOLTIP_ID_TIMER_AUTOPOP:
527	// _Pmpf(("WM_TIMER: Stopping autopop timer: %d", usTimer));
528	WinStopTimer(pttd->hab,
529	hwndTooltip,
530	usTimer);
531	pttd->idTimerAutopop = 0;
532	WinPostMsg(hwndTooltip, TTM_SHOWTOOLTIPNOW, (MPARAM)FALSE, 0);
533	break;
534
535	default:
536	return FALSE;
537	} // end switch
538
539	return TRUE;
540	}
541
542	/*
543	*@@ TtmPaint:
544	* implementation for WM_PAINT in ctl_fnwpTooltip.
545	*
546	*@@added V0.9.1 (99-11-30) [umoeller]
547	*/
548
549	STATIC VOID TtmPaint(HWND hwndTooltip)
550	{
551	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
552	HPS hps = WinBeginPaint(hwndTooltip, NULLHANDLE, NULL);
553	POINTL ptl = {0, 0};
554	RECTL rclWindow,
555	rclWindowBak;
556	ULONG ulStyle = WinQueryWindowULong(hwndTooltip, QWL_STYLE);
557
558	ULONG ulRounding = 0;
559	if (ulStyle & TTS_ROUNDED)
560	ulRounding = TT_ROUNDING;
561
562
563	gpihSwitchToRGB(hps);
564
565	// get tooltip size; this has been properly calculated
566	// by TTM_SHOWTOOLTIPNOW earlier
567	WinQueryWindowRect(hwndTooltip, &rclWindow);
568	memcpy(&rclWindowBak, &rclWindow, sizeof(RECTL));
569
570	if (ulStyle & TTS_SHADOW)
571	{
572	// if shadows are on, the window is too large;
573	// make rectl smaller for rest of paint
574	rclWindow.xRight -= TT_SHADOWOFS;
575	rclWindow.yBottom += TT_SHADOWOFS;
576	// restore old pattern
577	GpiSetPattern(hps, PATSYM_DEFAULT);
578	}
579
580	// draw shadow
581	if (ulStyle & TTS_SHADOW)
582	{
583	GpiSetColor(hps, CLR_BLACK);
584	GpiSetPattern(hps, PATSYM_HALFTONE);
585	ptl.x = rclWindowBak.xLeft + TT_SHADOWOFS;
586	ptl.y = rclWindowBak.yBottom;
587	GpiMove(hps, &ptl);
588	ptl.x = rclWindowBak.xRight - 1;
589	ptl.y = rclWindowBak.yTop - TT_SHADOWOFS;
590	GpiBox(hps,
591	DRO_FILL,
592	&ptl,
593	ulRounding, ulRounding);
594	// restore pattern
595	GpiSetPattern(hps, PATSYM_DEFAULT);
596	}
597
598	// draw "real" rectangle
599	ptl.x = rclWindow.xLeft;
600	ptl.y = rclWindow.yBottom;
601	GpiMove(hps, &ptl);
602	ptl.x = rclWindow.xRight - 1;
603	ptl.y = rclWindow.yTop - 1;
604	GpiSetColor(hps, pttd->lBackColor);
605	GpiBox(hps,
606	DRO_FILL,
607	&ptl,
608	6, 6);
609
610	GpiSetColor(hps, pttd->lForeColor);
611	GpiBox(hps,
612	DRO_OUTLINE,
613	&ptl,
614	ulRounding, ulRounding);
615
616	if (pttd->pszPaintText)
617	{
618	RECTL rclText;
619	GpiSetColor(hps, pttd->lForeColor);
620	GpiSetBackColor(hps, pttd->lBackColor);
621	rclText.xLeft = rclWindow.xLeft + TOOLTIP_CX_BORDER;
622	rclText.xRight = rclWindow.xRight - TOOLTIP_CX_BORDER;
623	rclText.yBottom = rclWindow.yBottom + TOOLTIP_CY_BORDER;
624	rclText.yTop = rclWindow.yTop - TOOLTIP_CY_BORDER;
625	winhDrawFormattedText(hps,
626	&rclText,
627	pttd->pszPaintText,
628	DT_LEFT \| DT_TOP \| DT_WORDBREAK);
629	}
630
631	WinEndPaint(hps);
632	}
633
634	/*
635	*@@ TtmDestroy:
636	* implementation for WM_DESTROY in ctl_fnwpTooltip.
637	*
638	*@@added V0.9.13 (2001-06-21) [umoeller]
639	*/
640
641	STATIC VOID TtmDestroy(HWND hwndTooltip)
642	{
643	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
644	// stop timers
645	if (pttd->idTimerInitial)
646	WinStopTimer(pttd->hab,
647	hwndTooltip,
648	pttd->idTimerInitial);
649	if (pttd->idTimerAutopop)
650	WinStopTimer(pttd->hab,
651	hwndTooltip,
652	pttd->idTimerAutopop);
653	if (pttd->pszPaintText)
654	free(pttd->pszPaintText);
655
656	// un-subclass all tools that we subclassed
657	// V0.9.12 (2001-04-28) [umoeller]
658	if (LockSubclassedTools())
659	{
660	PLISTNODE pNode;
661	PSUBCLASSEDTOOL pst;
662	for (pNode = lstQueryFirstNode(&pttd->llTools);
663	pNode;
664	pNode = pNode->pNext)
665	{
666	PTOOLINFO pti = (PTOOLINFO)pNode->pItemData;
667	if (pst = FindSubclassedTool(pti->hwndTool))
668	UnSubclassTool(pti->hwndTool);
669	}
670
671	UnlockSubclassedTools();
672	}
673	// end V0.9.12 (2001-04-28) [umoeller]
674
675	lstClear(&pttd->llTools);
676
677	free(pttd);
678	}
679
680	/*
681	*@@ TtmAddTool:
682	* implementation for TTM_ADDTOOL in ctl_fnwpTooltip.
683	*
684	*@@added V0.9.13 (2001-06-21) [umoeller]
685	*/
686
687	STATIC MRESULT TtmAddTool(HWND hwndTooltip, MPARAM mp2)
688	{
689	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
690	if (mp2)
691	{
692	PTOOLINFO ptiPassed = (PTOOLINFO)mp2,
693	ptiNew = (PTOOLINFO)malloc(sizeof(TOOLINFO));
694	if (ptiNew)
695	{
696	memcpy(ptiNew, ptiPassed, sizeof(TOOLINFO));
697	lstAppendItem(&pttd->llTools,
698	ptiNew);
699
700	if ( (ptiPassed->ulFlags & TTF_SUBCLASS)
701	&& (LockSubclassedTools()) // V0.9.12 (2001-04-28) [umoeller]
702	)
703	{
704	// caller wants this tool to be subclassed:
705	// well, do it then
706	SubclassTool(hwndTooltip,
707	ptiPassed->hwndTool);
708
709	UnlockSubclassedTools();
710	}
711
712	return ((MPARAM)TRUE);
713	}
714	}
715
716	return (MPARAM)FALSE;
717	}
718
719	/*
720	*@@ TtmDelTool:
721	* implementation for TTM_DELTOOL in ctl_fnwpTooltip.
722	*
723	*@@added V0.9.13 (2001-06-21) [umoeller]
724	*@@changed V0.9.13 (2001-06-21) [umoeller]: fixed missing unlock
725	*@@changed V0.9.13 (2001-06-21) [umoeller]: fixed endless loop
726	*/
727
728	STATIC VOID TtmDelTool(HWND hwndTooltip, MPARAM mp2)
729	{
730	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
731	PTOOLINFO ptiSearch;
732	if (ptiSearch = (PTOOLINFO)mp2)
733	{
734	PLISTNODE pToolNode = lstQueryFirstNode(&pttd->llTools);
735	while (pToolNode)
736	{
737	PTOOLINFO ptiThis = (PTOOLINFO)pToolNode->pItemData;
738	if ( (ptiThis->hwndToolOwner == ptiSearch->hwndToolOwner)
739	&& (ptiThis->hwndTool == ptiSearch->hwndTool)
740	)
741	{
742	// found:
743
744	// V0.9.12 (2001-04-28) [umoeller]
745	// unsubclass if this was subclassed
746	if (ptiThis->ulFlags & TTF_SUBCLASS)
747	{
748	if (LockSubclassedTools())
749	{
750	UnSubclassTool(ptiSearch->hwndTool);
751
752	UnlockSubclassedTools();
753	// was missing V0.9.13 (2001-06-21) [umoeller]
754	}
755	}
756
757	// remove the tool from the list
758	lstRemoveNode(&pttd->llTools, pToolNode);
759
760	break;
761	}
762
763	pToolNode = pToolNode->pNext;
764	// fixed endless loop V0.9.13 (2001-06-21) [umoeller]
765	}
766	}
767	}
768
769	/*
770	*@@ TtmRelayEvent:
771	* implementation for TTM_RELAYEVENT in ctl_fnwpTooltip.
772	*
773	*@@added V0.9.13 (2001-06-21) [umoeller]
774	*@@changed V0.9.19 (2002-05-14) [umoeller]: fixed bad stop timer, thanks yuri
775	*/
776
777	STATIC VOID TtmRelayEvent(HWND hwndTooltip, MPARAM mp2)
778	{
779	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
780	PQMSG pqmsg = (PQMSG)mp2;
781	if (pqmsg)
782	{
783	POINTL ptlPointer;
784	PLISTNODE pToolNode;
785
786	// moved stop timer down V0.9.19 (2002-05-14) [umoeller]
787
788	WinQueryPointerPos(HWND_DESKTOP, &ptlPointer);
789
790	// find TOOLINFO from mouse position
791	pttd->ptiMouseOver = NULL;
792	pToolNode = lstQueryFirstNode(&pttd->llTools);
793	while (pToolNode)
794	{
795	PTOOLINFO pti = (PTOOLINFO)pToolNode->pItemData;
796	if (pti->hwndTool == pqmsg->hwnd)
797	{
798	// _Pmpf((__FUNCTION__ ": found tool"));
799	pttd->ptiMouseOver = pti;
800	break;
801	}
802	pToolNode = pToolNode->pNext;
803	}
804
805	if ( (ptlPointer.x != pttd->ptlPointerLast.x)
806	\|\| (ptlPointer.y != pttd->ptlPointerLast.y)
807	\|\| (pqmsg->msg == WM_BUTTON1DOWN)
808	\|\| (pqmsg->msg == WM_BUTTON2DOWN)
809	\|\| (pqmsg->msg == WM_BUTTON3DOWN)
810	)
811	{
812	// mouse pos changed:
813	// moved stop timer here V0.9.19 (2002-05-14) [umoeller]
814	if (pttd->idTimerInitial)
815	{
816	// _Pmpf(("TTM_RELAYEVENT: Stopping timer: %d", pttd->idTimerInitial));
817	WinStopTimer(pttd->hab,
818	hwndTooltip,
819	TOOLTIP_ID_TIMER_INITIAL);
820	pttd->idTimerInitial = 0;
821	}
822
823	// hide tooltip
824	WinPostMsg(hwndTooltip,
825	TTM_SHOWTOOLTIPNOW,
826	(MPARAM)FALSE,
827	0);
828	memcpy(&pttd->ptlPointerLast, &ptlPointer, sizeof(POINTL));
829
830	// _Pmpf((__FUNCTION__ ": pttd->ptiMouseOver: 0x%lX", pttd->ptiMouseOver));
831	// _Pmpf((__FUNCTION__ ": pttd->fIsActive: 0x%lX", pttd->fIsActive));
832	if ( (pttd->ptiMouseOver)
833	&& (pttd->fIsActive)
834	)
835	{
836	// tool found and tooltip is activated:
837	pttd->idTimerInitial = WinStartTimer(pttd->hab,
838	hwndTooltip,
839	TOOLTIP_ID_TIMER_INITIAL,
840	pttd->ulTimeoutInitial);
841	// _Pmpf(("TTM_RELAYEVENT: Started timer: %d", pttd->idTimerInitial));
842	}
843	}
844	} // end if (pqmsg)
845	}
846
847	/*
848	*@@ TtmGetDelayTime:
849	* implementation for TTM_GETDELAYTIME in ctl_fnwpTooltip.
850	*
851	*@@added V0.9.13 (2001-06-21) [umoeller]
852	*/
853
854	STATIC MRESULT TtmGetDelayTime(HWND hwndTooltip, MPARAM mp1)
855	{
856	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
857	switch ((ULONG)mp1)
858	{
859	case TTDT_AUTOPOP:
860	return (MRESULT)pttd->ulTimeoutAutopop;
861
862	case TTDT_INITIAL:
863	return (MRESULT)pttd->ulTimeoutInitial;
864
865	case TTDT_RESHOW:
866	return (MRESULT)pttd->ulTimeoutReshow;
867	}
868
869	return (0);
870	}
871
872	/*
873	*@@ TtmSetDelayTime:
874	* implementation for TTM_SETDELAYTIME in ctl_fnwpTooltip.
875	*
876	*@@added V0.9.13 (2001-06-21) [umoeller]
877	*/
878
879	STATIC VOID TtmSetDelayTime(HWND hwndTooltip, MPARAM mp1, MPARAM mp2)
880	{
881	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
882	ULONG iDelay = (ULONG)mp2;
883	switch (SHORT1FROMMP(mp1))
884	{
885	case TTDT_AUTOMATIC:
886	pttd->ulTimeoutInitial = iDelay;
887	pttd->ulTimeoutAutopop = iDelay * 5;
888	pttd->ulTimeoutReshow = iDelay / 2;
889	break;
890
891	case TTDT_AUTOPOP:
892	pttd->ulTimeoutAutopop = iDelay;
893	break;
894
895	case TTDT_INITIAL:
896	pttd->ulTimeoutInitial = iDelay;
897	break;
898
899	case TTDT_RESHOW:
900	pttd->ulTimeoutReshow = iDelay;
901	break;
902	}
903	}
904
905	/*
906	*@@ TtmGetText:
907	* implementation for TTM_GETTEXT in ctl_fnwpTooltip.
908	*
909	*@@added V0.9.13 (2001-06-21) [umoeller]
910	*/
911
912	STATIC VOID TtmGetText(HWND hwndTooltip, MPARAM mp2)
913	{
914	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
915	PTOOLINFO pti = (PTOOLINFO)mp2;
916
917	if (pti->pszText == PSZ_TEXTCALLBACK)
918	{
919	// TTN_NEEDTEXT notification desired:
920	// compose values for that msg
921	TOOLTIPTEXT ttt = {0};
922	ttt.hwndTooltip = hwndTooltip;
923	ttt.hwndTool = pti->hwndTool;
924	WinSendMsg(pti->hwndToolOwner,
925	WM_CONTROL,
926	MPFROM2SHORT(pttd->usTooltipID, // tooltip control wnd ID
927	TTN_NEEDTEXT),
928	&ttt);
929
930	// in case of error: set lpszText to NULL; this
931	// is not specified in the docs however.
932	pti->pszText = NULL;
933
934	switch (ttt.ulFormat)
935	{
936	case TTFMT_PSZ:
937	if (ttt.pszText)
938	pti->pszText = ttt.pszText;
939	break;
940
941	case TTFMT_STRINGRES:
942	// @@todo
943	break;
944	}
945	}
946	}
947
948	/*
949	*@@ TtmEnumTools:
950	* implementation for TTM_ENUMTOOLS in ctl_fnwpTooltip.
951	*
952	*@@added V0.9.13 (2001-06-21) [umoeller]
953	*/
954
955	STATIC MRESULT TtmEnumTools(HWND hwndTooltip, MPARAM mp1, MPARAM mp2)
956	{
957	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
958	PTOOLINFO ptiTarget;
959	if (ptiTarget = (PTOOLINFO)mp2)
960	{
961	PTOOLINFO ptiFound = (PTOOLINFO)lstItemFromIndex(&pttd->llTools,
962	SHORT1FROMMP(mp1));
963	if (ptiFound)
964	{
965	memcpy(ptiTarget, ptiFound, sizeof(TOOLINFO));
966	return (MRESULT)TRUE;
967	}
968	}
969
970	return (MRESULT)FALSE;
971	}
972
973	/*
974	*@@ TtmGetCurrentTool:
975	* implementation for TTM_GETCURRENTTOOL in ctl_fnwpTooltip.
976	*
977	*@@added V0.9.13 (2001-06-21) [umoeller]
978	*/
979
980	STATIC MRESULT TtmGetCurrentTool(HWND hwndTooltip, MPARAM mp2)
981	{
982	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
983	PTOOLINFO ptiTarget;
984	if (ptiTarget = (PTOOLINFO)mp2)
985	{
986	if (pttd->ptiMouseOver)
987	{
988	memcpy(ptiTarget, pttd->ptiMouseOver, sizeof(TOOLINFO));
989	return (MRESULT)TRUE;
990	}
991	}
992
993	return (MRESULT)FALSE;
994	}
995
996	/*
997	*@@ TtmGetToolInfo:
998	* implementation for TTM_GETTOOLINFO in ctl_fnwpTooltip.
999	*
1000	*@@added V0.9.13 (2001-06-21) [umoeller]
1001	*/
1002
1003	STATIC MRESULT TtmGetToolInfo(HWND hwndTooltip, MPARAM mp2)
1004	{
1005	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
1006	PTOOLINFO ptiSearch;
1007	if (ptiSearch = (PTOOLINFO)mp2)
1008	{
1009	PLISTNODE pToolNode = lstQueryFirstNode(&pttd->llTools);
1010	while (pToolNode)
1011	{
1012	PTOOLINFO ptiThis = (PTOOLINFO)pToolNode->pItemData;
1013	if ( (ptiThis->hwndToolOwner == ptiSearch->hwndToolOwner)
1014	&& (ptiThis->hwndTool == ptiSearch->hwndTool)
1015	)
1016	{
1017	// found:
1018	memcpy(ptiSearch, ptiThis, sizeof(TOOLINFO));
1019	return (MPARAM)TRUE;
1020	}
1021	pToolNode = pToolNode->pNext;
1022	}
1023	}
1024
1025	return ((MPARAM)FALSE);
1026	}
1027
1028	/*
1029	*@@ FormatTooltip:
1030	* formats the tooltip window according to
1031	* its text (which is assumed to be in
1032	* pttd->pszPaintText) and positions it
1033	* on the screen.
1034	*
1035	* This does not change the visibility
1036	* of the tooltip; if it is not yet visible,
1037	* you must show it afterwards.
1038	*
1039	*@@added V0.9.13 (2001-06-21) [umoeller]
1040	*/
1041
1042	STATIC VOID FormatTooltip(HWND hwndTooltip,
1043	PTOOLTIPDATA pttd,
1044	PPOINTL pptlPointer) // in: current pointer pos or NULL
1045	{
1046	// find out how much space we need
1047	RECTL rcl = { 0, 0, 300, 1000 };
1048	POINTL ptlTooltip;
1049	LONG cx, cy;
1050	ULONG ulStyle = WinQueryWindowULong(hwndTooltip, QWL_STYLE);
1051
1052	HPS hps = WinGetPS(hwndTooltip);
1053
1054	winhDrawFormattedText(hps,
1055	&rcl,
1056	pttd->pszPaintText,
1057	DT_LEFT \| DT_TOP \| DT_WORDBREAK \| DT_QUERYEXTENT);
1058	WinReleasePS(hps);
1059
1060	// calc width and height of tooltip
1061	cx = rcl.xRight + 2*TOOLTIP_CX_BORDER;
1062	cy = (rcl.yTop - rcl.yBottom) + 2*TOOLTIP_CY_BORDER;
1063
1064	// calc x and y pos of tooltip:
1065
1066	// per default, use pointer pos
1067	ptlTooltip.x = pptlPointer->x - cx/2;
1068	ptlTooltip.y = pptlPointer->y - cy;
1069
1070	// do we need the tool's position?
1071	if ( pttd->ptiMouseOver->ulFlags
1072	& (TTF_CENTER_X_ON_TOOL \| TTF_POS_Y_ABOVE_TOOL \| TTF_POS_Y_BELOW_TOOL)
1073	)
1074	{
1075	// yes:
1076	SWP swpTool;
1077	POINTL ptlTool;
1078	WinQueryWindowPos(pttd->ptiMouseOver->hwndTool, &swpTool);
1079	ptlTool.x = swpTool.x;
1080	ptlTool.y = swpTool.y;
1081	// convert x, y to desktop points
1082	WinMapWindowPoints(WinQueryWindow(pttd->ptiMouseOver->hwndTool,
1083	QW_PARENT), // hwndFrom
1084	HWND_DESKTOP, // hwndTo
1085	&ptlTool,
1086	1);
1087
1088	// X
1089	if (pttd->ptiMouseOver->ulFlags & TTF_CENTER_X_ON_TOOL)
1090	// center X on tool:
1091	ptlTooltip.x = ptlTool.x + ((swpTool.cx - cx) / 2L);
1092
1093	// Y
1094	if (pttd->ptiMouseOver->ulFlags & TTF_POS_Y_ABOVE_TOOL)
1095	ptlTooltip.y = ptlTool.y + swpTool.cy;
1096	else if (pttd->ptiMouseOver->ulFlags & TTF_POS_Y_BELOW_TOOL)
1097	ptlTooltip.y = ptlTool.y - cy;
1098	}
1099
1100	// if "shy mouse" is enabled, make
1101	// sure the tool tip is not under the
1102	// mouse pointer
1103	if (ulStyle & TTF_SHYMOUSE)
1104	{
1105	// we need to subtract the current mouse
1106	// pointer's hot spot from the current
1107	// pointer position
1108	HPOINTER hptr = WinQueryPointer(HWND_DESKTOP);
1109	POINTERINFO pi;
1110	if (WinQueryPointerInfo(hptr, &pi))
1111	{
1112	// calc bottom edge of mouse pointer rect
1113	ULONG yBottomPointer = (pptlPointer->y - pi.yHotspot);
1114	// _Pmpf(("yHotspot: %d", pi.yHotspot));
1115	if ( (ptlTooltip.y + cy) // top edge of tool tip
1116	> yBottomPointer
1117	)
1118	{
1119	ptlTooltip.y = pptlPointer->y - cy - pi.yHotspot;
1120	}
1121	}
1122	}
1123
1124	// constrain to screen
1125	if (ptlTooltip.x < 0)
1126	ptlTooltip.x = 0;
1127	if (ptlTooltip.y < 0)
1128	ptlTooltip.y = 0;
1129	if (ptlTooltip.x + cx > G_cxScreen)
1130	ptlTooltip.x = G_cxScreen - cx;
1131	if (ptlTooltip.y + cy > G_cyScreen)
1132	ptlTooltip.y = G_cyScreen - cy;
1133
1134	// if shadow is enabled,
1135	// enlarge; the shadow might by
1136	// off-screen now, but that's OK
1137	if (ulStyle & TTS_SHADOW)
1138	{
1139	cx += TT_SHADOWOFS;
1140	cy += TT_SHADOWOFS;
1141	ptlTooltip.y -= TT_SHADOWOFS;
1142	}
1143
1144	// set tooltip position at the pos we calculated
1145	// and show tooltip
1146	WinSetWindowPos(hwndTooltip,
1147	HWND_TOP,
1148	ptlTooltip.x,
1149	ptlTooltip.y,
1150	cx,
1151	cy,
1152	SWP_MOVE \| SWP_SIZE \| SWP_ZORDER);
1153	}
1154
1155	/*
1156	*@@ TtmUpdateTipText:
1157	* implementation for TTM_UPDATETIPTEXT in ctl_fnwpTooltip.
1158	*
1159	*@@added V0.9.13 (2001-06-21) [umoeller]
1160	*/
1161
1162	STATIC VOID TtmUpdateTipText(HWND hwndTooltip,
1163	const char *pcszNewText)
1164	{
1165	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
1166
1167	// has text really changed?
1168	if ( ( (pttd->pszPaintText)
1169	&& (pcszNewText)
1170	&& (strcmp(pttd->pszPaintText, pcszNewText))
1171	)
1172	\|\| (pttd->pszPaintText && !pcszNewText)
1173	\|\| (!pttd->pszPaintText && pcszNewText)
1174	)
1175	{
1176	// yes:
1177	if (pttd->pszPaintText)
1178	{
1179	free(pttd->pszPaintText);
1180	pttd->pszPaintText = NULL;
1181	}
1182
1183	if (pcszNewText)
1184	pttd->pszPaintText = strdup(pcszNewText);
1185
1186	if (pttd->fIsVisible)
1187	{
1188	// currently showing:
1189	// reformat
1190	POINTL ptlPointer;
1191	WinQueryPointerPos(HWND_DESKTOP, &ptlPointer);
1192	FormatTooltip(hwndTooltip,
1193	pttd,
1194	&ptlPointer);
1195	WinInvalidateRect(hwndTooltip, NULL, FALSE);
1196	}
1197	}
1198	}
1199
1200	/*
1201	*@@ TtmShowTooltip:
1202	* implementation for TTM_SHOW_TOOLTIP.
1203	*
1204	* Depending on fShow, this shows or hides the
1205	* tool tip at the position specified by the
1206	* current tool or the mouse pointer (specified
1207	* by the tool's style flags).
1208	*
1209	*@@added V0.9.1 (2000-02-04) [umoeller]
1210	*/
1211
1212	STATIC VOID TtmShowTooltip(HWND hwndTooltip,
1213	BOOL fShow) // if TRUE: show, else: HIDE
1214	{
1215	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
1216	if (fShow)
1217	{
1218	/*
1219	* show tooltip::
1220	*
1221	*/
1222
1223	POINTL ptlPointer;
1224	// HPS hps;
1225
1226	// free old text
1227	if (pttd->pszPaintText)
1228	{
1229	free(pttd->pszPaintText);
1230	pttd->pszPaintText = NULL;
1231	}
1232
1233	WinQueryPointerPos(HWND_DESKTOP, &ptlPointer);
1234
1235	if ( (ptlPointer.x == pttd->ptlPointerLast.x)
1236	&& (ptlPointer.y == pttd->ptlPointerLast.y)
1237	)
1238	{
1239	// mouse not moved since timer was started:
1240	// find the current TOOLINFO
1241	if (pttd->ptiMouseOver)
1242	{
1243	TOOLINFO tiTemp;
1244	memcpy(&tiTemp, pttd->ptiMouseOver, sizeof(TOOLINFO));
1245	// get the text for the TOOLINFO
1246	WinSendMsg(hwndTooltip,
1247	TTM_GETTEXT,
1248	(MPARAM)0,
1249	(MPARAM)&tiTemp);
1250	if (tiTemp.pszText)
1251	pttd->pszPaintText = strdup(tiTemp.pszText);
1252	else
1253	pttd->pszPaintText = NULL;
1254	}
1255
1256	if (pttd->pszPaintText)
1257	{
1258	FormatTooltip(hwndTooltip,
1259	pttd,
1260	&ptlPointer);
1261
1262	// notify owner (TTN_SHOW)
1263	WinSendMsg(pttd->hwndOwner,
1264	WM_CONTROL,
1265	MPFROM2SHORT(pttd->usTooltipID, // tooltip control wnd ID
1266	TTN_SHOW),
1267	pttd->ptiMouseOver);
1268
1269	WinShowWindow(hwndTooltip, TRUE);
1270	pttd->fIsVisible = TRUE;
1271
1272	// start autopop timer
1273	pttd->idTimerAutopop = WinStartTimer(pttd->hab,
1274	hwndTooltip,
1275	TOOLTIP_ID_TIMER_AUTOPOP,
1276	pttd->ulTimeoutAutopop);
1277	} // end if (pttd->pszPaintText)
1278	} // end if ( (ptlPointer.x == pttd->ptlPointerLast.x)...
1279	} // end if (mp1)
1280	else
1281	{
1282	/*
1283	* hide tooltip::
1284	*
1285	*/
1286
1287	if (pttd->fIsVisible)
1288	{
1289	// notify owner (TTN_POP)
1290	WinSendMsg(pttd->hwndOwner,
1291	WM_CONTROL,
1292	MPFROM2SHORT(pttd->usTooltipID, // tooltip control wnd ID
1293	TTN_POP),
1294	pttd->ptiMouseOver);
1295	WinShowWindow(hwndTooltip, FALSE);
1296	}
1297
1298	// stop autopop timer
1299	if (pttd->idTimerAutopop)
1300	{
1301	WinStopTimer(pttd->hab,
1302	hwndTooltip,
1303	TOOLTIP_ID_TIMER_AUTOPOP);
1304	pttd->idTimerAutopop = 0;
1305	}
1306	}
1307
1308	// store new visibility
1309	pttd->fIsVisible = fShow;
1310	}
1311
1312	/*
1313	*@@ ctl_fnwpTooltip:
1314	* window procedure for the "tooltip" control. This control is
1315	* largely source-code compatible to the Win32 version and has
1316	* been modelled according to the Win32 programmer's reference.
1317	*
1318	* A tooltip control is a small pop-up window that displays a
1319	* single line of descriptive text giving the purpose of "tools"
1320	* in an application.
1321	* A "tool" is either a window, such as a child window or control,
1322	* or an application-defined rectangular area within a window.
1323	* See the TTM_ADDTOOL message for details.
1324	*
1325	* To clarify: There is usually one tooltip control, which is hidden
1326	* most of the time, for many "tools" (parts of a visible window).
1327	* When the user puts the cursor on a tool and leaves it there for
1328	* approximately one-half second, the tooltip control is set up for
1329	* that tool and made visible. The tooltip control appears near the
1330	* pointer and disappears when the user clicks a mouse button or moves
1331	* the pointer off of the tool.
1332	*
1333	* The Win32 concept has been extended with this implementation to
1334	* display even longer texts, including line breaks. The tooltip
1335	* window is formatted accordingly.
1336	*
1337	* All default window styles are ignored when you create the tooltip,
1338	* but will rather be set by this window proc automatically. The
1339	* only valid window styles are the TTS_* flags (see notes below).
1340	*
1341	* Presentation parameters are fully supported.
1342	*
1343	* To create a tooltip control using comctl.c, use
1344	+ ctlRegisterTooltip(hab);
1345	+ hwndTooltip = WinCreateWindow(HWND_DESKTOP, // parent
1346	+ WC_CCTL_TOOLTIP, // wnd class (comctl.h)
1347	+ NULL, // window text
1348	+ TTS_ALWAYSTIP, // window style, ignored except for TTS_* flags
1349	+ 0, 0, 0, 0, // window pos and size, ignored
1350	+ hwndOwner, // owner window -- important!
1351	+ NULLHANDLE, // hwndInsertBehind, ignored
1352	+ ulID, // window ID, optional
1353	+ NULL, // control data
1354	+ NULL); // presparams
1355	+
1356	* ctl_fnwpTooltip automatically sets the size, position, and visibility
1357	* of the tooltip control. The size of the tooltip window will vary
1358	* depending on the text to be displayed and on the font presentation
1359	* parameters, which are supported by this control (OS/2 only).
1360	*
1361	* Note: OS/2 normally does not destroy windows which are only owned by
1362	* another window. As a result, when the tooltip's owner is destroyed,
1363	* you must explicitly also destroy the tooltip window.
1364	*
1365	* Under both Win32 and OS/2, a tooltip control has two class-specific styles:
1366	*
1367	* -- TTS_ALWAYSTIP: the tooltip appears when the cursor is on a tool,
1368	* regardless of whether the tooltip control's owner window is active
1369	* or inactive. Without this style, the tooltip control appears when the
1370	* tool's owner window is active, but not when it is inactive.
1371	*
1372	* -- TTS_NOPREFIX: this prevents the system from stripping the ampersand (&)
1373	* character from a string. If a tooltip control does not have the TTS_NOPREFIX
1374	* style, the system automatically strips ampersand characters, allowing an
1375	* application to use the same string as both a menu item and tooltip text.
1376	*
1377	* The tooltip control can be (de)activated using the TTM_ACTIVATE message.
1378	*
1379	* To register tools with the tooltip control (to make it do anything
1380	* meaningful), send the TTM_ADDTOOL message to the tooltip control.
1381	*
1382	* This control supports the following presentation parameters (if the
1383	* PP_* value is not found, the SYSCLR_* system color is used):
1384	* -- PP_MENUBACKGROUNDCOLOR / SYSCLR_ENTRYFIELD: tooltip background color.
1385	* -- PP_MENUFOREGROUNDCOLOR / SYSCLR_WINDOWTEXT: tooltip text color.
1386	* -- PP_MENUHILITEFGNDCOLOR / SYSCLR_WINDOWTEXT: 3D border light color.
1387	* -- PP_MENUHILITEBGNDCOLOR / SYSCLR_WINDOWTEXT: 3D border dark color.
1388	* -- PP_FONTNAMESIZE: font to use for the tooltip. The default is "8.Helv"
1389	* on Warp 3 and "9.WarpSans" on Warp 4.
1390	*
1391	* So per default, if no presentation parameters are set, the control
1392	* paints the background like an entry field and the text and the border
1393	* in the same window text color (usually black).
1394	* The tooltip does _not_ inherit presentation parameters from the parent,
1395	* so unless you explicitly set presparams, the tooltip looks pretty much
1396	* like the Win32 counterpart (with the default system colors, black border
1397	* and text on yellow background).
1398	*
1399	*@@added V0.9.0 [umoeller]
1400	*@@changed V0.9.12 (2001-04-28) [umoeller]: various fixes WRT subclassing
1401	*/
1402
1403	MRESULT EXPENTRY ctl_fnwpTooltip(HWND hwndTooltip, ULONG msg, MPARAM mp1, MPARAM mp2)
1404	{
1405	MRESULT mrc = 0;
1406
1407	TRY_LOUD(excpt1)
1408	{
1409	switch (msg)
1410	{
1411	/*
1412	* WM_CREATE:
1413	* this message is sent to the window procedure of
1414	* the window being created, thus offering it an
1415	* opportunity to initialize that window.
1416	*
1417	* The window procedure receives this after the window
1418	* is created but before the window becomes visible.
1419	*/
1420
1421	case WM_CREATE:
1422	mrc = TtmCreate(hwndTooltip, mp2);
1423	break;
1424
1425	/*
1426	* WM_HITTEST:
1427	* since we have the CS_HITTEST class style set,
1428	* we get this message. We return HT_TRANSPARENT
1429	* always so the tooltip does not block mouse clicks
1430	* for the windows which lie below.
1431	*/
1432
1433	case WM_HITTEST: // done
1434	mrc = (MPARAM)HT_TRANSPARENT;
1435	break;
1436
1437	/*
1438	* WM_TIMER:
1439	* posted when either the "initial" timer
1440	* or the "autopop" timer times out.
1441	* We'll show or hide the tooltip then.
1442	*/
1443
1444	case WM_TIMER: // done
1445	if (!TtmTimer(hwndTooltip, mp1))
1446	mrc = WinDefWindowProc(hwndTooltip, msg, mp1, mp2);
1447	break;
1448
1449	/*
1450	* WM_PAINT:
1451	*
1452	*/
1453
1454	case WM_PAINT: // done
1455	TtmPaint(hwndTooltip);
1456	break;
1457
1458	/*
1459	* WM_PRESPARAMCHANGED:
1460	* presentation parameter has changed.
1461	*/
1462
1463	case WM_PRESPARAMCHANGED:
1464
1465	switch ((LONG)mp1) // pp index
1466	{
1467	case 0: // layout palette thing dropped
1468	case PP_MENUBACKGROUNDCOLOR:
1469	case PP_MENUFOREGROUNDCOLOR:
1470	case PP_MENUHILITEFGNDCOLOR:
1471	case PP_MENUHILITEBGNDCOLOR:
1472	// re-query our presparams
1473	UpdateTooltipPresColors(hwndTooltip);
1474	}
1475
1476	break;
1477
1478	/*
1479	* WM_SYSCOLORCHANGE:
1480	* system color has changed.
1481	*/
1482
1483	case WM_SYSCOLORCHANGE:
1484	UpdateTooltipPresColors(hwndTooltip);
1485	break;
1486
1487	/*
1488	* WM_DESTROY:
1489	* clean up upon destruction.
1490	*/
1491
1492	case WM_DESTROY:
1493	TtmDestroy(hwndTooltip);
1494	break;
1495
1496	/*
1497	*@@ TTM_ACTIVATE:
1498	* activates or deactives the tooltip control.
1499	*
1500	* Parameters:
1501	* -- BOOL mp1: if TRUE, activate, if FALSE, deactivate.
1502	* -- mp2: always 0.
1503	*
1504	* Return value: 0 always.
1505	*/
1506
1507	case TTM_ACTIVATE: // done
1508	{
1509	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
1510	if (!(pttd->fIsActive = (BOOL)mp1))
1511	// disable: hide tooltip
1512	WinPostMsg(hwndTooltip, TTM_SHOWTOOLTIPNOW, (MPARAM)FALSE, 0);
1513	}
1514	break;
1515
1516	/*
1517	*@@ TTM_ADDTOOL:
1518	* registers a tool with a tooltip control.
1519	*
1520	* Parameters:
1521	* -- mp1: always 0.
1522	* -- PTOOLINFO mp2: information about the tool.
1523	*
1524	* Return value: TRUE if successful or FALSE otherwise.
1525	*
1526	* A tooltip control can support any number of tools. To
1527	* support a particular tool, you must register the tool
1528	* with the tooltip control by sending the TTM_ADDTOOL
1529	* message to the tooltip control. The message includes
1530	* the address of a TOOLINFO structure, which provides
1531	* information the tooltip control needs to display text
1532	* for the tool.
1533	*
1534	* A tooltip control supports tools implemented as windows
1535	* (such as child windows or control windows) and as
1536	* rectangular areas within a window's client area.
1537	*
1538	* -- When you add a tool implemented as a rectangular
1539	* area, the "hwndToolOwner" member of TOOLINFO must
1540	* specify the handle of the window that contains the
1541	* area, and the "rect" member must specify the client
1542	* coordinates of the area's bounding rectangle.
1543	*
1544	* -- When you add a tool implemented as a window, the
1545	* "hwndTool" member of TOOLINFO must contain the
1546	* window handle of the tool. hwndToolOwner should be
1547	* the owner of the tool.
1548	*
1549	* When you add a tool to a tooltip control, the "pszText"
1550	* member of the TOOLINFO structure must specify the string
1551	* to display for the tool. You can change the text any time
1552	* after adding the tool by using the TTM_UPDATETIPTEXT message.
1553	*
1554	* If you specify the PSZ_TEXTCALLBACK value in the pszText
1555	* member, whenever the tooltip control needs the text for the
1556	* tool, it sends a WM_CONTROL message to hwndToolOwner with
1557	* the TTN_NEEDTEXT notification code.
1558	*
1559	* The message includes the address of a TOOLTIPTEXT structure,
1560	* which contains the window handle of the tool. You can then
1561	* fill the TOOLTIPTEXT structure with the tool text.
1562	*
1563	* To retrieve the text for a tool, use the TTM_GETTEXT message.
1564	*
1565	*@@todo: add tool rectangles
1566	*/
1567
1568	case TTM_ADDTOOL: // done
1569	mrc = TtmAddTool(hwndTooltip, mp2);
1570	break;
1571
1572	/*
1573	*@@ TTM_DELTOOL:
1574	* removes a tool from a tooltip control.
1575	*
1576	* Parameters:
1577	* -- mp1: always 0.
1578	* -- PTOOLINFO mp2: information about the tool;
1579	* all fields except cbSize, hwndToolOwner,
1580	* and hwndTool are ignored.
1581	*
1582	* Return value: 0 always.
1583	*/
1584
1585	case TTM_DELTOOL: // done
1586	TtmDelTool(hwndTooltip, mp2);
1587	break;
1588
1589	/*
1590	*@@ TTM_NEWTOOLRECT:
1591	* sets a new bounding rectangle for a tool
1592	* already registered with a tooltip control.
1593	*
1594	* Parameters:
1595	* -- mp1: always 0.
1596	* -- PTOOLINFO mp2: information about the tool;
1597	* all fields except hwnd, uID, and rect
1598	* are ignored.
1599	*
1600	* Return value: 0 always.
1601	*
1602	* If an application includes a tool implemented as a rectangular
1603	* area and the size or position of the control changes, it can
1604	* use the TTM_NEWTOOLRECT message to report the change to the
1605	* tooltip control. An application does not need to report size
1606	* and position changes for a tool implemented as a window.
1607	* Reporting that is not necessary because the tooltip control
1608	* uses the window handle of a tool to determine if the cursor
1609	* is on the tool, not the tool's bounding rectangle.
1610	*/
1611
1612	case TTM_NEWTOOLRECT:
1613
1614	break;
1615
1616	/*
1617	*@@ TTM_RELAYEVENT:
1618	* passes a mouse message to a tooltip control
1619	* for further processing.
1620	*
1621	* Parameters:
1622	* -- mp1: always 0.
1623	* -- PQMSG mp2: pointer to a QMSG struct (Win95: MSG struct)
1624	* containing a mouse message. Only the above messages
1625	* are processed.
1626	*
1627	* Return value: 0 always.
1628	*
1629	* A tooltip control needs to receive mouse messages to determine
1630	* when to display the tooltip window. Because mouse messages are
1631	* sent only to the window that contains the cursor, you must
1632	* use the TTM_RELAYEVENT message to relay mouse messages to the
1633	* tooltip control.
1634	*
1635	* If a tool is implemented as a rectangular area in an
1636	* application-defined window, the window procedure receives all
1637	* mouse messages and can relay the ones listed below to the
1638	* tooltip control, using this message.
1639	*
1640	* However, if a tool is implemented as a system-defined window,
1641	* the mouse messages are sent to that window and are not readily
1642	* available to the application. There are two ways you can have
1643	* the tooltip control notified of these mouse messages:
1644	*
1645	* -- You can specify the TTF_SUBCLASS flag when adding the tool
1646	* to the tooltip control. The tooltip control will then subclass
1647	* the tool window to get mouse-related messages, and you're off.
1648	*
1649	* -- You can implement a message hook for your process and check
1650	* for your tool windows there and send TTM_RELAYEVENT to the
1651	* tooltip control. In that case, you need to intercept the
1652	* messages specified below.
1653	*
1654	* When a tooltip control receives a relayed WM_MOUSEMOVE message,
1655	* it determines whether the cursor is in the bounding rectangle of
1656	* a tool. If the cursor is there, the tooltip control sets a timer.
1657	* At the end of the time-out duration, the tooltip control checks
1658	* the position of the cursor to see whether it has moved. If the
1659	* cursor has not, the tooltip control retrieves the text for the tool,
1660	* copies the text into the tooltip window, and shows the window.
1661	* The tooltip control continues to show the window until it receives
1662	* a relayed button-up or button-down message or until a relayed
1663	* WM_MOUSEMOVE message indicates that the cursor has moved outside
1664	* the bounding rectangle of the tool.
1665	*
1666	* For the timer descriptions, see TTM_SETDELAYTIME.
1667	*
1668	* When it is about to be displayed, a tootip control sends the
1669	* TTN_SHOW notification to the owner window. A tooltip control
1670	* sends the TTN_POP notification when it is about to be hidden.
1671	* Each notification is sent in the context of a WM_NOTIFY message
1672	* (OS/2: WM_CONTROL).
1673	*
1674	* Relevant messages:
1675	* -- WM_MOUSEMOVE
1676	* -- WM_BUTTON1DOWN (Win95: WM_LBUTTONDOWN)
1677	* -- WM_BUTTON1UP (Win95: WM_LBUTTONUP)
1678	* -- WM_BUTTON2DOWN (Win95: WM_RBUTTONDOWN)
1679	* -- WM_BUTTON2UP (Win95: WM_RBUTTONUP)
1680	* -- WM_BUTTON3DOWN (Win95: WM_MBUTTONDOWN)
1681	* -- WM_BUTTON3UP (Win95: WM_MBUTTONUP)
1682	*/
1683
1684	case TTM_RELAYEVENT:
1685	TtmRelayEvent(hwndTooltip, mp2);
1686	break;
1687
1688	/*
1689	*@@ TTM_GETDELAYTIME:
1690	* returns the current value of the specified
1691	* timeout value. See TTM_SETDELAYTIME.
1692	*
1693	* Parameters:
1694	*
1695	* -- USHORT mp1: timer value to query. One of:
1696	* -- TTDT_AUTOPOP
1697	* -- TTDT_INITIAL
1698	* -- TTDT_RESHOW
1699	*
1700	* Returns: ULONG timeout value.
1701	*
1702	*@@added V0.9.12 (2001-04-28) [umoeller]
1703	*/
1704
1705	case TTM_GETDELAYTIME:
1706	mrc = TtmGetDelayTime(hwndTooltip, mp1);
1707	break;
1708
1709	/*
1710	*@@ TTM_SETDELAYTIME:
1711	* overrides a few default timeout values for the
1712	* tooltip control.
1713	*
1714	* A tooltip control actually has three time-out durations
1715	* associated with it. The initial duration is the length
1716	* of time that the cursor must remain stationary within
1717	* the bounding rectangle of a tool before the tooltip window
1718	* is displayed. The reshow duration is the length of the delay
1719	* before subsequent tooltip windows are displayed when the
1720	* cursor moves from one tool to another. The autopopup duration
1721	* is the length of time that the tooltip window remains
1722	* displayed before it is hidden. That is, if the cursor remains
1723	* stationary within the bounding rectangle after the tooltip
1724	* window is displayed, the tooltip window is automatically
1725	* hidden at the end of the autopopup duration.
1726	*
1727	* You can adjust all of the time-out durations by using this
1728	* message.
1729	*
1730	* Parameters:
1731	* -- USHORT mp1: parameter selection. One of the following:
1732	* -- TTDT_AUTOMATIC: automatically calculates the initial,
1733	* reshow, and autopopup durations based on the value of mp2.
1734	* -- TTDT_AUTOPOP: sets the length of time before the tooltip
1735	* window is hidden if the cursor remains stationary
1736	* in the tool's bounding rectangle after the tooltip window
1737	* has appeared.
1738	* -- TTDT_INITIAL: sets the length of time that the cursor must
1739	* remain stationary within the bounding rectangle of
1740	* a tool before the tooltip window is displayed.
1741	* -- TTDT_RESHOW: sets the length of the delay before subsequent
1742	* tooltip windows are displayed when the cursor is moved
1743	* from one tool to another.
1744	* -- ULONG mp2: new duration, in milliseconds.
1745	*
1746	* Return value: 0 always.
1747	*/
1748
1749	case TTM_SETDELAYTIME: // done
1750	TtmSetDelayTime(hwndTooltip, mp1, mp2);
1751	break;
1752
1753	/*
1754	*@@ TTM_GETTEXT:
1755	* retrieves the text for a tool in the tooltip control.
1756	*
1757	* Parameters:
1758	* -- mp1: always 0
1759	* -- PTOOLINFO mp2: pointer to a TOOLINFO structure.
1760	* hwndTool identifies a tool. If the tooltip control
1761	* includes the tool, the pszText member receives
1762	* the pointer to the string on output.
1763	*
1764	* Return value: 0 always.
1765	*
1766	* Additional note: On input, if TOOLINFO.lpszText == PSZ_TEXTCALLBACK,
1767	* this sends the TTN_NEEDTEXT notification to TOOLINFO.hwnd.
1768	*
1769	*/
1770
1771	case TTM_GETTEXT: // done, I think
1772	TtmGetText(hwndTooltip, mp2);
1773	break;
1774
1775	/*
1776	*@@ TTM_UPDATETIPTEXT:
1777	* sets the current tooltip text explicitly,
1778	* no matter for what tool the tooltip is
1779	* currently being displayed. This might be
1780	* useful if you want to dynamically update
1781	* the tooltip display.
1782	*
1783	* If the tooltip is currently showing,
1784	* it is reformatted with the new text.
1785	*
1786	* Note that the change is not permanent;
1787	* if the mouse moves over a different
1788	* tool next, the change will be lost.
1789	*
1790	* Parameters:
1791	* -- PSZ mp1: new text to display.
1792	*
1793	*@@added V0.9.13 (2001-06-21) [umoeller]
1794	*/
1795
1796	case TTM_UPDATETIPTEXT:
1797	TtmUpdateTipText(hwndTooltip, (PSZ)mp1);
1798	break;
1799
1800	/*
1801	*@@ TTM_HITTEST:
1802	* tests a point to determine whether it is within the
1803	* bounding rectangle of the specified tool and, if the
1804	* point is within, retrieves information about the tool.
1805	*
1806	* Parameters:
1807	* -- mp1: always 0.
1808	* -- PHITTESTINFO mp2: pointer to a TTHITTESTINFO structure.
1809	* When sending the message, the "hwnd" member must specify
1810	* the handle of a tool and the "pt" member must specify the
1811	* coordinates of a point. If the return value is TRUE, the
1812	* "ti" member receives information about the tool that
1813	* occupies the point.
1814	*
1815	* Return value: returns TRUE if the tool occupies the specified
1816	* point or FALSE otherwise.
1817	*/
1818
1819	case TTM_HITTEST:
1820	break;
1821
1822	/*
1823	*@@ TTM_WINDOWFROMPOINT:
1824	* this message allows a subclass procedure to cause a tooltip
1825	* to display text for a window other than the one beneath the
1826	* mouse cursor.
1827	*
1828	* Parameters:
1829	* -- mp1: always 0.
1830	* -- mp2: PPOINTL lppt (Win95: (POINT FAR *)lppt):
1831	* pointer to a POINTL structure that defines the point to be checked.
1832	*
1833	* Return value: the handle to the window that contains the point, or
1834	* NULL if no window exists at the specified point.
1835	*
1836	* This message is intended to be processed by an application that
1837	* subclasses a tooltip. It is not intended to be sent by an
1838	* application. A tooltip sends this message to itself before
1839	* displaying the text for a window. By changing the coordinates
1840	* of the point specified by lppt, the subclass procedure can cause
1841	* the tooltip to display text for a window other than the one
1842	* beneath the mouse cursor.
1843	*/
1844
1845	case TTM_WINDOWFROMPOINT:
1846	break;
1847
1848	/*
1849	*@@ TTM_ENUMTOOLS:
1850	* this message retrieves the information that a tooltip control
1851	* maintains about a certain tool.
1852	*
1853	* Parameters:
1854	* -- USHORT mp1: zero-based index of the tool for which to
1855	* retrieve information.
1856	* -- PTOOLINFO mp2: pointer to a TOOLINFO structure that
1857	* receives information about the tool. Before sending
1858	* this message, the cbSize member must specify the size
1859	* of the structure.
1860	*
1861	* Return value: TRUE if any tools are enumerated or FALSE otherwise.
1862	*/
1863
1864	case TTM_ENUMTOOLS: // done
1865	mrc = TtmEnumTools(hwndTooltip, mp1, mp2);
1866	break;
1867
1868	/*
1869	*@@ TTM_GETCURRENTTOOL:
1870	* this message retrieves the information that the
1871	* tooltip control maintains for the _current_ tool;
1872	* that is, the one for which the tooltip control
1873	* is currently displaying text.
1874	*
1875	* Parameters:
1876	* -- mp1: always 0.
1877	* -- PTOOLINFO mp2: pointer to a TOOLINFO structure that receives
1878	* information about the current tool.
1879	*
1880	* Return value: TRUE if successful or FALSE otherwise.
1881	*/
1882
1883	case TTM_GETCURRENTTOOL: // done
1884	mrc = TtmGetCurrentTool(hwndTooltip, mp2);
1885	break;
1886
1887	/*
1888	*@@ TTM_GETTOOLCOUNT:
1889	* returns the number of tools in the tooltip control.
1890	*
1891	* No parameters.
1892	*/
1893
1894	case TTM_GETTOOLCOUNT: // done
1895	{
1896	PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
1897	mrc = (MPARAM)lstCountItems(&pttd->llTools);
1898	}
1899	break;
1900
1901	/*
1902	*@@ TTM_GETTOOLINFO:
1903	* this message retrieves the information that a tooltip
1904	* control maintains about a tool.
1905	*
1906	* Parameters:
1907	* -- mp1: always 0.
1908	* -- PTOOLINFO mp2:
1909	* pointer to a TOOLINFO structure. When sending the message,
1910	* the hwnd and uId members identify a tool, and the cbSize
1911	* member must specify the size of the structure. If the
1912	* tooltip control includes the tool, the structure receives
1913	* information about the tool.
1914	*
1915	* Return value: TRUE if successful or FALSE otherwise.
1916	*/
1917
1918	case TTM_GETTOOLINFO: // done
1919	mrc = TtmGetToolInfo(hwndTooltip, mp2);
1920	break;
1921
1922	/*
1923	*@@ TTM_SETTOOLINFO:
1924	* this message sets the information that a tooltip control
1925	* maintains for a tool.
1926	*
1927	* Parameters:
1928	* -- mp1: always 0.
1929	* -- PTOOLINFO mp2: pointer to a TOOLINFO structure that
1930	* specifies the information to set.
1931	*
1932	* Return value: 0 always.
1933	*/
1934
1935	case TTM_SETTOOLINFO:
1936	break;
1937
1938	/*
1939	*@@ TTM_SHOWTOOLTIPNOW:
1940	* depending on BOOL mp1, shows or hides the tooltip.
1941	* This is required because we cannot show or hide
1942	* the window during processing of WM_MOUSEMOVE etc,
1943	* which will lead to strange PM hangs.
1944	*
1945	* This is not part of the Win95 message set but used
1946	* in the OS/2 implementation only. This calls
1947	* TtmShowTooltip in turn.
1948	*/
1949
1950	case TTM_SHOWTOOLTIPNOW:
1951	TtmShowTooltip(hwndTooltip, (BOOL)mp1);
1952	break;
1953
1954	default:
1955	mrc = WinDefWindowProc(hwndTooltip, msg, mp1, mp2);
1956	}
1957	}
1958	CATCH(excpt1) {} END_CATCH();
1959
1960	return mrc;
1961	}
1962
1963

Note: See TracBrowser for help on using the repository browser.

Download in other formats: