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

Last change on this file since 286 was 255, checked in by umoeller, 22 years ago

Buncha fixes.

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