src/gtk/eggtrayicon.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /* eggtrayicon.c
   3  * Copyright (C) 2002 Anders Carlsson <andersca@gnu.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22
  23 Permission to use this file under wxWindows license given by
  24 copyright holder:
  25 --------
  26 From andersca@gnu.org Tue Dec  9 13:01:56 2003
  27 Return-path: <andersca@gnu.org>
  28 Envelope-to: vasek@localhost
  29 Delivery-date: Tue, 09 Dec 2003 13:04:35 +0100
  30 Received: from localhost
  31         ([127.0.0.1] helo=amavis ident=amavis)
  32         by armitage with esmtp (Exim 3.35 #1)
  33         id 1ATgbS-0001Gs-00
  34         for vasek@localhost; Tue, 09 Dec 2003 13:04:35 +0100
  35 Received: from armitage ([127.0.0.1])
  36         by amavis (armitage [127.0.0.1]) (amavisd-new, port 10024) with ESMTP
  37         id 04227-09 for <vasek@localhost>;
  38         Tue, 9 Dec 2003 13:04:11 +0100 (CET)
  39 Received: from localhost ([127.0.0.1] ident=fetchmail)
  40         by armitage with esmtp (Exim 3.35 #1)
  41         id 1ATgb5-0001GY-00
  42         for vasek@localhost; Tue, 09 Dec 2003 13:04:11 +0100
  43 Delivered-To: alias-email-slavikvaclav@seznam.cz
  44 Received: from pop3.seznam.cz [212.80.76.45]
  45         by localhost with POP3 (fetchmail-5.9.11)
  46         for vasek@localhost (single-drop); Tue, 09 Dec 2003 13:04:11 +0100 (CET)
  47 Received: (qmail 9861 invoked from network); 9 Dec 2003 12:02:17 -0000
  48 Received: from unknown (HELO maxipes.logix.cz) (81.0.234.97)
  49   by buster.go.seznam.cz with SMTP; 9 Dec 2003 12:02:17 -0000
  50 Received: by maxipes.logix.cz (Postfix, from userid 604)
  51         id 37E6D29A51; Tue,  9 Dec 2003 13:02:16 +0100 (CET)
  52 X-Original-To: vaclav.slavik@matfyz.cz
  53 Received: from mail.csbnet.se (glutus.csbnet.se [193.11.248.2])
  54         by maxipes.logix.cz (Postfix) with ESMTP id 90D6A29A51
  55         for <vaclav.slavik@matfyz.cz>; Tue,  9 Dec 2003 13:02:15 +0100 (CET)
  56 Received: by mail.csbnet.se (Postfix, from userid 8)
  57         id 7AA7F10A6D7; Tue,  9 Dec 2003 13:02:14 +0100 (CET)
  58 Received: from carbon.csbnet.se (carbon.csbnet.se [193.11.248.180])
  59         by mail.csbnet.se (Postfix) with ESMTP id A190F10A71D
  60         for <vaclav.slavik@matfyz.cz>; Tue,  9 Dec 2003 13:01:56 +0100 (CET)
  61 Subject: Re: eggtrayicon.{c,h} licensing
  62 From: Anders Carlsson <andersca@gnu.org>
  63 To: Vaclav Slavik <vaclav.slavik@matfyz.cz>
  64 In-Reply-To: <200312091142.54542.vaclav.slavik@matfyz.cz>
  65 References: <200312091142.54542.vaclav.slavik@matfyz.cz>
  66 Content-Type: text/plain
  67 Message-Id: <1070971316.30989.0.camel@carbon.csbnet.se>
  68 Mime-Version: 1.0
  69 X-Mailer: Ximian Evolution 1.5
  70 Date: Tue, 09 Dec 2003 13:01:56 +0100
  71 Content-Transfer-Encoding: 7bit
  72 X-Scanned-By: CLAM (openantivirus DB) antivirus scanner at mail.csbnet.se
  73 X-Virus-Scanned: by amavisd-new-20030616-p5 (Debian) at armitage
  74 X-Spam-Status: No, hits=-4.9 tagged_above=-999.0 required=6.3 tests=BAYES_00
  75 X-Spam-Level:
  76 Status: R
  77 X-Status: N
  78 X-KMail-EncryptionState:
  79 X-KMail-SignatureState:
  80
  81 On tis, 2003-12-09 at 11:42 +0100, Vaclav Slavik wrote:
  82 > Hi,
  83 >
  84 > I'm working on the wxWindows cross-platform GUI toolkit
  85 > (http://www.wxwindows.org) which uses GTK+ and it would save me a lot
  86 > of time if I could use your eggtrayicon code to implement tray icons
  87 > on X11. Unfortunately I can't use it right now because it is not part
  88 > of any library we could depend on (as we do depend on GTK+) and would
  89 > have to be included in our sources and it is under the LGPL license.
  90 > The problem is that wxWindows' license is more permissive (see
  91 > http://www.opensource.org/licenses/wxwindows.php for details) and so
  92 > I can't take your code and put it under wxWindows License. And I
  93 > can't put code that can't be used under the terms of wxWindows
  94 > License into wxWindows either. Do you think it would be possible to
  95 > get permission to include eggtrayicon under wxWindows license?
  96 >
  97 > Thanks,
  98 > Vaclav
  99 >
 100
 101 Sure, that's fine by me.
 102
 103 Anders
 104 --------
 105 */
 106
 107 #include "wx/platform.h"
 108
 109 #include <gdk/gdkx.h>
 110 #include <gtk/gtkversion.h>
 111
 112 #if defined(__WXGTK20__) && GTK_CHECK_VERSION(2, 1, 0)
 113
 114 #include <string.h>
 115 #include "eggtrayicon.h"
 116
 117 #define SYSTEM_TRAY_REQUEST_DOCK    0
 118 #define SYSTEM_TRAY_BEGIN_MESSAGE   1
 119 #define SYSTEM_TRAY_CANCEL_MESSAGE  2
 120
 121 static GtkPlugClass *parent_class = NULL;
 122
 123 static void egg_tray_icon_init (EggTrayIcon *icon);
 124 static void egg_tray_icon_class_init (EggTrayIconClass *klass);
 125
 126 static void egg_tray_icon_unrealize (GtkWidget *widget);
 127
 128 static void egg_tray_icon_update_manager_window (EggTrayIcon *icon);
 129
 130 GType
 131 egg_tray_icon_get_type (void)
 132 {
 133   static GType our_type = 0;
 134
 135   if (our_type == 0)
 136     {
 137       static const GTypeInfo our_info =
 138       {
 139         sizeof (EggTrayIconClass),
 140         (GBaseInitFunc) NULL,
 141         (GBaseFinalizeFunc) NULL,
 142         (GClassInitFunc) egg_tray_icon_class_init,
 143         NULL, /* class_finalize */
 144         NULL, /* class_data */
 145         sizeof (EggTrayIcon),
 146         0,    /* n_preallocs */
 147         (GInstanceInitFunc) egg_tray_icon_init
 148       };
 149
 150       our_type = g_type_register_static (GTK_TYPE_PLUG, "EggTrayIcon", &our_info, 0);
 151     }
 152
 153   return our_type;
 154 }
 155
 156 static void
 157 egg_tray_icon_init (EggTrayIcon *icon)
 158 {
 159   icon->stamp = 1;
 160
 161   gtk_widget_add_events (GTK_WIDGET (icon), GDK_PROPERTY_CHANGE_MASK);
 162 }
 163
 164 static void
 165 egg_tray_icon_class_init (EggTrayIconClass *klass)
 166 {
 167   GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
 168
 169   parent_class = g_type_class_peek_parent (klass);
 170
 171   widget_class->unrealize = egg_tray_icon_unrealize;
 172 }
 173
 174 static GdkFilterReturn
 175 egg_tray_icon_manager_filter (GdkXEvent *xevent, GdkEvent *event, gpointer user_data)
 176 {
 177   EggTrayIcon *icon = user_data;
 178   XEvent *xev = (XEvent *)xevent;
 179
 180   if (xev->xany.type == ClientMessage &&
 181       xev->xclient.message_type == icon->manager_atom &&
 182       xev->xclient.data.l[1] == icon->selection_atom)
 183     {
 184       egg_tray_icon_update_manager_window (icon);
 185     }
 186   else if (xev->xany.window == icon->manager_window)
 187     {
 188       if (xev->xany.type == DestroyNotify)
 189         {
 190           egg_tray_icon_update_manager_window (icon);
 191         }
 192     }
 193
 194   return GDK_FILTER_CONTINUE;
 195 }
 196
 197 static void
 198 egg_tray_icon_unrealize (GtkWidget *widget)
 199 {
 200   EggTrayIcon *icon = EGG_TRAY_ICON (widget);
 201   GdkWindow *root_window;
 202
 203   if (icon->manager_window != None)
 204     {
 205       GdkWindow *gdkwin;
 206
 207       gdkwin = gdk_window_lookup_for_display (gtk_widget_get_display (widget),
 208                                               icon->manager_window);
 209
 210       gdk_window_remove_filter (gdkwin, egg_tray_icon_manager_filter, icon);
 211     }
 212
 213   root_window = gdk_screen_get_root_window (gtk_widget_get_screen (widget));
 214
 215   gdk_window_remove_filter (root_window, egg_tray_icon_manager_filter, icon);
 216
 217   if (GTK_WIDGET_CLASS (parent_class)->unrealize)
 218     (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
 219 }
 220
 221 static void
 222 egg_tray_icon_send_manager_message (EggTrayIcon *icon,
 223                                     long         message,
 224                                     Window       window,
 225                                     long         data1,
 226                                     long         data2,
 227                                     long         data3)
 228 {
 229   XClientMessageEvent ev;
 230   Display *display;
 231
 232   ev.type = ClientMessage;
 233   ev.window = window;
 234   ev.message_type = icon->system_tray_opcode_atom;
 235   ev.format = 32;
 236   ev.data.l[0] = gdk_x11_get_server_time (GTK_WIDGET (icon)->window);
 237   ev.data.l[1] = message;
 238   ev.data.l[2] = data1;
 239   ev.data.l[3] = data2;
 240   ev.data.l[4] = data3;
 241
 242   display = GDK_DISPLAY_XDISPLAY (gtk_widget_get_display (GTK_WIDGET (icon)));
 243
 244   gdk_error_trap_push ();
 245   XSendEvent (display,
 246               icon->manager_window, False, NoEventMask, (XEvent *)&ev);
 247   XSync (display, False);
 248   gdk_error_trap_pop ();
 249 }
 250
 251 static void
 252 egg_tray_icon_send_dock_request (EggTrayIcon *icon)
 253 {
 254   egg_tray_icon_send_manager_message (icon,
 255                                       SYSTEM_TRAY_REQUEST_DOCK,
 256                                       icon->manager_window,
 257                                       gtk_plug_get_id (GTK_PLUG (icon)),
 258                                       0, 0);
 259 }
 260
 261 static void
 262 egg_tray_icon_update_manager_window (EggTrayIcon *icon)
 263 {
 264   Display *xdisplay;
 265
 266   xdisplay = GDK_DISPLAY_XDISPLAY (gtk_widget_get_display (GTK_WIDGET (icon)));
 267
 268   if (icon->manager_window != None)
 269     {
 270       GdkWindow *gdkwin;
 271
 272       gdkwin = gdk_window_lookup_for_display (gtk_widget_get_display (GTK_WIDGET (icon)),
 273                                               icon->manager_window);
 274
 275       gdk_window_remove_filter (gdkwin, egg_tray_icon_manager_filter, icon);
 276     }
 277
 278   XGrabServer (xdisplay);
 279
 280   icon->manager_window = XGetSelectionOwner (xdisplay,
 281                                              icon->selection_atom);
 282
 283   if (icon->manager_window != None)
 284     XSelectInput (xdisplay,
 285                   icon->manager_window, StructureNotifyMask);
 286
 287   XUngrabServer (xdisplay);
 288   XFlush (xdisplay);
 289
 290   if (icon->manager_window != None)
 291     {
 292       GdkWindow *gdkwin;
 293
 294       gdkwin = gdk_window_lookup_for_display (gtk_widget_get_display (GTK_WIDGET (icon)),
 295                                               icon->manager_window);
 296
 297       gdk_window_add_filter (gdkwin, egg_tray_icon_manager_filter, icon);
 298
 299       /* Send a request that we'd like to dock */
 300       egg_tray_icon_send_dock_request (icon);
 301     }
 302 }
 303
 304 EggTrayIcon *
 305 egg_tray_icon_new_for_xscreen (Screen *xscreen, const char *name)
 306 {
 307   EggTrayIcon *icon;
 308   char buffer[256];
 309   GdkWindow *root_window;
 310   GdkDisplay *display;
 311   GdkScreen *screen;
 312
 313   g_return_val_if_fail (xscreen != NULL, NULL);
 314
 315   icon = g_object_new (EGG_TYPE_TRAY_ICON, NULL);
 316   gtk_window_set_title (GTK_WINDOW (icon), name);
 317
 318   display = gdk_x11_lookup_xdisplay (DisplayOfScreen (xscreen));
 319   screen = gdk_display_get_screen (display, XScreenNumberOfScreen (xscreen));
 320
 321   gtk_plug_construct_for_display (GTK_PLUG (icon),
 322                                   display, 0);
 323
 324   gtk_window_set_screen (GTK_WINDOW (icon), screen);
 325
 326   gtk_widget_realize (GTK_WIDGET (icon));
 327
 328   /* Now see if there's a manager window around */
 329   g_snprintf (buffer, sizeof (buffer),
 330               "_NET_SYSTEM_TRAY_S%d",
 331               XScreenNumberOfScreen (xscreen));
 332
 333   icon->selection_atom = XInternAtom (DisplayOfScreen (xscreen),
 334                                       buffer, False);
 335
 336   icon->manager_atom = XInternAtom (DisplayOfScreen (xscreen),
 337                                     "MANAGER", False);
 338
 339   icon->system_tray_opcode_atom = XInternAtom (DisplayOfScreen (xscreen),
 340                                                "_NET_SYSTEM_TRAY_OPCODE", False);
 341
 342   egg_tray_icon_update_manager_window (icon);
 343
 344   root_window = gdk_screen_get_root_window (gtk_widget_get_screen (GTK_WIDGET (icon)));
 345
 346   /* Add a root window filter so that we get changes on MANAGER */
 347   gdk_window_add_filter (root_window,
 348                          egg_tray_icon_manager_filter, icon);
 349
 350   return icon;
 351 }
 352
 353 EggTrayIcon *
 354 egg_tray_icon_new_for_screen (GdkScreen *screen, const char *name)
 355 {
 356   g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
 357
 358   return egg_tray_icon_new_for_xscreen (GDK_SCREEN_XSCREEN (screen), name);
 359 }
 360
 361 EggTrayIcon*
 362 egg_tray_icon_new (const gchar *name)
 363 {
 364   return egg_tray_icon_new_for_xscreen (DefaultScreenOfDisplay (gdk_display), name);
 365 }
 366
 367 guint
 368 egg_tray_icon_send_message (EggTrayIcon *icon,
 369                             gint         timeout,
 370                             const gchar *message,
 371                             gint         len)
 372 {
 373   guint stamp;
 374
 375   g_return_val_if_fail (EGG_IS_TRAY_ICON (icon), 0);
 376   g_return_val_if_fail (timeout >= 0, 0);
 377   g_return_val_if_fail (message != NULL, 0);
 378
 379   if (icon->manager_window == None)
 380     return 0;
 381
 382   if (len < 0)
 383     len = strlen (message);
 384
 385   stamp = icon->stamp++;
 386
 387   /* Get ready to send the message */
 388   egg_tray_icon_send_manager_message (icon, SYSTEM_TRAY_BEGIN_MESSAGE,
 389                                       (Window)gtk_plug_get_id (GTK_PLUG (icon)),
 390                                       timeout, len, stamp);
 391
 392   /* Now to send the actual message */
 393   gdk_error_trap_push ();
 394   while (len > 0)
 395     {
 396       XClientMessageEvent ev;
 397       Display *xdisplay;
 398
 399       xdisplay = GDK_DISPLAY_XDISPLAY (gtk_widget_get_display (GTK_WIDGET (icon)));
 400
 401       ev.type = ClientMessage;
 402       ev.window = (Window)gtk_plug_get_id (GTK_PLUG (icon));
 403       ev.format = 8;
 404       ev.message_type = XInternAtom (xdisplay,
 405                                      "_NET_SYSTEM_TRAY_MESSAGE_DATA", False);
 406       if (len > 20)
 407         {
 408           memcpy (&ev.data, message, 20);
 409           len -= 20;
 410           message += 20;
 411         }
 412       else
 413         {
 414           memcpy (&ev.data, message, len);
 415           len = 0;
 416         }
 417
 418       XSendEvent (xdisplay,
 419                   icon->manager_window, False, StructureNotifyMask, (XEvent *)&ev);
 420       XSync (xdisplay, False);
 421     }
 422   gdk_error_trap_pop ();
 423
 424   return stamp;
 425 }
 426
 427 void
 428 egg_tray_icon_cancel_message (EggTrayIcon *icon,
 429                               guint        id)
 430 {
 431   g_return_if_fail (EGG_IS_TRAY_ICON (icon));
 432   g_return_if_fail (id > 0);
 433
 434   egg_tray_icon_send_manager_message (icon, SYSTEM_TRAY_CANCEL_MESSAGE,
 435                                       (Window)gtk_plug_get_id (GTK_PLUG (icon)),
 436                                       id, 0, 0);
 437 }
 438
 439 #endif /* __WXGTK20__ */