Use a struct as specified in the VBE 3.0 standard for the
[wine] / dlls / shell32 / systray.c
1 /*
2  *      Systray
3  *
4  *      Copyright 1999 Kai Morich       <kai.morich@bigfoot.de>
5  *
6  *  Manage the systray window. That it actually appears in the docking
7  *  area of KDE is handled in dlls/x11drv/window.c,
8  *  X11DRV_set_wm_hints using KWM_DOCKWINDOW.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  */
24
25 #include "config.h"
26
27 #ifdef HAVE_UNISTD_H
28 # include <unistd.h>
29 #endif
30 #include <stdarg.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 #include "windef.h"
35 #include "winbase.h"
36 #include "winnls.h"
37 #include "wingdi.h"
38 #include "winuser.h"
39 #include "shlobj.h"
40 #include "shellapi.h"
41 #include "shell32_main.h"
42 #include "commctrl.h"
43 #include "wine/debug.h"
44
45 WINE_DEFAULT_DEBUG_CHANNEL(shell);
46
47 typedef struct SystrayItem {
48   HWND                  hWnd;
49   HWND                  hWndToolTip;
50   NOTIFYICONDATAA       notifyIcon;
51   struct SystrayItem    *nextTrayItem;
52 } SystrayItem;
53
54 static SystrayItem *systray=NULL;
55 static int firstSystray=TRUE; /* defer creation of window class until first systray item is created */
56
57 static BOOL SYSTRAY_Delete(PNOTIFYICONDATAA pnid);
58
59
60 #define ICON_SIZE GetSystemMetrics(SM_CXSMICON)
61 /* space around icon (forces icon to center of KDE systray area) */
62 #define ICON_BORDER  4
63
64
65
66 static BOOL SYSTRAY_ItemIsEqual(PNOTIFYICONDATAA pnid1, PNOTIFYICONDATAA pnid2)
67 {
68   if (pnid1->hWnd != pnid2->hWnd) return FALSE;
69   if (pnid1->uID  != pnid2->uID)  return FALSE;
70   return TRUE;
71 }
72
73 static LRESULT CALLBACK SYSTRAY_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
74 {
75   HDC hdc;
76   PAINTSTRUCT ps;
77
78   switch (message) {
79   case WM_PAINT:
80   {
81     RECT rc;
82     SystrayItem  *ptrayItem = systray;
83
84     while (ptrayItem) {
85       if (ptrayItem->hWnd==hWnd) {
86         if (ptrayItem->notifyIcon.hIcon) {
87           hdc = BeginPaint(hWnd, &ps);
88           GetClientRect(hWnd, &rc);
89           if (!DrawIconEx(hdc, rc.left+ICON_BORDER, rc.top+ICON_BORDER, ptrayItem->notifyIcon.hIcon,
90                           ICON_SIZE, ICON_SIZE, 0, 0, DI_DEFAULTSIZE|DI_NORMAL)) {
91             ERR("Paint(SystrayWindow %p) failed -> removing SystrayItem %p\n", hWnd, ptrayItem);
92             SYSTRAY_Delete(&ptrayItem->notifyIcon);
93           }
94         }
95         break;
96       }
97       ptrayItem = ptrayItem->nextTrayItem;
98     }
99     EndPaint(hWnd, &ps);
100   }
101   break;
102
103   case WM_MOUSEMOVE:
104   case WM_LBUTTONDOWN:
105   case WM_LBUTTONUP:
106   case WM_RBUTTONDOWN:
107   case WM_RBUTTONUP:
108   case WM_MBUTTONDOWN:
109   case WM_MBUTTONUP:
110   {
111     MSG msg;
112     SystrayItem *ptrayItem = systray;
113
114     while ( ptrayItem ) {
115       if (ptrayItem->hWnd == hWnd) {
116         msg.hwnd=hWnd;
117         msg.message=message;
118         msg.wParam=wParam;
119         msg.lParam=lParam;
120         msg.time = GetMessageTime ();
121         msg.pt.x = LOWORD(GetMessagePos ());
122         msg.pt.y = HIWORD(GetMessagePos ());
123
124         SendMessageA(ptrayItem->hWndToolTip, TTM_RELAYEVENT, 0, (LPARAM)&msg);
125       }
126       ptrayItem = ptrayItem->nextTrayItem;
127     }
128   }
129   /* fall through */
130
131   case WM_LBUTTONDBLCLK:
132   case WM_RBUTTONDBLCLK:
133   case WM_MBUTTONDBLCLK:
134   {
135     SystrayItem *ptrayItem = systray;
136
137     while (ptrayItem) {
138       if (ptrayItem->hWnd == hWnd) {
139         if (ptrayItem->notifyIcon.hWnd && ptrayItem->notifyIcon.uCallbackMessage) {
140           if (!PostMessageA(ptrayItem->notifyIcon.hWnd, ptrayItem->notifyIcon.uCallbackMessage,
141                             (WPARAM)ptrayItem->notifyIcon.uID, (LPARAM)message)) {
142               ERR("PostMessage(SystrayWindow %p) failed -> removing SystrayItem %p\n", hWnd, ptrayItem);
143               SYSTRAY_Delete(&ptrayItem->notifyIcon);
144             }
145         }
146         break;
147       }
148       ptrayItem = ptrayItem->nextTrayItem;
149     }
150   }
151   break;
152
153   default:
154     return (DefWindowProcA(hWnd, message, wParam, lParam));
155   }
156   return (0);
157
158 }
159
160
161 BOOL SYSTRAY_RegisterClass(void)
162 {
163   WNDCLASSA  wc;
164
165   wc.style         = CS_SAVEBITS|CS_DBLCLKS;
166   wc.lpfnWndProc   = (WNDPROC)SYSTRAY_WndProc;
167   wc.cbClsExtra    = 0;
168   wc.cbWndExtra    = 0;
169   wc.hInstance     = 0;
170   wc.hIcon         = 0;
171   wc.hCursor       = LoadCursorA(0, (LPSTR)IDC_ARROW);
172   wc.hbrBackground = (HBRUSH)(COLOR_WINDOW + 1);
173   wc.lpszMenuName  = NULL;
174   wc.lpszClassName = "WineSystray";
175
176   if (!RegisterClassA(&wc)) {
177     ERR("RegisterClass(WineSystray) failed\n");
178     return FALSE;
179   }
180   return TRUE;
181 }
182
183
184 BOOL SYSTRAY_ItemInit(SystrayItem *ptrayItem)
185 {
186   RECT rect;
187
188   /* Register the class if this is our first tray item. */
189   if ( firstSystray ) {
190     firstSystray = FALSE;
191     if ( !SYSTRAY_RegisterClass() ) {
192       ERR( "RegisterClass(WineSystray) failed\n" );
193       return FALSE;
194     }
195   }
196
197   /* Initialize the window size. */
198   rect.left   = 0;
199   rect.top    = 0;
200   rect.right  = ICON_SIZE+2*ICON_BORDER;
201   rect.bottom = ICON_SIZE+2*ICON_BORDER;
202
203   ZeroMemory( ptrayItem, sizeof(SystrayItem) );
204   /* Create tray window for icon. */
205   ptrayItem->hWnd = CreateWindowExA( WS_EX_TRAYWINDOW,
206                                 "WineSystray", "Wine-Systray",
207                                 WS_VISIBLE,
208                                 CW_USEDEFAULT, CW_USEDEFAULT,
209                                 rect.right-rect.left, rect.bottom-rect.top,
210                                 0, 0, 0, 0 );
211   if ( !ptrayItem->hWnd ) {
212     ERR( "CreateWindow(WineSystray) failed\n" );
213     return FALSE;
214   }
215
216   /* Create tooltip for icon. */
217   ptrayItem->hWndToolTip = CreateWindowA( TOOLTIPS_CLASSA,NULL,TTS_ALWAYSTIP,
218                                      CW_USEDEFAULT, CW_USEDEFAULT,
219                                      CW_USEDEFAULT, CW_USEDEFAULT,
220                                      ptrayItem->hWnd, 0, 0, 0 );
221   if ( !ptrayItem->hWndToolTip ) {
222     ERR( "CreateWindow(TOOLTIP) failed\n" );
223     return FALSE;
224   }
225   return TRUE;
226 }
227
228
229 static void SYSTRAY_ItemTerm(SystrayItem *ptrayItem)
230 {
231   if(ptrayItem->notifyIcon.hIcon)
232      DestroyIcon(ptrayItem->notifyIcon.hIcon);
233   if(ptrayItem->hWndToolTip)
234       DestroyWindow(ptrayItem->hWndToolTip);
235   if(ptrayItem->hWnd)
236     DestroyWindow(ptrayItem->hWnd);
237   return;
238 }
239
240
241 void SYSTRAY_ItemSetMessage(SystrayItem *ptrayItem, UINT uCallbackMessage)
242 {
243   ptrayItem->notifyIcon.uCallbackMessage = uCallbackMessage;
244 }
245
246
247 void SYSTRAY_ItemSetIcon(SystrayItem *ptrayItem, HICON hIcon)
248 {
249   ptrayItem->notifyIcon.hIcon = CopyIcon(hIcon);
250   InvalidateRect(ptrayItem->hWnd, NULL, TRUE);
251 }
252
253
254 void SYSTRAY_ItemSetTip(SystrayItem *ptrayItem, CHAR* szTip, int modify)
255 {
256   TTTOOLINFOA ti;
257
258   strncpy(ptrayItem->notifyIcon.szTip, szTip, sizeof(ptrayItem->notifyIcon.szTip));
259   ptrayItem->notifyIcon.szTip[sizeof(ptrayItem->notifyIcon.szTip)-1]=0;
260
261   ti.cbSize = sizeof(TTTOOLINFOA);
262   ti.uFlags = 0;
263   ti.hwnd = ptrayItem->hWnd;
264   ti.hinst = 0;
265   ti.uId = 0;
266   ti.lpszText = ptrayItem->notifyIcon.szTip;
267   ti.rect.left   = 0;
268   ti.rect.top    = 0;
269   ti.rect.right  = ICON_SIZE+2*ICON_BORDER;
270   ti.rect.bottom = ICON_SIZE+2*ICON_BORDER;
271
272   if(modify)
273     SendMessageA(ptrayItem->hWndToolTip, TTM_UPDATETIPTEXTA, 0, (LPARAM)&ti);
274   else
275     SendMessageA(ptrayItem->hWndToolTip, TTM_ADDTOOLA, 0, (LPARAM)&ti);
276 }
277
278
279 static BOOL SYSTRAY_Add(PNOTIFYICONDATAA pnid)
280 {
281   SystrayItem **ptrayItem = &systray;
282
283   /* Find last element. */
284   while( *ptrayItem ) {
285     if ( SYSTRAY_ItemIsEqual(pnid, &(*ptrayItem)->notifyIcon) )
286       return FALSE;
287     ptrayItem = &((*ptrayItem)->nextTrayItem);
288   }
289   /* Allocate SystrayItem for element and add to end of list. */
290   (*ptrayItem) = ( SystrayItem *)malloc( sizeof(SystrayItem) );
291
292   /* Initialize and set data for the tray element. */
293   SYSTRAY_ItemInit( (*ptrayItem) );
294   (*ptrayItem)->notifyIcon.uID = pnid->uID; /* only needed for callback message */
295   (*ptrayItem)->notifyIcon.hWnd = pnid->hWnd; /* only needed for callback message */
296   SYSTRAY_ItemSetIcon   (*ptrayItem, (pnid->uFlags&NIF_ICON)   ?pnid->hIcon           :0);
297   SYSTRAY_ItemSetMessage(*ptrayItem, (pnid->uFlags&NIF_MESSAGE)?pnid->uCallbackMessage:0);
298   SYSTRAY_ItemSetTip    (*ptrayItem, (pnid->uFlags&NIF_TIP)    ?pnid->szTip           :"", FALSE);
299
300   TRACE("%p: %p %s\n",  (*ptrayItem), (*ptrayItem)->notifyIcon.hWnd,
301                                           (*ptrayItem)->notifyIcon.szTip);
302   return TRUE;
303 }
304
305
306 static BOOL SYSTRAY_Modify(PNOTIFYICONDATAA pnid)
307 {
308   SystrayItem *ptrayItem = systray;
309
310   while ( ptrayItem ) {
311     if ( SYSTRAY_ItemIsEqual(pnid, &ptrayItem->notifyIcon) ) {
312       if (pnid->uFlags & NIF_ICON)
313         SYSTRAY_ItemSetIcon(ptrayItem, pnid->hIcon);
314       if (pnid->uFlags & NIF_MESSAGE)
315         SYSTRAY_ItemSetMessage(ptrayItem, pnid->uCallbackMessage);
316       if (pnid->uFlags & NIF_TIP)
317         SYSTRAY_ItemSetTip(ptrayItem, pnid->szTip, TRUE);
318
319       TRACE("%p: %p %s\n", ptrayItem, ptrayItem->notifyIcon.hWnd, ptrayItem->notifyIcon.szTip);
320       return TRUE;
321     }
322     ptrayItem = ptrayItem->nextTrayItem;
323   }
324   return FALSE; /* not found */
325 }
326
327
328 static BOOL SYSTRAY_Delete(PNOTIFYICONDATAA pnid)
329 {
330   SystrayItem **ptrayItem = &systray;
331
332   while (*ptrayItem) {
333     if (SYSTRAY_ItemIsEqual(pnid, &(*ptrayItem)->notifyIcon)) {
334       SystrayItem *next = (*ptrayItem)->nextTrayItem;
335       TRACE("%p: %p %s\n", *ptrayItem, (*ptrayItem)->notifyIcon.hWnd, (*ptrayItem)->notifyIcon.szTip);
336       SYSTRAY_ItemTerm(*ptrayItem);
337
338       free(*ptrayItem);
339       *ptrayItem = next;
340
341       return TRUE;
342     }
343     ptrayItem = &((*ptrayItem)->nextTrayItem);
344   }
345
346   return FALSE; /* not found */
347 }
348
349 /*************************************************************************
350  *
351  */
352 BOOL SYSTRAY_Init(void)
353 {
354   return TRUE;
355 }
356
357 /*************************************************************************
358  * Shell_NotifyIcon                     [SHELL32.296]
359  * Shell_NotifyIconA                    [SHELL32.297]
360  */
361 BOOL WINAPI Shell_NotifyIconA(DWORD dwMessage, PNOTIFYICONDATAA pnid )
362 {
363   BOOL flag=FALSE;
364   TRACE("enter %p %d %ld\n", pnid->hWnd, pnid->uID, dwMessage);
365   switch(dwMessage) {
366   case NIM_ADD:
367     flag = SYSTRAY_Add(pnid);
368     break;
369   case NIM_MODIFY:
370     flag = SYSTRAY_Modify(pnid);
371     break;
372   case NIM_DELETE:
373     flag = SYSTRAY_Delete(pnid);
374     break;
375   }
376   TRACE("leave %p %d %ld=%d\n", pnid->hWnd, pnid->uID, dwMessage, flag);
377   return flag;
378 }
379
380 /*************************************************************************
381  * Shell_NotifyIconW                    [SHELL32.298]
382  */
383 BOOL WINAPI Shell_NotifyIconW (DWORD dwMessage, PNOTIFYICONDATAW pnid )
384 {
385         BOOL ret;
386
387         PNOTIFYICONDATAA p = HeapAlloc(GetProcessHeap(),0,sizeof(NOTIFYICONDATAA));
388         memcpy(p, pnid, sizeof(NOTIFYICONDATAA));
389         WideCharToMultiByte( CP_ACP, 0, pnid->szTip, -1, p->szTip, sizeof(p->szTip), NULL, NULL );
390         p->szTip[sizeof(p->szTip)-1] = 0;
391
392         ret = Shell_NotifyIconA(dwMessage, p );
393
394         HeapFree(GetProcessHeap(),0,p);
395         return ret;
396 }