2 * Copyright (C) 2002 Anders Carlsson <andersca@gnu.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * This is an implementation of the freedesktop.org "system tray" spec,
22 * http://www.freedesktop.org/wiki/Standards/systemtray-spec
29 #include "gtkprivate.h"
30 #include "gtktrayicon.h"
35 #include <X11/Xatom.h>
37 #define SYSTEM_TRAY_REQUEST_DOCK 0
38 #define SYSTEM_TRAY_BEGIN_MESSAGE 1
39 #define SYSTEM_TRAY_CANCEL_MESSAGE 2
41 #define SYSTEM_TRAY_ORIENTATION_HORZ 0
42 #define SYSTEM_TRAY_ORIENTATION_VERT 1
49 struct _GtkTrayIconPrivate
55 Atom system_tray_opcode_atom;
56 Atom orientation_atom;
58 Window manager_window;
59 GdkVisual *manager_visual;
60 gboolean manager_visual_rgba;
62 GtkOrientation orientation;
65 static void gtk_tray_icon_constructed (GObject *object);
66 static void gtk_tray_icon_dispose (GObject *object);
68 static void gtk_tray_icon_get_property (GObject *object,
73 static void gtk_tray_icon_realize (GtkWidget *widget);
74 static void gtk_tray_icon_style_set (GtkWidget *widget,
75 GtkStyle *previous_style);
76 static gboolean gtk_tray_icon_delete (GtkWidget *widget,
78 static gboolean gtk_tray_icon_expose (GtkWidget *widget,
79 GdkEventExpose *event);
81 static void gtk_tray_icon_clear_manager_window (GtkTrayIcon *icon);
82 static void gtk_tray_icon_update_manager_window (GtkTrayIcon *icon);
83 static void gtk_tray_icon_manager_window_destroyed (GtkTrayIcon *icon);
85 static GdkFilterReturn gtk_tray_icon_manager_filter (GdkXEvent *xevent,
90 G_DEFINE_TYPE (GtkTrayIcon, gtk_tray_icon, GTK_TYPE_PLUG)
93 gtk_tray_icon_class_init (GtkTrayIconClass *class)
95 GObjectClass *gobject_class = (GObjectClass *)class;
96 GtkWidgetClass *widget_class = (GtkWidgetClass *)class;
98 gobject_class->get_property = gtk_tray_icon_get_property;
99 gobject_class->constructed = gtk_tray_icon_constructed;
100 gobject_class->dispose = gtk_tray_icon_dispose;
102 widget_class->realize = gtk_tray_icon_realize;
103 widget_class->style_set = gtk_tray_icon_style_set;
104 widget_class->delete_event = gtk_tray_icon_delete;
105 widget_class->expose_event = gtk_tray_icon_expose;
107 g_object_class_install_property (gobject_class,
109 g_param_spec_enum ("orientation",
111 P_("The orientation of the tray"),
112 GTK_TYPE_ORIENTATION,
113 GTK_ORIENTATION_HORIZONTAL,
114 GTK_PARAM_READABLE));
116 g_type_class_add_private (class, sizeof (GtkTrayIconPrivate));
120 gtk_tray_icon_init (GtkTrayIcon *icon)
122 icon->priv = G_TYPE_INSTANCE_GET_PRIVATE (icon, GTK_TYPE_TRAY_ICON,
125 icon->priv->stamp = 1;
126 icon->priv->orientation = GTK_ORIENTATION_HORIZONTAL;
128 gtk_widget_set_app_paintable (GTK_WIDGET (icon), TRUE);
129 gtk_widget_add_events (GTK_WIDGET (icon), GDK_PROPERTY_CHANGE_MASK);
133 gtk_tray_icon_constructed (GObject *object)
135 /* Do setup that depends on the screen; screen has been set at this point */
137 GtkTrayIcon *icon = GTK_TRAY_ICON (object);
138 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (object));
139 GdkWindow *root_window = gdk_screen_get_root_window (screen);
140 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET (object));
141 Display *xdisplay = gdk_x11_display_get_xdisplay (display);
144 g_snprintf (buffer, sizeof (buffer),
145 "_NET_SYSTEM_TRAY_S%d",
146 gdk_screen_get_number (screen));
148 icon->priv->selection_atom = XInternAtom (xdisplay, buffer, False);
150 icon->priv->manager_atom = XInternAtom (xdisplay, "MANAGER", False);
152 icon->priv->system_tray_opcode_atom = XInternAtom (xdisplay,
153 "_NET_SYSTEM_TRAY_OPCODE",
156 icon->priv->orientation_atom = XInternAtom (xdisplay,
157 "_NET_SYSTEM_TRAY_ORIENTATION",
160 icon->priv->visual_atom = XInternAtom (xdisplay,
161 "_NET_SYSTEM_TRAY_VISUAL",
164 /* Add a root window filter so that we get changes on MANAGER */
165 gdk_window_add_filter (root_window,
166 gtk_tray_icon_manager_filter, icon);
168 gtk_tray_icon_update_manager_window (icon);
172 gtk_tray_icon_clear_manager_window (GtkTrayIcon *icon)
174 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET (icon));
176 if (icon->priv->manager_window != None)
180 gdkwin = gdk_window_lookup_for_display (display,
181 icon->priv->manager_window);
183 gdk_window_remove_filter (gdkwin, gtk_tray_icon_manager_filter, icon);
185 icon->priv->manager_window = None;
186 icon->priv->manager_visual = NULL;
191 gtk_tray_icon_dispose (GObject *object)
193 GtkTrayIcon *icon = GTK_TRAY_ICON (object);
194 GtkWidget *widget = GTK_WIDGET (object);
195 GdkWindow *root_window = gdk_screen_get_root_window (gtk_widget_get_screen (widget));
197 gtk_tray_icon_clear_manager_window (icon);
199 gdk_window_remove_filter (root_window, gtk_tray_icon_manager_filter, icon);
203 gtk_tray_icon_get_property (GObject *object,
208 GtkTrayIcon *icon = GTK_TRAY_ICON (object);
212 case PROP_ORIENTATION:
213 g_value_set_enum (value, icon->priv->orientation);
216 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
222 gtk_tray_icon_expose (GtkWidget *widget,
223 GdkEventExpose *event)
225 GtkTrayIcon *icon = GTK_TRAY_ICON (widget);
226 GtkWidget *focus_child;
227 gint border_width, x, y, width, height;
228 gboolean retval = FALSE;
230 if (icon->priv->manager_visual_rgba)
232 /* Clear to transparent */
233 cairo_t *cr = gdk_cairo_create (widget->window);
234 cairo_set_source_rgba (cr, 0, 0, 0, 0);
235 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
236 gdk_cairo_region (cr, event->region);
242 /* Clear to parent-relative pixmap */
243 gdk_window_clear_area (widget->window, event->area.x, event->area.y,
244 event->area.width, event->area.height);
247 if (GTK_WIDGET_CLASS (gtk_tray_icon_parent_class)->expose_event)
248 retval = GTK_WIDGET_CLASS (gtk_tray_icon_parent_class)->expose_event (widget, event);
250 focus_child = GTK_CONTAINER (widget)->focus_child;
251 if (focus_child && GTK_WIDGET_HAS_FOCUS (focus_child))
253 border_width = GTK_CONTAINER (widget)->border_width;
255 x = widget->allocation.x + border_width;
256 y = widget->allocation.y + border_width;
258 width = widget->allocation.width - 2 * border_width;
259 height = widget->allocation.height - 2 * border_width;
261 gtk_paint_focus (widget->style, widget->window,
262 GTK_WIDGET_STATE (widget),
263 &event->area, widget, "tray_icon",
264 x, y, width, height);
271 gtk_tray_icon_get_orientation_property (GtkTrayIcon *icon)
273 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (icon));
274 GdkDisplay *display = gdk_screen_get_display (screen);
275 Display *xdisplay = GDK_DISPLAY_XDISPLAY (display);
287 g_assert (icon->priv->manager_window != None);
289 gdk_error_trap_push ();
291 result = XGetWindowProperty (xdisplay,
292 icon->priv->manager_window,
293 icon->priv->orientation_atom,
296 &type, &format, &nitems,
297 &bytes_after, &(prop.prop_ch));
298 error = gdk_error_trap_pop ();
300 if (error || result != Success)
303 if (type == XA_CARDINAL && nitems == 1 && format == 32)
305 GtkOrientation orientation;
307 orientation = (prop.prop [0] == SYSTEM_TRAY_ORIENTATION_HORZ) ?
308 GTK_ORIENTATION_HORIZONTAL :
309 GTK_ORIENTATION_VERTICAL;
311 if (icon->priv->orientation != orientation)
313 icon->priv->orientation = orientation;
315 g_object_notify (G_OBJECT (icon), "orientation");
324 gtk_tray_icon_get_visual_property (GtkTrayIcon *icon)
326 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (icon));
327 GdkDisplay *display = gdk_screen_get_display (screen);
328 Display *xdisplay = GDK_DISPLAY_XDISPLAY (display);
341 g_assert (icon->priv->manager_window != None);
343 gdk_error_trap_push ();
345 result = XGetWindowProperty (xdisplay,
346 icon->priv->manager_window,
347 icon->priv->visual_atom,
350 &type, &format, &nitems,
351 &bytes_after, &(prop.prop_ch));
352 error = gdk_error_trap_pop ();
356 if (!error && result == Success &&
357 type == XA_VISUALID && nitems == 1 && format == 32)
359 VisualID visual_id = prop.prop[0];
360 visual = gdk_x11_screen_lookup_visual (screen, visual_id);
363 icon->priv->manager_visual = visual;
364 icon->priv->manager_visual_rgba = visual != NULL &&
365 (visual->red_prec + visual->blue_prec + visual->green_prec < visual->depth);
367 /* For the background-relative hack we use when we aren't using a real RGBA
368 * visual, we can't be double-buffered */
369 gtk_widget_set_double_buffered (GTK_WIDGET (icon), icon->priv->manager_visual_rgba);
375 static GdkFilterReturn
376 gtk_tray_icon_manager_filter (GdkXEvent *xevent,
380 GtkTrayIcon *icon = user_data;
381 XEvent *xev = (XEvent *)xevent;
383 if (xev->xany.type == ClientMessage &&
384 xev->xclient.message_type == icon->priv->manager_atom &&
385 xev->xclient.data.l[1] == icon->priv->selection_atom)
387 GTK_NOTE (PLUGSOCKET,
388 g_print ("GtkStatusIcon %p: tray manager appeared\n", icon));
390 gtk_tray_icon_update_manager_window (icon);
392 else if (xev->xany.window == icon->priv->manager_window)
394 if (xev->xany.type == PropertyNotify &&
395 xev->xproperty.atom == icon->priv->orientation_atom)
397 GTK_NOTE (PLUGSOCKET,
398 g_print ("GtkStatusIcon %p: got PropertyNotify on manager window for orientation atom\n", icon));
400 gtk_tray_icon_get_orientation_property (icon);
402 else if (xev->xany.type == DestroyNotify)
404 GTK_NOTE (PLUGSOCKET,
405 g_print ("GtkStatusIcon %p: got DestroyNotify for manager window\n", icon));
407 gtk_tray_icon_manager_window_destroyed (icon);
410 GTK_NOTE (PLUGSOCKET,
411 g_print ("GtkStatusIcon %p: got other message on manager window\n", icon));
414 return GDK_FILTER_CONTINUE;
418 gtk_tray_icon_send_manager_message (GtkTrayIcon *icon,
425 XClientMessageEvent ev;
428 memset (&ev, 0, sizeof (ev));
429 ev.type = ClientMessage;
431 ev.message_type = icon->priv->system_tray_opcode_atom;
433 ev.data.l[0] = gdk_x11_get_server_time (GTK_WIDGET (icon)->window);
434 ev.data.l[1] = message;
435 ev.data.l[2] = data1;
436 ev.data.l[3] = data2;
437 ev.data.l[4] = data3;
439 display = GDK_DISPLAY_XDISPLAY (gtk_widget_get_display (GTK_WIDGET (icon)));
441 gdk_error_trap_push ();
443 icon->priv->manager_window, False, NoEventMask, (XEvent *)&ev);
444 gdk_display_sync (gtk_widget_get_display (GTK_WIDGET (icon)));
445 gdk_error_trap_pop ();
449 gtk_tray_icon_send_dock_request (GtkTrayIcon *icon)
451 GTK_NOTE (PLUGSOCKET,
452 g_print ("GtkStatusIcon %p: sending dock request to manager window %lx\n",
453 icon, (gulong) icon->priv->manager_window));
455 gtk_tray_icon_send_manager_message (icon,
456 SYSTEM_TRAY_REQUEST_DOCK,
457 icon->priv->manager_window,
458 gtk_plug_get_id (GTK_PLUG (icon)),
463 gtk_tray_icon_update_manager_window (GtkTrayIcon *icon)
465 GtkWidget *widget = GTK_WIDGET (icon);
466 GdkScreen *screen = gtk_widget_get_screen (widget);
467 GdkDisplay *display = gdk_screen_get_display (screen);
468 Display *xdisplay = GDK_DISPLAY_XDISPLAY (display);
470 GTK_NOTE (PLUGSOCKET,
471 g_print ("GtkStatusIcon %p: updating tray icon manager window, current manager window: %lx\n",
472 icon, (gulong) icon->priv->manager_window));
474 if (icon->priv->manager_window != None)
477 GTK_NOTE (PLUGSOCKET,
478 g_print ("GtkStatusIcon %p: trying to find manager window\n", icon));
480 XGrabServer (xdisplay);
482 icon->priv->manager_window = XGetSelectionOwner (xdisplay,
483 icon->priv->selection_atom);
485 if (icon->priv->manager_window != None)
486 XSelectInput (xdisplay,
487 icon->priv->manager_window, StructureNotifyMask|PropertyChangeMask);
489 XUngrabServer (xdisplay);
492 if (icon->priv->manager_window != None)
496 GTK_NOTE (PLUGSOCKET,
497 g_print ("GtkStatusIcon %p: is being managed by window %lx\n",
498 icon, (gulong) icon->priv->manager_window));
500 gdkwin = gdk_window_lookup_for_display (display,
501 icon->priv->manager_window);
503 gdk_window_add_filter (gdkwin, gtk_tray_icon_manager_filter, icon);
505 gtk_tray_icon_get_orientation_property (icon);
506 gtk_tray_icon_get_visual_property (icon);
508 if (GTK_WIDGET_REALIZED (icon))
510 if ((icon->priv->manager_visual == NULL &&
511 gtk_widget_get_visual (widget) == gdk_screen_get_system_visual (screen)) ||
512 (icon->priv->manager_visual == gtk_widget_get_visual (widget)))
514 /* Already have the right visual, can just dock
516 gtk_tray_icon_send_dock_request (icon);
520 /* Need to re-realize the widget to get the right visual
522 gtk_widget_hide (widget);
523 gtk_widget_unrealize (widget);
524 gtk_widget_show (widget);
529 GTK_NOTE (PLUGSOCKET,
530 g_print ("GtkStatusIcon %p: no tray manager found\n", icon));
534 gtk_tray_icon_manager_window_destroyed (GtkTrayIcon *icon)
536 g_return_if_fail (icon->priv->manager_window != None);
538 GTK_NOTE (PLUGSOCKET,
539 g_print ("GtkStatusIcon %p: tray manager window destroyed\n", icon));
541 gtk_tray_icon_clear_manager_window (icon);
545 gtk_tray_icon_delete (GtkWidget *widget,
548 GtkTrayIcon *icon = GTK_TRAY_ICON (widget);
550 GTK_NOTE (PLUGSOCKET,
551 g_print ("GtkStatusIcon %p: delete notify, tray manager window %lx\n",
552 icon, (gulong) icon->priv->manager_window));
554 /* A bug in X server versions up to x.org 1.5.0 means that:
555 * XFixesChangeSaveSet(...., SaveSetRoot, SaveSetUnmap) doesn't work properly
556 * and we'll left mapped in a separate toplevel window if the tray is destroyed.
557 * For simplicity just get rid of our X window and start over.
559 gtk_widget_hide (widget);
560 gtk_widget_unrealize (widget);
561 gtk_widget_show (widget);
563 /* Handled it, don't destroy the tray icon */
568 gtk_tray_icon_set_colormap (GtkTrayIcon *icon)
570 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (icon));
571 GdkColormap *colormap;
572 GdkVisual *visual = icon->priv->manager_visual;
573 gboolean new_colormap = FALSE;
575 /* To avoid uncertainty about colormaps, _NET_SYSTEM_TRAY_VISUAL is supposed
576 * to be either the screen default visual or a TrueColor visual; ignore it
577 * if it is something else
579 if (visual && visual->type != GDK_VISUAL_TRUE_COLOR)
582 if (visual == NULL || visual == gdk_screen_get_system_visual (screen))
583 colormap = gdk_screen_get_system_colormap (screen);
584 else if (visual == gdk_screen_get_rgb_visual (screen))
585 colormap = gdk_screen_get_rgb_colormap (screen);
586 else if (visual == gdk_screen_get_rgba_visual (screen))
587 colormap = gdk_screen_get_rgba_colormap (screen);
590 colormap = gdk_colormap_new (visual, FALSE);
594 gtk_widget_set_colormap (GTK_WIDGET (icon), colormap);
597 g_object_unref (colormap);
601 gtk_tray_icon_realize (GtkWidget *widget)
603 GtkTrayIcon *icon = GTK_TRAY_ICON (widget);
605 /* Set our colormap before realizing */
606 gtk_tray_icon_set_colormap (icon);
608 GTK_WIDGET_CLASS (gtk_tray_icon_parent_class)->realize (widget);
609 if (icon->priv->manager_visual_rgba)
611 /* Set a transparent background */
612 GdkColor transparent = { 0, 0, 0, 0 }; /* Only pixel=0 matters */
613 gdk_window_set_background (widget->window, &transparent);
617 /* Set a parent-relative background pixmap */
618 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
621 GTK_NOTE (PLUGSOCKET,
622 g_print ("GtkStatusIcon %p: realized, window: %lx, socket window: %lx\n",
624 (gulong) GDK_WINDOW_XWINDOW (widget->window),
625 GTK_PLUG (icon)->socket_window ?
626 (gulong) GDK_WINDOW_XWINDOW (GTK_PLUG (icon)->socket_window) : 0UL));
628 if (icon->priv->manager_window != None)
629 gtk_tray_icon_send_dock_request (icon);
633 gtk_tray_icon_style_set (GtkWidget *widget,
634 GtkStyle *previous_style)
636 /* The default handler resets the background according to the style. We either
637 * use a transparent background or a parent-relative background and ignore the
638 * style background. So, just don't chain up.
643 _gtk_tray_icon_send_message (GtkTrayIcon *icon,
645 const gchar *message,
651 g_return_val_if_fail (GTK_IS_TRAY_ICON (icon), 0);
652 g_return_val_if_fail (timeout >= 0, 0);
653 g_return_val_if_fail (message != NULL, 0);
655 if (icon->priv->manager_window == None)
659 len = strlen (message);
661 stamp = icon->priv->stamp++;
663 /* Get ready to send the message */
664 gtk_tray_icon_send_manager_message (icon, SYSTEM_TRAY_BEGIN_MESSAGE,
665 (Window)gtk_plug_get_id (GTK_PLUG (icon)),
666 timeout, len, stamp);
668 /* Now to send the actual message */
669 xdisplay = GDK_DISPLAY_XDISPLAY (gtk_widget_get_display (GTK_WIDGET (icon)));
670 gdk_error_trap_push ();
673 XClientMessageEvent ev;
675 memset (&ev, 0, sizeof (ev));
676 ev.type = ClientMessage;
677 ev.window = (Window)gtk_plug_get_id (GTK_PLUG (icon));
679 ev.message_type = XInternAtom (xdisplay,
680 "_NET_SYSTEM_TRAY_MESSAGE_DATA", False);
683 memcpy (&ev.data, message, 20);
689 memcpy (&ev.data, message, len);
693 XSendEvent (xdisplay,
694 icon->priv->manager_window, False,
695 StructureNotifyMask, (XEvent *)&ev);
697 gdk_display_sync (gtk_widget_get_display (GTK_WIDGET (icon)));
698 gdk_error_trap_pop ();
704 _gtk_tray_icon_cancel_message (GtkTrayIcon *icon,
707 g_return_if_fail (GTK_IS_TRAY_ICON (icon));
708 g_return_if_fail (id > 0);
710 gtk_tray_icon_send_manager_message (icon, SYSTEM_TRAY_CANCEL_MESSAGE,
711 (Window)gtk_plug_get_id (GTK_PLUG (icon)),
716 _gtk_tray_icon_new_for_screen (GdkScreen *screen,
719 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
721 return g_object_new (GTK_TYPE_TRAY_ICON,
728 _gtk_tray_icon_new (const gchar *name)
730 return g_object_new (GTK_TYPE_TRAY_ICON,
736 _gtk_tray_icon_get_orientation (GtkTrayIcon *icon)
738 g_return_val_if_fail (GTK_IS_TRAY_ICON (icon), GTK_ORIENTATION_HORIZONTAL);
740 return icon->priv->orientation;
744 #define __GTK_TRAY_ICON_X11_C__
745 #include "gtkaliasdef.c"