Changeset 282 for trunk/src/3rdparty/os2/xsystray/xsystray.c

Timestamp:

Nov 3, 2009, 2:39:49 AM (16 years ago)

Author:

Dmitry A. Kuminov

Message:

3rdparty: os2/xsystray: Added new xstReplaceSysTrayIcon() API call, implemented xstSetSysTrayIconToolTip() API call.

File:

• trunk/src/3rdparty/os2/xsystray/xsystray.c (modified) (15 diffs)

trunk/src/3rdparty/os2/xsystray/xsystray.c

@@ -75 +75 @@
 #pragma hdrstop                     // VAC++ keeps crashing otherwise
 
+// copy paste from helpers\comctl.h
+// @todo not necessary when we become part of XWorkplace
+
+#define TTN_NEEDTEXT        1000
+#define TTN_SHOW            1001
+#define TTN_POP             1002
+
+#define TTFMT_PSZ           0x01
+#define TTFMT_STRINGRES     0x02
+
+typedef struct _TOOLTIPTEXT
+{
+    HWND    hwndTooltip;
+    HWND    hwndTool;
+    ULONG   ulFormat;
+    PSZ     pszText;
+    HMODULE hmod;
+    ULONG   idResource;
+} TOOLTIPTEXT, *PTOOLTIPTEXT;
+
+#define TTM_FIRST                   (WM_USER + 1000)
+#define TTM_UPDATETIPTEXT           (TTM_FIRST + 9)
+#define TTM_SHOWTOOLTIPNOW          (TTM_FIRST + 17)
+
 // primitive debug logging to a file
 #if 0
@@ -123 +147 @@
     PSZ         pszToolTip;
                 // icon tooltip (NULL if none)
+    BOOL        bIsToolTipShowing;
+                // whether the tooltip is currently shown
     BOOL        bMemoryPoolGiven;
                 // TRUE if SYSTRAYDATA::pvMemoryPool is already given to
@@ -150 +176 @@
     size_t      cIconsMax;
                 // maximum number of icons pIcons can fit
+    CHAR        szToolTip[sizeof(((PSYSTRAYCTLDATA)0)->u.icon.szToolTip)];
+                // "static" buffer for the tooltip (XCenter requirement)
     PVOID       pvMemoryPool;
                 // memory pool for NOTIFYDATA structures
@@ -207 +235 @@
         INTCLASS_WIDGET_XSYSTRAY,   // internal widget class name
         HUMANSTR_WIDGET_XSYSTRAY,   // widget class name displayed to user
-        WGTF_UNIQUEGLOBAL,          // widget class flags
+        WGTF_UNIQUEGLOBAL |         // widget class flags
+        WGTF_TOOLTIP,
         NULL                        // no settings dialog
     }
@@ -360 +389 @@
         *pIdx = i;
     return NULL;
+}
+
+/*
+ *@@ FindIconDataAtPt:
+ *      Searches for the icon under the given point.
+ *      Returns NULL if no icon found (e.g. the pad space).
+ *
+ *      Refer to WgtPaint() for system tray geometry description.
+ */
+
+static
+PICONDATA FindIconDataAtPt(PXCENTERWIDGET pWidget,
+                           PPOINTL pptl,    // point coordinates (relative to systray)
+                           size_t *pIdx)    // out: index of the icon in the icon array
+                                            // (optional, may be NULL)
+{
+    PSYSTRAYDATA pSysTrayData = (PSYSTRAYDATA)pWidget->pUser;
+
+    SWP     swp;
+    RECTL   rcl;
+    BOOL    bLeftToRight;
+    LONG    y, lIconStep;
+    size_t  i;
+
+    // start with invalid index index
+    if (pIdx)
+        *pIdx = pSysTrayData->cIcons;
+
+    WinQueryWindowPos(pWidget->hwndWidget, &swp);
+    WinQueryWindowRect(pWidget->pGlobals->hwndClient, &rcl);
+
+    y = (swp.cy - pSysTrayData->lIconHeight) / 2;
+    if (pptl->y < y || pptl->y >= y + pSysTrayData->lIconHeight)
+        return NULL; // hit pad space
+
+    // detect the direction
+    bLeftToRight = swp.x + swp.cx / 2 < (rcl.xRight / 2);
+
+    lIconStep = pSysTrayData->lIconWidth + pSysTrayData->lIconPad;
+
+    // which icon is that?
+    if (bLeftToRight)
+    {
+        i = pptl->x / lIconStep;
+        if (pptl->x % lIconStep < pSysTrayData->lIconPad)
+            return NULL; // hit pad space
+    }
+    else
+    {
+        i = (swp.cx - pptl->x - 1) / lIconStep;
+        if ((swp.cx - pptl->x - 1) % lIconStep < pSysTrayData->lIconPad)
+            return NULL; // hit pad space
+    }
+    if (i >= pSysTrayData->cIcons)
+        return NULL; // hit pad space
+
+    if (pIdx)
+        *pIdx = i;
+    return &pSysTrayData->pIcons[i];
+}
+
+static
+VOID FreeSysTrayData(PSYSTRAYDATA pSysTrayData)
+{
+    // destroy the server
+    if (pSysTrayData->hwndServer != NULLHANDLE)
+    {
+        WinDestroyWindow(pSysTrayData->hwndServer);
+        pSysTrayData->hwndServer = NULLHANDLE;
+    }
+
+    // free all system tray data
+    if (pSysTrayData->pvMemoryPool)
+    {
+        DosFreeMem(pSysTrayData->pvMemoryPool);
+    }
+    if (pSysTrayData->pIcons)
+    {
+        size_t i;
+        for (i = 0; i < pSysTrayData->cIcons; ++i)
+            FreeIconData(&pSysTrayData->pIcons[i]);
+        pSysTrayData->cIcons = 0;
+        free(pSysTrayData->pIcons);
+        pSysTrayData->pIcons = NULL;
+    }
+
+    free(pSysTrayData);
 }
 
@@ -558 +674 @@
             break;
 
-        } // end switch (usNotifyCode)
-    } // end if (usID == ID_XCENTER_CLIENT)
+        }
+    }
+    else if (usID == ID_XCENTER_TOOLTIP)
+    {
+        PICONDATA pIconData;
+        POINTL ptl;
+
+        WinQueryMsgPos(pWidget->habWidget, &ptl);
+        // make the coordinates systray-relative
+        WinMapWindowPoints(HWND_DESKTOP, pWidget->hwndWidget, &ptl, 1);
+
+        pIconData = FindIconDataAtPt(pWidget, &ptl, NULL);
+
+        switch (usNotifyCode)
+        {
+            case TTN_NEEDTEXT:
+            {
+                LOGF(("TTN_NEEDTEXT\n"));
+
+                PTOOLTIPTEXT pttt = (PTOOLTIPTEXT)mp2;
+                pttt->ulFormat = TTFMT_PSZ;
+
+                if (!pIconData || !pIconData->pszToolTip)
+                    pttt->pszText = NULL;
+                else
+                {
+                    strncpy(pSysTrayData->szToolTip, pIconData->pszToolTip,
+                            sizeof(pSysTrayData->szToolTip) - 1);
+                    // be on the safe side
+                    pSysTrayData->szToolTip[sizeof(pSysTrayData->szToolTip) - 1] = '\0';
+
+                    pttt->pszText = pSysTrayData->szToolTip;
+                }
+
+                LOGF((" pszText '%s'\n", pttt->pszText));
+            }
+            break;
+
+            case TTN_SHOW:
+                if (pIconData)
+                    pIconData->bIsToolTipShowing = TRUE;
+            break;
+
+            case TTN_POP:
+                if (pIconData)
+                    pIconData->bIsToolTipShowing = FALSE;
+            break;
+        }
+    }
 
     return brc;
@@ -571 +734 @@
  *      the XCenter's center, icons go left to right. Otherwise, they go right
  *      to left.
+ *
+ *      NOTE: This function must be keept in sync with FindIconDataAtPt() in
+ *      terms of system tray geometry.
  */
 /*
@@ -695 +861 @@
 
     POINTL  ptl;
-    SWP     swp;
-    RECTL   rcl;
-    BOOL    bLeftToRight;
-    LONG    y, lIconStep;
-    size_t  i;
 
     PICONDATA   pIconData;
@@ -709 +870 @@
     LOGF(("msg %x ptl %ld,%ld\n", msg, ptl.x, ptl.y));
 
-    WinQueryWindowPos(hwnd, &swp);
-    WinQueryWindowRect(pWidget->pGlobals->hwndClient, &rcl);
-
-    y = (swp.cy - pSysTrayData->lIconHeight) / 2;
-    if (ptl.y < y || ptl.y >= y + pSysTrayData->lIconHeight)
+    pIconData = FindIconDataAtPt(pWidget, &ptl, NULL);
+    if (!pIconData)
         return FALSE; // hit pad space
-
-    // detect the direction
-    bLeftToRight = swp.x + swp.cx / 2 < (rcl.xRight / 2);
-
-    lIconStep = pSysTrayData->lIconWidth + pSysTrayData->lIconPad;
-
-    // which icon is that?
-    if (bLeftToRight)
-    {
-        i = ptl.x / lIconStep;
-        if (ptl.x % lIconStep < pSysTrayData->lIconPad)
-            return FALSE; // hit pad space
-    }
-    else
-    {
-        i = (swp.cx - ptl.x - 1) / lIconStep;
-        if ((swp.cx - ptl.x - 1) % lIconStep < pSysTrayData->lIconPad)
-            return FALSE; // hit pad space
-    }
-    if (i >= pSysTrayData->cIcons)
-        return FALSE; // hit pad space
-
-    pIconData = &pSysTrayData->pIcons[i];
 
     LOGF(("hwnd  %x\n", pIconData->hwnd));
@@ -785 +920 @@
 
     return TRUE;
-}
-
-static
-VOID FreeSysTrayData(PSYSTRAYDATA pSysTrayData)
-{
-    // destroy the server
-    if (pSysTrayData->hwndServer != NULLHANDLE)
-    {
-        WinDestroyWindow(pSysTrayData->hwndServer);
-        pSysTrayData->hwndServer = NULLHANDLE;
-    }
-
-    // free all system tray data
-    if (pSysTrayData->pvMemoryPool)
-    {
-        DosFreeMem(pSysTrayData->pvMemoryPool);
-    }
-    if (pSysTrayData->pIcons)
-    {
-        size_t i;
-        for (i = 0; i < pSysTrayData->cIcons; ++i)
-            FreeIconData(&pSysTrayData->pIcons[i]);
-        pSysTrayData->cIcons = 0;
-        free(pSysTrayData->pIcons);
-        pSysTrayData->pIcons = NULL;
-    }
-
-    free(pSysTrayData);
 }
 
@@ -1101 +1208 @@
 
             LOGF(("SYSTRAYCMD_ADDICON\n"));
-            LOGF((" hwnd  %x\n", pCtlData->hwndSender));
-            LOGF((" usId  %d\n", pCtlData->u.icon.usId));
-            LOGF((" hIcon %x\n", pCtlData->u.icon.hIcon));
+            LOGF((" hwnd       %x\n", pCtlData->hwndSender));
+            LOGF((" usId       %d\n", pCtlData->u.icon.usId));
+            LOGF((" hIcon      %x\n", pCtlData->u.icon.hIcon));
+            LOGF((" szToolTip  '%s'\n", pCtlData->u.icon.szToolTip));
 
             pCtlData->bAcknowledged = TRUE;
@@ -1120 +1228 @@
             if (pData)
             {
-                LOGF((" Updating hIcon %x\n", hIcon));
-
+                LOGF((" Replacing with hIcon %x\n", hIcon));
+
+                // try update the tooltip first
+                free(pData->pszToolTip);
+                pData->pszToolTip = NULL;
+                if (pCtlData->u.icon.szToolTip[0] != '\0')
+                {
+                    pData->pszToolTip = strdup(pCtlData->u.icon.szToolTip);
+                    if (!pData->pszToolTip)
+                    {
+                        WinDestroyPointer(hIcon);
+                        break;
+                    }
+                }
+
+                if (pData->bIsToolTipShowing)
+                {
+                    if (pData->pszToolTip)
+                        // update the tooltip on screen
+                        WinSendMsg(pWidget->pGlobals->hwndTooltip,
+                                   TTM_UPDATETIPTEXT,
+                                   (MPARAM)pData->pszToolTip, 0);
+                    else
+                        // hide the tooltip
+                        WinSendMsg(pWidget->pGlobals->hwndTooltip,
+                                   TTM_SHOWTOOLTIPNOW,
+                                   (MPARAM)FALSE, 0);
+                }
+
+                // now update the icon
                 WinDestroyPointer(pData->hIcon);
                 pData->hIcon = hIcon;
@@ -1156 +1292 @@
 
                 i = pSysTrayData->cIcons;
-                ++pSysTrayData->cIcons;
 
                 pData = &pSysTrayData->pIcons[i];
@@ -1166 +1301 @@
                 pData->ulMsgId = pCtlData->u.icon.ulMsgId;
 
+                if (pCtlData->u.icon.szToolTip[0] != '\0')
+                {
+                    pData->pszToolTip = strdup(pCtlData->u.icon.szToolTip);
+                    if (!pData->pszToolTip)
+                    {
+                        WinDestroyPointer(hIcon);
+                        break;
+                    }
+                }
+
                 WgtXSysTrayUpdateAfterIconAddRemove(pWidget);
+
+                ++pSysTrayData->cIcons;
 
                 xrc = XST_OK;
             }
+        }
+        break;
+
+        case SYSTRAYCMD_REPLACEICON:
+        {
+            POINTERINFO Info;
+            HPOINTER hIcon = NULLHANDLE;
+            size_t i;
+            PICONDATA pData;
+
+            LOGF(("SYSTRAYCMD_REPLACEICON\n"));
+            LOGF((" hwnd  %x\n", pCtlData->hwndSender));
+            LOGF((" usId  %d\n", pCtlData->u.icon.usId));
+
+            pCtlData->bAcknowledged = TRUE;
+
+            // make a private copy of the provided icon (it will get lost after
+            // we return from this message)
+            brc = WinQueryPointerInfo(pCtlData->u.icon.hIcon, &Info);
+            if (!brc)
+                break;
+            hIcon = WinCreatePointerIndirect(HWND_DESKTOP, &Info);
+            if (hIcon == NULLHANDLE)
+                break;
+
+            pData = FindIconData(pSysTrayData, pCtlData->hwndSender,
+                                 pCtlData->u.icon.usId, &i);
+            if (pData)
+            {
+                LOGF((" Replacing with hIcon %x\n", hIcon));
+
+                WinDestroyPointer(pData->hIcon);
+                pData->hIcon = hIcon;
+                pData->ulMsgId = pCtlData->u.icon.ulMsgId;
+
+                // we didn't change the number of icons so simply invalidate
+                WinInvalidateRect(pWidget->hwndWidget, NULL, FALSE);
+
+                xrc = XST_OK;
+            }
+            else
+                LOGF((" Icon not found!\n"));
         }
         break;
@@ -1201 +1390 @@
 
                 WgtXSysTrayUpdateAfterIconAddRemove(pWidget);
+
+                xrc = XST_OK;
+            }
+            else
+                LOGF((" Icon not found!\n"));
+        }
+        break;
+
+        case SYSTRAYCMD_SETTOOLTIP:
+        {
+            size_t i;
+            PICONDATA pData;
+
+            LOGF(("SYSTRAYCMD_SETTOOLTIP\n"));
+            LOGF((" hwnd  %x\n", pCtlData->hwndSender));
+            LOGF((" usId  %d\n", pCtlData->u.icon.usId));
+
+            pCtlData->bAcknowledged = TRUE;
+
+            pData = FindIconData(pSysTrayData, pCtlData->hwndSender,
+                                 pCtlData->u.icon.usId, &i);
+            if (pData)
+            {
+                LOGF((" Replacing with szToolTip '%s'\n",
+                      pCtlData->u.icon.szToolTip));
+
+                free(pData->pszToolTip);
+                pData->pszToolTip = NULL;
+                if (pCtlData->u.icon.szToolTip[0] != '\0')
+                {
+                    pData->pszToolTip = strdup(pCtlData->u.icon.szToolTip);
+                    if (!pData->pszToolTip)
+                        break;
+                }
+
+                if (pData->bIsToolTipShowing)
+                {
+                    if (pData->pszToolTip)
+                        // update the tooltip on screen
+                        WinSendMsg(pWidget->pGlobals->hwndTooltip,
+                                   TTM_UPDATETIPTEXT,
+                                   (MPARAM)pData->pszToolTip, 0);
+                    else
+                        // hide the tooltip
+                        WinSendMsg(pWidget->pGlobals->hwndTooltip,
+                                   TTM_SHOWTOOLTIPNOW,
+                                   (MPARAM)FALSE, 0);
+                }
 
                 xrc = XST_OK;