dlls/winex11.drv/systray.c

   1 /*
   2  * X11 system tray management
   3  *
   4  * Copyright (C) 2004 Mike Hearn, for CodeWeavers
   5  * Copyright (C) 2005 Robert Shearman
   6  * Copyright (C) 2008 Alexandre Julliard
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21  */
  22
  23 #include "config.h"
  24
  25 #include <assert.h>
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #ifdef HAVE_UNISTD_H
  30 # include <unistd.h>
  31 #endif
  32
  33 #include <X11/Xlib.h>
  34
  35 #include "windef.h"
  36 #include "winbase.h"
  37 #include "wingdi.h"
  38 #include "winuser.h"
  39 #include "commctrl.h"
  40 #include "shellapi.h"
  41
  42 #include "x11drv.h"
  43 #include "wine/list.h"
  44 #include "wine/debug.h"
  45
  46 WINE_DEFAULT_DEBUG_CHANNEL(systray);
  47
  48 /* an individual systray icon */
  49 struct tray_icon
  50 {
  51     struct list    entry;
  52     HICON          image;    /* the image to render */
  53     HWND           owner;    /* the HWND passed in to the Shell_NotifyIcon call */
  54     HWND           window;   /* the adaptor window */
  55     HWND           tooltip;  /* Icon tooltip */
  56     UINT           id;       /* the unique id given by the app */
  57     UINT           callback_message;
  58     WCHAR          tiptext[256]; /* Tooltip text. If empty => tooltip disabled */
  59     WCHAR          tiptitle[64]; /* Tooltip title for ballon style tooltips.  If empty => tooltip is not balloon style. */
  60 };
  61
  62 static struct list icon_list = LIST_INIT( icon_list );
  63
  64 static const WCHAR tray_classname[] = {'_','_','w','i','n','e','x','1','1','_','t','r','a','y','_','w','i','n','d','o','w',0};
  65
  66 static BOOL delete_icon( struct tray_icon *icon );
  67
  68 #define SYSTEM_TRAY_REQUEST_DOCK  0
  69 #define SYSTEM_TRAY_BEGIN_MESSAGE   1
  70 #define SYSTEM_TRAY_CANCEL_MESSAGE  2
  71
  72 #define ICON_BORDER 2
  73
  74 /* retrieves icon record by owner window and ID */
  75 static struct tray_icon *get_icon(HWND owner, UINT id)
  76 {
  77     struct tray_icon *this;
  78
  79     LIST_FOR_EACH_ENTRY( this, &icon_list, struct tray_icon, entry )
  80         if ((this->id == id) && (this->owner == owner)) return this;
  81     return NULL;
  82 }
  83
  84 /* create tooltip window for icon */
  85 static void create_tooltip(struct tray_icon *icon)
  86 {
  87     static BOOL tooltips_initialized = FALSE;
  88
  89     if (!tooltips_initialized)
  90     {
  91         INITCOMMONCONTROLSEX init_tooltip;
  92
  93         init_tooltip.dwSize = sizeof(INITCOMMONCONTROLSEX);
  94         init_tooltip.dwICC = ICC_TAB_CLASSES;
  95
  96         InitCommonControlsEx(&init_tooltip);
  97         tooltips_initialized = TRUE;
  98     }
  99     if (icon->tiptitle[0] != 0)
 100     {
 101         icon->tooltip = CreateWindowExW( WS_EX_TOPMOST, TOOLTIPS_CLASSW, NULL,
 102                                          WS_POPUP | TTS_ALWAYSTIP | TTS_BALLOON,
 103                                          CW_USEDEFAULT, CW_USEDEFAULT,
 104                                          CW_USEDEFAULT, CW_USEDEFAULT,
 105                                          icon->window, NULL, NULL, NULL);
 106     }
 107     else
 108     {
 109         icon->tooltip = CreateWindowExW( WS_EX_TOPMOST, TOOLTIPS_CLASSW, NULL,
 110                                          WS_POPUP | TTS_ALWAYSTIP,
 111                                          CW_USEDEFAULT, CW_USEDEFAULT,
 112                                          CW_USEDEFAULT, CW_USEDEFAULT,
 113                                          icon->window, NULL, NULL, NULL);
 114     }
 115     if (icon->tooltip)
 116     {
 117         TTTOOLINFOW ti;
 118         ZeroMemory(&ti, sizeof(ti));
 119         ti.cbSize = sizeof(TTTOOLINFOW);
 120         ti.uFlags = TTF_SUBCLASS | TTF_IDISHWND;
 121         ti.hwnd = icon->window;
 122         ti.uId = (UINT_PTR)icon->window;
 123         ti.lpszText = icon->tiptext;
 124         SendMessageW(icon->tooltip, TTM_ADDTOOLW, 0, (LPARAM)&ti);
 125     }
 126 }
 127
 128 /* synchronize tooltip text with tooltip window */
 129 static void update_tooltip_text(struct tray_icon *icon)
 130 {
 131     TTTOOLINFOW ti;
 132
 133     ZeroMemory(&ti, sizeof(ti));
 134     ti.cbSize = sizeof(TTTOOLINFOW);
 135     ti.uFlags = TTF_SUBCLASS | TTF_IDISHWND;
 136     ti.hwnd = icon->window;
 137     ti.uId = (UINT_PTR)icon->window;
 138     ti.lpszText = icon->tiptext;
 139
 140     SendMessageW(icon->tooltip, TTM_UPDATETIPTEXTW, 0, (LPARAM)&ti);
 141 }
 142
 143 /* window procedure for the tray window */
 144 static LRESULT WINAPI tray_wndproc(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
 145 {
 146     struct tray_icon *icon = NULL;
 147     BOOL ret;
 148
 149     WINE_TRACE("hwnd=%p, msg=0x%x\n", hwnd, msg);
 150
 151     /* set the icon data for the window from the data passed into CreateWindow */
 152     if (msg == WM_NCCREATE)
 153         SetWindowLongPtrW(hwnd, GWLP_USERDATA, (LPARAM)((const CREATESTRUCTW *)lparam)->lpCreateParams);
 154
 155     icon = (struct tray_icon *) GetWindowLongPtrW(hwnd, GWLP_USERDATA);
 156
 157     switch (msg)
 158     {
 159     case WM_PAINT:
 160         {
 161             PAINTSTRUCT ps;
 162             RECT rc;
 163             HDC hdc;
 164             int cx = GetSystemMetrics( SM_CXSMICON );
 165             int cy = GetSystemMetrics( SM_CYSMICON );
 166
 167             hdc = BeginPaint(hwnd, &ps);
 168             GetClientRect(hwnd, &rc);
 169             TRACE("painting rect %s\n", wine_dbgstr_rect(&rc));
 170             DrawIconEx( hdc, (rc.left + rc.right - cx) / 2, (rc.top + rc.bottom - cy) / 2,
 171                         icon->image, cx, cy, 0, 0, DI_DEFAULTSIZE|DI_NORMAL );
 172             EndPaint(hwnd, &ps);
 173             break;
 174         }
 175
 176     case WM_MOUSEMOVE:
 177     case WM_LBUTTONDOWN:
 178     case WM_LBUTTONUP:
 179     case WM_RBUTTONDOWN:
 180     case WM_RBUTTONUP:
 181     case WM_MBUTTONDOWN:
 182     case WM_MBUTTONUP:
 183     case WM_LBUTTONDBLCLK:
 184     case WM_RBUTTONDBLCLK:
 185     case WM_MBUTTONDBLCLK:
 186         /* notify the owner hwnd of the message */
 187         TRACE("relaying 0x%x\n", msg);
 188         ret = PostMessageW(icon->owner, icon->callback_message, icon->id, msg);
 189         if (!ret && (GetLastError() == ERROR_INVALID_WINDOW_HANDLE))
 190         {
 191             WARN( "application window was destroyed, removing icon %u\n", icon->id );
 192             delete_icon( icon );
 193         }
 194         break;
 195
 196     case WM_TIMER:
 197         if (!IsWindow( icon->owner )) delete_icon( icon );
 198         return 0;
 199
 200     default:
 201         return DefWindowProcW(hwnd, msg, wparam, lparam);
 202     }
 203     return 0;
 204 }
 205
 206 /* find the X11 window owner the system tray selection */
 207 static Window get_systray_selection_owner( Display *display )
 208 {
 209     static Atom systray_atom;
 210     Window ret;
 211
 212     if (root_window != DefaultRootWindow( display )) return 0;
 213
 214     wine_tsx11_lock();
 215     if (!systray_atom)
 216     {
 217         if (DefaultScreen( display ) == 0)
 218             systray_atom = x11drv_atom(_NET_SYSTEM_TRAY_S0);
 219         else
 220         {
 221             char systray_buffer[29]; /* strlen(_NET_SYSTEM_TRAY_S4294967295)+1 */
 222             sprintf( systray_buffer, "_NET_SYSTEM_TRAY_S%u", DefaultScreen( display ) );
 223             systray_atom = XInternAtom( display, systray_buffer, False );
 224         }
 225     }
 226     ret = XGetSelectionOwner( display, systray_atom );
 227     wine_tsx11_unlock();
 228     return ret;
 229 }
 230
 231
 232 /* dock the given X window with the NETWM system tray */
 233 static void dock_systray_window( Display *display, HWND hwnd, Window systray_window )
 234 {
 235     struct x11drv_win_data *data;
 236     XEvent ev;
 237     XSetWindowAttributes attr;
 238
 239     if (!(data = X11DRV_get_win_data( hwnd )) &&
 240         !(data = X11DRV_create_win_data( hwnd ))) return;
 241
 242     TRACE( "icon window %p/%lx managed %u\n", data->hwnd, data->whole_window, data->managed );
 243
 244     make_window_embedded( display, data );
 245
 246     /* send the docking request message */
 247     ev.xclient.type = ClientMessage;
 248     ev.xclient.window = systray_window;
 249     ev.xclient.message_type = x11drv_atom( _NET_SYSTEM_TRAY_OPCODE );
 250     ev.xclient.format = 32;
 251     ev.xclient.data.l[0] = CurrentTime;
 252     ev.xclient.data.l[1] = SYSTEM_TRAY_REQUEST_DOCK;
 253     ev.xclient.data.l[2] = data->whole_window;
 254     ev.xclient.data.l[3] = 0;
 255     ev.xclient.data.l[4] = 0;
 256     wine_tsx11_lock();
 257     XSendEvent( display, systray_window, False, NoEventMask, &ev );
 258     attr.background_pixmap = ParentRelative;
 259     attr.bit_gravity = ForgetGravity;
 260     XChangeWindowAttributes( display, data->whole_window, CWBackPixmap | CWBitGravity, &attr );
 261     XChangeWindowAttributes( display, data->client_window, CWBackPixmap | CWBitGravity, &attr );
 262     wine_tsx11_unlock();
 263 }
 264
 265
 266 /* hide a tray icon */
 267 static BOOL hide_icon( struct tray_icon *icon )
 268 {
 269     TRACE( "id=0x%x, hwnd=%p\n", icon->id, icon->owner );
 270
 271     if (!icon->window) return TRUE;  /* already hidden */
 272
 273     DestroyWindow(icon->window);
 274     DestroyWindow(icon->tooltip);
 275     icon->window = 0;
 276     icon->tooltip = 0;
 277     return TRUE;
 278 }
 279
 280 /* make the icon visible */
 281 static BOOL show_icon( struct tray_icon *icon )
 282 {
 283     RECT rect;
 284     static BOOL class_registered;
 285     Window systray_window;
 286     Display *display = thread_display();
 287
 288     TRACE( "id=0x%x, hwnd=%p\n", icon->id, icon->owner );
 289
 290     if (icon->window) return TRUE;  /* already shown */
 291
 292     if (!class_registered)
 293     {
 294         WNDCLASSEXW class;
 295
 296         ZeroMemory( &class, sizeof(class) );
 297         class.cbSize        = sizeof(class);
 298         class.lpfnWndProc   = tray_wndproc;
 299         class.hCursor       = LoadCursorW( 0, (LPCWSTR)IDC_ARROW );
 300         class.lpszClassName = tray_classname;
 301         class.style         = CS_HREDRAW | CS_VREDRAW | CS_DBLCLKS;
 302
 303         if (!RegisterClassExW(&class) && GetLastError() != ERROR_CLASS_ALREADY_EXISTS)
 304         {
 305             WINE_ERR( "Could not register tray window class\n" );
 306             return FALSE;
 307         }
 308         class_registered = TRUE;
 309     }
 310
 311     if (!(systray_window = get_systray_selection_owner( display ))) return FALSE;
 312
 313     rect.left = 0;
 314     rect.top = 0;
 315     rect.right = GetSystemMetrics( SM_CXSMICON ) + 2*ICON_BORDER;
 316     rect.bottom = GetSystemMetrics( SM_CYSMICON ) + 2*ICON_BORDER;
 317
 318     icon->window = CreateWindowExW( WS_EX_APPWINDOW, tray_classname, NULL, WS_CLIPSIBLINGS | WS_POPUP,
 319                                     CW_USEDEFAULT, CW_USEDEFAULT,
 320                                     rect.right - rect.left, rect.bottom - rect.top,
 321                                     NULL, NULL, NULL, icon );
 322     create_tooltip( icon );
 323     dock_systray_window( display, icon->window, systray_window );
 324     SetTimer( icon->window, 1, 1000, NULL );
 325     ShowWindow( icon->window, SW_SHOWNA );
 326     return TRUE;
 327 }
 328
 329 /* Modifies an existing icon record */
 330 static BOOL modify_icon( struct tray_icon *icon, NOTIFYICONDATAW *nid )
 331 {
 332     TRACE( "id=0x%x hwnd=%p flags=%x\n", nid->uID, nid->hWnd, nid->uFlags );
 333
 334     if ((nid->uFlags & NIF_STATE) && (nid->dwStateMask & NIS_HIDDEN))
 335     {
 336         if (nid->dwState & NIS_HIDDEN) hide_icon( icon );
 337         else show_icon( icon );
 338     }
 339
 340     if (nid->uFlags & NIF_ICON)
 341     {
 342         if (icon->image) DestroyIcon(icon->image);
 343         icon->image = CopyIcon(nid->hIcon);
 344         if (icon->window)
 345         {
 346             struct x11drv_win_data *data = X11DRV_get_win_data( icon->window );
 347             if (data) XClearArea( thread_display(), data->client_window, 0, 0, 0, 0, True );
 348         }
 349     }
 350
 351     if (nid->uFlags & NIF_MESSAGE)
 352     {
 353         icon->callback_message = nid->uCallbackMessage;
 354     }
 355     if (nid->uFlags & NIF_TIP)
 356     {
 357         lstrcpynW(icon->tiptext, nid->szTip, sizeof(icon->tiptext)/sizeof(WCHAR));
 358         icon->tiptitle[0] = 0;
 359         if (icon->tooltip) update_tooltip_text(icon);
 360     }
 361     if (nid->uFlags & NIF_INFO && nid->cbSize >= NOTIFYICONDATAA_V2_SIZE)
 362     {
 363         lstrcpynW(icon->tiptext, nid->szInfo, sizeof(icon->tiptext)/sizeof(WCHAR));
 364         lstrcpynW(icon->tiptitle, nid->szInfoTitle, sizeof(icon->tiptitle)/sizeof(WCHAR));
 365         if (icon->tooltip) update_tooltip_text(icon);
 366     }
 367     return TRUE;
 368 }
 369
 370 /* Adds a new icon record to the list */
 371 static BOOL add_icon(NOTIFYICONDATAW *nid)
 372 {
 373     struct tray_icon  *icon;
 374
 375     WINE_TRACE("id=0x%x, hwnd=%p\n", nid->uID, nid->hWnd);
 376
 377     if ((icon = get_icon(nid->hWnd, nid->uID)))
 378     {
 379         WINE_WARN("duplicate tray icon add, buggy app?\n");
 380         return FALSE;
 381     }
 382
 383     if (!(icon = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*icon))))
 384     {
 385         WINE_ERR("out of memory\n");
 386         return FALSE;
 387     }
 388
 389     ZeroMemory(icon, sizeof(struct tray_icon));
 390     icon->id     = nid->uID;
 391     icon->owner  = nid->hWnd;
 392
 393     list_add_tail(&icon_list, &icon->entry);
 394
 395     /* if hidden state is specified, modify_icon will take care of it */
 396     if (!((nid->uFlags & NIF_STATE) && (nid->dwStateMask & NIS_HIDDEN)))
 397         show_icon( icon );
 398
 399     return modify_icon( icon, nid );
 400 }
 401
 402 /* delete tray icon window and icon structure */
 403 static BOOL delete_icon( struct tray_icon *icon )
 404 {
 405     hide_icon( icon );
 406     list_remove( &icon->entry );
 407     DestroyIcon( icon->image );
 408     HeapFree( GetProcessHeap(), 0, icon );
 409     return TRUE;
 410 }
 411
 412
 413 /***********************************************************************
 414  *              wine_notify_icon   (X11DRV.@)
 415  *
 416  * Driver-side implementation of Shell_NotifyIcon.
 417  */
 418 int CDECL wine_notify_icon( DWORD msg, NOTIFYICONDATAW *data )
 419 {
 420     BOOL ret = FALSE;
 421     struct tray_icon *icon;
 422
 423     switch (msg)
 424     {
 425     case NIM_ADD:
 426         if (!get_systray_selection_owner( thread_init_display() ))
 427             return -1;  /* fall back to default handling */
 428         ret = add_icon( data );
 429         break;
 430     case NIM_DELETE:
 431         if ((icon = get_icon( data->hWnd, data->uID ))) ret = delete_icon( icon );
 432         break;
 433     case NIM_MODIFY:
 434         if ((icon = get_icon( data->hWnd, data->uID ))) ret = modify_icon( icon, data );
 435         break;
 436     default:
 437         FIXME( "unhandled tray message: %u\n", msg );
 438         break;
 439     }
 440     return ret;
 441 }