3 * Copyright (C) 2003 Sun Microsystems, Inc.
4 * Copyright (C) 2005 Hans Breuer <hans@breuer.org>
5 * Copyright (C) 2005 Novell, Inc.
6 * Copyright (C) 2006 Imendio AB
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
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 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 * Mark McLoughlin <mark@skynet.ie>
23 * Hans Breuer <hans@breuer.org>
24 * Tor Lillqvist <tml@novell.com>
25 * Mikael Hallendal <micke@imendio.com>
32 #include "gtkstatusicon.h"
35 #include "gtkiconfactory.h"
36 #include "gtkiconhelperprivate.h"
38 #include "gtkmarshalers.h"
39 #include "gtksizerequest.h"
40 #include "gtkprivate.h"
41 #include "gtkwidget.h"
42 #include "gtktooltip.h"
43 #include "gtkicontheme.h"
45 #include "gtktypebuiltins.h"
47 #ifdef GDK_WINDOWING_X11
48 #include "gdk/x11/gdkx.h"
49 #include "gtktrayicon.h"
52 #ifdef GDK_WINDOWING_WIN32
53 #include "gdk/win32/gdkwin32.h"
54 #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1)
59 * SECTION:gtkstatusicon
60 * @Short_description: Display an icon in the system tray
61 * @Title: GtkStatusIcon
63 * The "system tray" or notification area is normally used for transient icons
64 * that indicate some special state. For example, a system tray icon might
65 * appear to tell the user that they have new mail, or have an incoming instant
66 * message, or something along those lines. The basic idea is that creating an
67 * icon in the notification area is less annoying than popping up a dialog.
69 * A #GtkStatusIcon object can be used to display an icon in a "system tray".
70 * The icon can have a tooltip, and the user can interact with it by
71 * activating it or popping up a context menu. Critical information should
72 * not solely be displayed in a #GtkStatusIcon, since it may not be
73 * visible (e.g. when the user doesn't have a notification area on his panel).
74 * This can be checked with gtk_status_icon_is_embedded().
76 * On X11, the implementation follows the freedesktop.org "System Tray"
77 * <ulink url="http://www.freedesktop.org/wiki/Specifications/systemtray-spec">specification</ulink>.
78 * Implementations of the "tray" side of this specification can
79 * be found e.g. in the GNOME 2 and KDE panel applications.
81 * Note that a GtkStatusIcon is <emphasis>not</emphasis> a widget, but just
82 * a #GObject. Making it a widget would be impractical, since the system tray
83 * on Win32 doesn't allow to embed arbitrary widgets.
87 #define BLINK_TIMEOUT 500
115 BUTTON_PRESS_EVENT_SIGNAL,
116 BUTTON_RELEASE_EVENT_SIGNAL,
118 QUERY_TOOLTIP_SIGNAL,
122 static guint status_icon_signals [LAST_SIGNAL] = { 0 };
124 #ifdef GDK_WINDOWING_QUARTZ
125 #include "gtkstatusicon-quartz.c"
128 struct _GtkStatusIconPrivate
130 #ifdef GDK_WINDOWING_X11
131 GtkWidget *tray_icon;
134 GtkWidget *dummy_widget;
137 #ifdef GDK_WINDOWING_WIN32
140 gint last_click_x, last_click_y;
141 GtkOrientation orientation;
146 #ifdef GDK_WINDOWING_QUARTZ
147 GtkQuartzStatusIcon *status_item;
153 GtkIconHelper *icon_helper;
157 static GObject* gtk_status_icon_constructor (GType type,
158 guint n_construct_properties,
159 GObjectConstructParam *construct_params);
160 static void gtk_status_icon_finalize (GObject *object);
161 static void gtk_status_icon_set_property (GObject *object,
165 static void gtk_status_icon_get_property (GObject *object,
170 #ifdef GDK_WINDOWING_X11
171 static void gtk_status_icon_size_allocate (GtkStatusIcon *status_icon,
172 GtkAllocation *allocation);
173 static void gtk_status_icon_screen_changed (GtkStatusIcon *status_icon,
174 GdkScreen *old_screen);
175 static void gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon);
176 static void gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon);
177 static void gtk_status_icon_padding_changed (GtkStatusIcon *status_icon);
178 static void gtk_status_icon_icon_size_changed(GtkStatusIcon *status_icon);
179 static void gtk_status_icon_fg_changed (GtkStatusIcon *status_icon);
180 static void gtk_status_icon_color_changed (GtkTrayIcon *tray,
182 GtkStatusIcon *status_icon);
183 static gboolean gtk_status_icon_scroll (GtkStatusIcon *status_icon,
184 GdkEventScroll *event);
185 static gboolean gtk_status_icon_query_tooltip (GtkStatusIcon *status_icon,
188 gboolean keyboard_tip,
189 GtkTooltip *tooltip);
191 static gboolean gtk_status_icon_key_press (GtkStatusIcon *status_icon,
193 static void gtk_status_icon_popup_menu (GtkStatusIcon *status_icon);
195 static gboolean gtk_status_icon_button_press (GtkStatusIcon *status_icon,
196 GdkEventButton *event);
197 static gboolean gtk_status_icon_button_release (GtkStatusIcon *status_icon,
198 GdkEventButton *event);
199 static void gtk_status_icon_reset_image_data (GtkStatusIcon *status_icon);
200 static void gtk_status_icon_update_image (GtkStatusIcon *status_icon);
202 G_DEFINE_TYPE (GtkStatusIcon, gtk_status_icon, G_TYPE_OBJECT)
205 gtk_status_icon_class_init (GtkStatusIconClass *class)
207 GObjectClass *gobject_class = (GObjectClass *) class;
209 gobject_class->constructor = gtk_status_icon_constructor;
210 gobject_class->finalize = gtk_status_icon_finalize;
211 gobject_class->set_property = gtk_status_icon_set_property;
212 gobject_class->get_property = gtk_status_icon_get_property;
214 class->button_press_event = NULL;
215 class->button_release_event = NULL;
216 class->scroll_event = NULL;
217 class->query_tooltip = NULL;
219 g_object_class_install_property (gobject_class,
221 g_param_spec_object ("pixbuf",
223 P_("A GdkPixbuf to display"),
225 GTK_PARAM_READWRITE));
227 g_object_class_install_property (gobject_class,
229 g_param_spec_string ("file",
231 P_("Filename to load and display"),
233 GTK_PARAM_WRITABLE));
235 g_object_class_install_property (gobject_class,
237 g_param_spec_string ("stock",
239 P_("Stock ID for a stock image to display"),
241 GTK_PARAM_READWRITE));
243 g_object_class_install_property (gobject_class,
245 g_param_spec_string ("icon-name",
247 P_("The name of the icon from the icon theme"),
249 GTK_PARAM_READWRITE));
252 * GtkStatusIcon:gicon:
254 * The #GIcon displayed in the #GtkStatusIcon. For themed icons,
255 * the image will be updated automatically if the theme changes.
259 g_object_class_install_property (gobject_class,
261 g_param_spec_object ("gicon",
263 P_("The GIcon being displayed"),
265 GTK_PARAM_READWRITE));
267 g_object_class_install_property (gobject_class,
269 g_param_spec_enum ("storage-type",
271 P_("The representation being used for image data"),
274 GTK_PARAM_READABLE));
276 g_object_class_install_property (gobject_class,
278 g_param_spec_int ("size",
280 P_("The size of the icon"),
284 GTK_PARAM_READABLE));
286 g_object_class_install_property (gobject_class,
288 g_param_spec_object ("screen",
290 P_("The screen where this status icon will be displayed"),
292 GTK_PARAM_READWRITE));
294 g_object_class_install_property (gobject_class,
296 g_param_spec_boolean ("visible",
298 P_("Whether the status icon is visible"),
300 GTK_PARAM_READWRITE));
304 * GtkStatusIcon:embedded:
306 * %TRUE if the statusicon is embedded in a notification area.
310 g_object_class_install_property (gobject_class,
312 g_param_spec_boolean ("embedded",
314 P_("Whether the status icon is embedded"),
316 GTK_PARAM_READABLE));
319 * GtkStatusIcon:orientation:
321 * The orientation of the tray in which the statusicon
326 g_object_class_install_property (gobject_class,
328 g_param_spec_enum ("orientation",
330 P_("The orientation of the tray"),
331 GTK_TYPE_ORIENTATION,
332 GTK_ORIENTATION_HORIZONTAL,
333 GTK_PARAM_READABLE));
336 * GtkStatusIcon:has-tooltip:
338 * Enables or disables the emission of #GtkStatusIcon::query-tooltip on
339 * @status_icon. A value of %TRUE indicates that @status_icon can have a
340 * tooltip, in this case the status icon will be queried using
341 * #GtkStatusIcon::query-tooltip to determine whether it will provide a
344 * Note that setting this property to %TRUE for the first time will change
345 * the event masks of the windows of this status icon to include leave-notify
346 * and motion-notify events. This will not be undone when the property is set
349 * Whether this property is respected is platform dependent.
350 * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
354 g_object_class_install_property (gobject_class,
356 g_param_spec_boolean ("has-tooltip",
358 P_("Whether this tray icon has a tooltip"),
360 GTK_PARAM_READWRITE));
362 * GtkStatusIcon:tooltip-text:
364 * Sets the text of tooltip to be the given string.
366 * Also see gtk_tooltip_set_text().
368 * This is a convenience property which will take care of getting the
369 * tooltip shown if the given string is not %NULL.
370 * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
371 * the default handler for the #GtkStatusIcon::query-tooltip signal
372 * will take care of displaying the tooltip.
374 * Note that some platforms have limitations on the length of tooltips
375 * that they allow on status icons, e.g. Windows only shows the first
380 g_object_class_install_property (gobject_class,
382 g_param_spec_string ("tooltip-text",
384 P_("The contents of the tooltip for this widget"),
386 GTK_PARAM_READWRITE));
388 * GtkStatusIcon:tooltip-markup:
390 * Sets the text of tooltip to be the given string, which is marked up
391 * with the <link linkend="PangoMarkupFormat">Pango text markup
392 * language</link>. Also see gtk_tooltip_set_markup().
394 * This is a convenience property which will take care of getting the
395 * tooltip shown if the given string is not %NULL.
396 * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
397 * the default handler for the #GtkStatusIcon::query-tooltip signal
398 * will take care of displaying the tooltip.
400 * On some platforms, embedded markup will be ignored.
404 g_object_class_install_property (gobject_class,
406 g_param_spec_string ("tooltip-markup",
407 P_("Tooltip markup"),
408 P_("The contents of the tooltip for this tray icon"),
410 GTK_PARAM_READWRITE));
414 * GtkStatusIcon:title:
416 * The title of this tray icon. This should be a short, human-readable,
417 * localized string describing the tray icon. It may be used by tools
418 * like screen readers to render the tray icon.
422 g_object_class_install_property (gobject_class,
424 g_param_spec_string ("title",
426 P_("The title of this tray icon"),
428 GTK_PARAM_READWRITE));
431 * GtkStatusIcon::activate:
432 * @status_icon: the object which received the signal
434 * Gets emitted when the user activates the status icon.
435 * If and how status icons can activated is platform-dependent.
437 * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
438 * be used by applications and should be wrapped by language bindings.
442 status_icon_signals [ACTIVATE_SIGNAL] =
443 g_signal_new (I_("activate"),
444 G_TYPE_FROM_CLASS (gobject_class),
445 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
446 G_STRUCT_OFFSET (GtkStatusIconClass, activate),
449 g_cclosure_marshal_VOID__VOID,
454 * GtkStatusIcon::popup-menu:
455 * @status_icon: the object which received the signal
456 * @button: the button that was pressed, or 0 if the
457 * signal is not emitted in response to a button press event
458 * @activate_time: the timestamp of the event that
459 * triggered the signal emission
461 * Gets emitted when the user brings up the context menu
462 * of the status icon. Whether status icons can have context
463 * menus and how these are activated is platform-dependent.
465 * The @button and @activate_time parameters should be
466 * passed as the last to arguments to gtk_menu_popup().
468 * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
469 * be used by applications and should be wrapped by language bindings.
473 status_icon_signals [POPUP_MENU_SIGNAL] =
474 g_signal_new (I_("popup-menu"),
475 G_TYPE_FROM_CLASS (gobject_class),
476 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
477 G_STRUCT_OFFSET (GtkStatusIconClass, popup_menu),
480 _gtk_marshal_VOID__UINT_UINT,
487 * GtkStatusIcon::size-changed:
488 * @status_icon: the object which received the signal
489 * @size: the new size
491 * Gets emitted when the size available for the image
492 * changes, e.g. because the notification area got resized.
494 * Return value: %TRUE if the icon was updated for the new
495 * size. Otherwise, GTK+ will scale the icon as necessary.
499 status_icon_signals [SIZE_CHANGED_SIGNAL] =
500 g_signal_new (I_("size-changed"),
501 G_TYPE_FROM_CLASS (gobject_class),
503 G_STRUCT_OFFSET (GtkStatusIconClass, size_changed),
504 g_signal_accumulator_true_handled,
506 _gtk_marshal_BOOLEAN__INT,
512 * GtkStatusIcon::button-press-event:
513 * @status_icon: the object which received the signal
514 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
517 * The ::button-press-event signal will be emitted when a button
518 * (typically from a mouse) is pressed.
520 * Whether this event is emitted is platform-dependent. Use the ::activate
521 * and ::popup-menu signals in preference.
523 * Return value: %TRUE to stop other handlers from being invoked
524 * for the event. %FALSE to propagate the event further.
528 status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL] =
529 g_signal_new (I_("button_press_event"),
530 G_TYPE_FROM_CLASS (gobject_class),
532 G_STRUCT_OFFSET (GtkStatusIconClass, button_press_event),
533 g_signal_accumulator_true_handled, NULL,
534 _gtk_marshal_BOOLEAN__BOXED,
536 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
539 * GtkStatusIcon::button-release-event:
540 * @status_icon: the object which received the signal
541 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
544 * The ::button-release-event signal will be emitted when a button
545 * (typically from a mouse) is released.
547 * Whether this event is emitted is platform-dependent. Use the ::activate
548 * and ::popup-menu signals in preference.
550 * Return value: %TRUE to stop other handlers from being invoked
551 * for the event. %FALSE to propagate the event further.
555 status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL] =
556 g_signal_new (I_("button_release_event"),
557 G_TYPE_FROM_CLASS (gobject_class),
559 G_STRUCT_OFFSET (GtkStatusIconClass, button_release_event),
560 g_signal_accumulator_true_handled, NULL,
561 _gtk_marshal_BOOLEAN__BOXED,
563 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
566 * GtkStatusIcon::scroll-event:
567 * @status_icon: the object which received the signal.
568 * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
571 * The ::scroll-event signal is emitted when a button in the 4 to 7
572 * range is pressed. Wheel mice are usually configured to generate
573 * button press events for buttons 4 and 5 when the wheel is turned.
575 * Whether this event is emitted is platform-dependent.
577 * Returns: %TRUE to stop other handlers from being invoked for the event.
578 * %FALSE to propagate the event further.
582 status_icon_signals[SCROLL_EVENT_SIGNAL] =
583 g_signal_new (I_("scroll_event"),
584 G_TYPE_FROM_CLASS (gobject_class),
586 G_STRUCT_OFFSET (GtkStatusIconClass, scroll_event),
587 g_signal_accumulator_true_handled, NULL,
588 _gtk_marshal_BOOLEAN__BOXED,
590 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
593 * GtkStatusIcon::query-tooltip:
594 * @status_icon: the object which received the signal
595 * @x: the x coordinate of the cursor position where the request has been
596 * emitted, relative to @status_icon
597 * @y: the y coordinate of the cursor position where the request has been
598 * emitted, relative to @status_icon
599 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
600 * @tooltip: a #GtkTooltip
602 * Emitted when the #GtkSettings:gtk-tooltip-timeout has expired with the
603 * cursor hovering above @status_icon; or emitted when @status_icon got
604 * focus in keyboard mode.
606 * Using the given coordinates, the signal handler should determine
607 * whether a tooltip should be shown for @status_icon. If this is
608 * the case %TRUE should be returned, %FALSE otherwise. Note that if
609 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
610 * should not be used.
612 * The signal handler is free to manipulate @tooltip with the therefore
613 * destined function calls.
615 * Whether this signal is emitted is platform-dependent.
616 * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
618 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
622 status_icon_signals [QUERY_TOOLTIP_SIGNAL] =
623 g_signal_new (I_("query_tooltip"),
624 G_TYPE_FROM_CLASS (gobject_class),
626 G_STRUCT_OFFSET (GtkStatusIconClass, query_tooltip),
627 g_signal_accumulator_true_handled, NULL,
628 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
635 g_type_class_add_private (class, sizeof (GtkStatusIconPrivate));
638 #ifdef GDK_WINDOWING_WIN32
641 build_button_event (GtkStatusIconPrivate *priv,
646 GdkRectangle monitor0;
648 /* We know that gdk/win32 puts the primary monitor at index 0 */
649 gdk_screen_get_monitor_geometry (gdk_screen_get_default (), 0, &monitor0);
650 e->window = g_object_ref (gdk_get_default_root_window ());
651 e->send_event = TRUE;
652 e->time = GetTickCount ();
654 priv->last_click_x = e->x = pos.x + monitor0.x;
655 priv->last_click_y = e->y = pos.y + monitor0.y;
659 //FIXME: e->device = gdk_display_get_default ()->core_pointer;
666 GtkStatusIcon *status_icon;
667 GdkEventButton *event;
668 } ButtonCallbackData;
671 button_callback (gpointer data)
673 ButtonCallbackData *bc = (ButtonCallbackData *) data;
675 if (bc->event->type == GDK_BUTTON_PRESS)
676 gtk_status_icon_button_press (bc->status_icon, bc->event);
678 gtk_status_icon_button_release (bc->status_icon, bc->event);
680 gdk_event_free ((GdkEvent *) bc->event);
683 return G_SOURCE_REMOVE;
686 static UINT taskbar_created_msg = 0;
687 static GSList *status_icons = NULL;
689 static LRESULT CALLBACK
695 if (message == taskbar_created_msg)
699 for (rover = status_icons; rover != NULL; rover = rover->next)
701 GtkStatusIcon *status_icon = GTK_STATUS_ICON (rover->data);
702 GtkStatusIconPrivate *priv = status_icon->priv;
704 priv->nid.hWnd = hwnd;
705 priv->nid.uID = GPOINTER_TO_UINT (status_icon);
706 priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
707 priv->nid.uFlags = NIF_MESSAGE;
709 if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
711 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
712 priv->nid.hWnd = NULL;
716 gtk_status_icon_update_image (status_icon);
721 if (message == WM_GTK_TRAY_NOTIFICATION)
723 ButtonCallbackData *bc;
741 if (HIWORD (wparam) == XBUTTON1)
747 bc = g_new (ButtonCallbackData, 1);
748 bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_PRESS);
749 bc->status_icon = GTK_STATUS_ICON (wparam);
750 build_button_event (bc->status_icon->priv, bc->event, button);
751 g_idle_add (button_callback, bc);
767 if (HIWORD (wparam) == XBUTTON1)
773 bc = g_new (ButtonCallbackData, 1);
774 bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_RELEASE);
775 bc->status_icon = GTK_STATUS_ICON (wparam);
776 build_button_event (bc->status_icon->priv, bc->event, button);
777 g_idle_add (button_callback, bc);
787 return DefWindowProc (hwnd, message, wparam, lparam);
792 create_tray_observer (void)
795 static HWND hwnd = NULL;
797 HINSTANCE hmodule = GetModuleHandle (NULL);
802 taskbar_created_msg = RegisterWindowMessage("TaskbarCreated");
804 memset (&wclass, 0, sizeof(WNDCLASS));
805 wclass.lpszClassName = "gtkstatusicon-observer";
806 wclass.lpfnWndProc = wndproc;
807 wclass.hInstance = hmodule;
809 klass = RegisterClass (&wclass);
813 hwnd = CreateWindow (MAKEINTRESOURCE (klass),
815 0, 0, 1, 1, NULL, NULL,
819 UnregisterClass (MAKEINTRESOURCE(klass), hmodule);
829 gtk_status_icon_init (GtkStatusIcon *status_icon)
831 GtkStatusIconPrivate *priv;
833 priv = G_TYPE_INSTANCE_GET_PRIVATE (status_icon, GTK_TYPE_STATUS_ICON,
834 GtkStatusIconPrivate);
835 status_icon->priv = priv;
837 priv->icon_helper = _gtk_icon_helper_new ();
838 priv->visible = TRUE;
840 #ifdef GDK_WINDOWING_X11
842 priv->tray_icon = GTK_WIDGET (_gtk_tray_icon_new (NULL));
844 gtk_widget_add_events (GTK_WIDGET (priv->tray_icon),
845 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
848 g_signal_connect_swapped (priv->tray_icon, "key-press-event",
849 G_CALLBACK (gtk_status_icon_key_press), status_icon);
850 g_signal_connect_swapped (priv->tray_icon, "popup-menu",
851 G_CALLBACK (gtk_status_icon_popup_menu), status_icon);
852 g_signal_connect_swapped (priv->tray_icon, "notify::embedded",
853 G_CALLBACK (gtk_status_icon_embedded_changed), status_icon);
854 g_signal_connect_swapped (priv->tray_icon, "notify::orientation",
855 G_CALLBACK (gtk_status_icon_orientation_changed), status_icon);
856 g_signal_connect_swapped (priv->tray_icon, "notify::padding",
857 G_CALLBACK (gtk_status_icon_padding_changed), status_icon);
858 g_signal_connect_swapped (priv->tray_icon, "notify::icon-size",
859 G_CALLBACK (gtk_status_icon_icon_size_changed), status_icon);
860 g_signal_connect_swapped (priv->tray_icon, "notify::fg-color",
861 G_CALLBACK (gtk_status_icon_fg_changed), status_icon);
862 g_signal_connect (priv->tray_icon, "notify::error-color",
863 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
864 g_signal_connect (priv->tray_icon, "notify::warning-color",
865 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
866 g_signal_connect (priv->tray_icon, "notify::success-color",
867 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
868 g_signal_connect_swapped (priv->tray_icon, "button-press-event",
869 G_CALLBACK (gtk_status_icon_button_press), status_icon);
870 g_signal_connect_swapped (priv->tray_icon, "button-release-event",
871 G_CALLBACK (gtk_status_icon_button_release), status_icon);
872 g_signal_connect_swapped (priv->tray_icon, "scroll-event",
873 G_CALLBACK (gtk_status_icon_scroll), status_icon);
874 g_signal_connect_swapped (priv->tray_icon, "query-tooltip",
875 G_CALLBACK (gtk_status_icon_query_tooltip), status_icon);
876 g_signal_connect_swapped (priv->tray_icon, "screen-changed",
877 G_CALLBACK (gtk_status_icon_screen_changed), status_icon);
878 priv->image = gtk_image_new ();
879 gtk_widget_set_can_focus (priv->image, TRUE);
880 gtk_container_add (GTK_CONTAINER (priv->tray_icon), priv->image);
881 gtk_widget_show (priv->image);
883 /* Force-initialize the symbolic colors */
884 g_object_notify (G_OBJECT (priv->tray_icon), "fg-color");
885 g_object_notify (G_OBJECT (priv->tray_icon), "error-color");
886 g_object_notify (G_OBJECT (priv->tray_icon), "warning-color");
887 g_object_notify (G_OBJECT (priv->tray_icon), "success-color");
889 g_signal_connect_swapped (priv->image, "size-allocate",
890 G_CALLBACK (gtk_status_icon_size_allocate), status_icon);
892 #else /* !GDK_WINDOWING_X11 */
893 priv->dummy_widget = gtk_label_new ("");
896 #ifdef GDK_WINDOWING_WIN32
898 /* Get position and orientation of Windows taskbar. */
902 abd.cbSize = sizeof (abd);
903 SHAppBarMessage (ABM_GETTASKBARPOS, &abd);
904 if (abd.rc.bottom - abd.rc.top > abd.rc.right - abd.rc.left)
905 priv->orientation = GTK_ORIENTATION_VERTICAL;
907 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
909 priv->taskbar_top = abd.rc.top;
912 priv->last_click_x = priv->last_click_y = 0;
914 /* Are the system tray icons always 16 pixels square? */
917 memset (&priv->nid, 0, sizeof (priv->nid));
919 priv->nid.hWnd = create_tray_observer ();
920 priv->nid.uID = GPOINTER_TO_UINT (status_icon);
921 priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
922 priv->nid.uFlags = NIF_MESSAGE;
924 /* To help win7 identify the icon create it with an application "unique" tip */
925 if (g_get_prgname ())
927 WCHAR *wcs = g_utf8_to_utf16 (g_get_prgname (), -1, NULL, NULL, NULL);
929 priv->nid.uFlags |= NIF_TIP;
930 wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
931 priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
935 if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
937 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
938 priv->nid.hWnd = NULL;
941 status_icons = g_slist_append (status_icons, status_icon);
945 #ifdef GDK_WINDOWING_QUARTZ
948 priv->status_item = [[GtkQuartzStatusIcon alloc] initWithStatusIcon:status_icon];
949 priv->size = [priv->status_item getHeight];
957 gtk_status_icon_constructor (GType type,
958 guint n_construct_properties,
959 GObjectConstructParam *construct_params)
962 #ifdef GDK_WINDOWING_X11
963 GtkStatusIcon *status_icon;
964 GtkStatusIconPrivate *priv;
967 object = G_OBJECT_CLASS (gtk_status_icon_parent_class)->constructor (type,
968 n_construct_properties,
971 #ifdef GDK_WINDOWING_X11
972 status_icon = GTK_STATUS_ICON (object);
973 priv = status_icon->priv;
976 gtk_widget_show (priv->tray_icon);
983 gtk_status_icon_finalize (GObject *object)
985 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
986 GtkStatusIconPrivate *priv = status_icon->priv;
988 gtk_status_icon_reset_image_data (status_icon);
989 g_clear_object (&priv->icon_helper);
991 #ifdef GDK_WINDOWING_X11
992 g_signal_handlers_disconnect_by_func (priv->tray_icon,
993 gtk_status_icon_key_press, status_icon);
994 g_signal_handlers_disconnect_by_func (priv->tray_icon,
995 gtk_status_icon_popup_menu, status_icon);
996 g_signal_handlers_disconnect_by_func (priv->tray_icon,
997 gtk_status_icon_embedded_changed, status_icon);
998 g_signal_handlers_disconnect_by_func (priv->tray_icon,
999 gtk_status_icon_orientation_changed, status_icon);
1000 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1001 gtk_status_icon_padding_changed, status_icon);
1002 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1003 gtk_status_icon_icon_size_changed, status_icon);
1004 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1005 gtk_status_icon_fg_changed, status_icon);
1006 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1007 gtk_status_icon_color_changed, status_icon);
1008 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1009 gtk_status_icon_button_press, status_icon);
1010 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1011 gtk_status_icon_button_release, status_icon);
1012 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1013 gtk_status_icon_scroll, status_icon);
1014 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1015 gtk_status_icon_query_tooltip, status_icon);
1016 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1017 gtk_status_icon_screen_changed, status_icon);
1018 gtk_widget_destroy (priv->image);
1019 gtk_widget_destroy (priv->tray_icon);
1020 #else /* !GDK_WINDOWING_X11 */
1021 gtk_widget_destroy (priv->dummy_widget);
1024 #ifdef GDK_WINDOWING_WIN32
1025 if (priv->nid.hWnd != NULL && priv->visible)
1026 Shell_NotifyIconW (NIM_DELETE, &priv->nid);
1027 if (priv->nid.hIcon)
1028 DestroyIcon (priv->nid.hIcon);
1029 g_free (priv->tooltip_text);
1031 status_icons = g_slist_remove (status_icons, status_icon);
1034 #ifdef GDK_WINDOWING_QUARTZ
1036 [priv->status_item release];
1037 QUARTZ_POOL_RELEASE;
1038 g_free (priv->tooltip_text);
1041 G_OBJECT_CLASS (gtk_status_icon_parent_class)->finalize (object);
1045 gtk_status_icon_set_property (GObject *object,
1047 const GValue *value,
1050 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1055 gtk_status_icon_set_from_pixbuf (status_icon, g_value_get_object (value));
1058 gtk_status_icon_set_from_file (status_icon, g_value_get_string (value));
1061 gtk_status_icon_set_from_stock (status_icon, g_value_get_string (value));
1063 case PROP_ICON_NAME:
1064 gtk_status_icon_set_from_icon_name (status_icon, g_value_get_string (value));
1067 gtk_status_icon_set_from_gicon (status_icon, g_value_get_object (value));
1070 gtk_status_icon_set_screen (status_icon, g_value_get_object (value));
1073 gtk_status_icon_set_visible (status_icon, g_value_get_boolean (value));
1075 case PROP_HAS_TOOLTIP:
1076 gtk_status_icon_set_has_tooltip (status_icon, g_value_get_boolean (value));
1078 case PROP_TOOLTIP_TEXT:
1079 gtk_status_icon_set_tooltip_text (status_icon, g_value_get_string (value));
1081 case PROP_TOOLTIP_MARKUP:
1082 gtk_status_icon_set_tooltip_markup (status_icon, g_value_get_string (value));
1085 gtk_status_icon_set_title (status_icon, g_value_get_string (value));
1088 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1094 gtk_status_icon_get_property (GObject *object,
1099 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1104 g_value_set_object (value, gtk_status_icon_get_pixbuf (status_icon));
1107 g_value_set_string (value, gtk_status_icon_get_stock (status_icon));
1109 case PROP_ICON_NAME:
1110 g_value_set_string (value, gtk_status_icon_get_icon_name (status_icon));
1113 g_value_set_object (value, gtk_status_icon_get_gicon (status_icon));
1115 case PROP_STORAGE_TYPE:
1116 g_value_set_enum (value, gtk_status_icon_get_storage_type (status_icon));
1119 g_value_set_int (value, gtk_status_icon_get_size (status_icon));
1122 g_value_set_object (value, gtk_status_icon_get_screen (status_icon));
1125 g_value_set_boolean (value, gtk_status_icon_get_visible (status_icon));
1128 g_value_set_boolean (value, gtk_status_icon_is_embedded (status_icon));
1130 case PROP_ORIENTATION:
1131 #ifdef GDK_WINDOWING_X11
1132 g_value_set_enum (value, _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (status_icon->priv->tray_icon)));
1134 #ifdef GDK_WINDOWING_WIN32
1135 g_value_set_enum (value, status_icon->priv->orientation);
1138 case PROP_HAS_TOOLTIP:
1139 g_value_set_boolean (value, gtk_status_icon_get_has_tooltip (status_icon));
1141 case PROP_TOOLTIP_TEXT:
1142 g_value_set_string (value, gtk_status_icon_get_tooltip_text (status_icon));
1144 case PROP_TOOLTIP_MARKUP:
1145 g_value_set_string (value, gtk_status_icon_get_tooltip_markup (status_icon));
1148 g_value_set_string (value, gtk_status_icon_get_title (status_icon));
1151 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1157 * gtk_status_icon_new:
1159 * Creates an empty status icon object.
1161 * Return value: a new #GtkStatusIcon
1166 gtk_status_icon_new (void)
1168 return g_object_new (GTK_TYPE_STATUS_ICON, NULL);
1172 * gtk_status_icon_new_from_pixbuf:
1173 * @pixbuf: a #GdkPixbuf
1175 * Creates a status icon displaying @pixbuf.
1177 * The image will be scaled down to fit in the available
1178 * space in the notification area, if necessary.
1180 * Return value: a new #GtkStatusIcon
1185 gtk_status_icon_new_from_pixbuf (GdkPixbuf *pixbuf)
1187 return g_object_new (GTK_TYPE_STATUS_ICON,
1193 * gtk_status_icon_new_from_file:
1194 * @filename: (type filename): a filename
1196 * Creates a status icon displaying the file @filename.
1198 * The image will be scaled down to fit in the available
1199 * space in the notification area, if necessary.
1201 * Return value: a new #GtkStatusIcon
1206 gtk_status_icon_new_from_file (const gchar *filename)
1208 return g_object_new (GTK_TYPE_STATUS_ICON,
1214 * gtk_status_icon_new_from_stock:
1215 * @stock_id: a stock icon id
1217 * Creates a status icon displaying a stock icon. Sample stock icon
1218 * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your
1219 * own stock icon names, see gtk_icon_factory_add_default() and
1220 * gtk_icon_factory_add().
1222 * Return value: a new #GtkStatusIcon
1227 gtk_status_icon_new_from_stock (const gchar *stock_id)
1229 return g_object_new (GTK_TYPE_STATUS_ICON,
1235 * gtk_status_icon_new_from_icon_name:
1236 * @icon_name: an icon name
1238 * Creates a status icon displaying an icon from the current icon theme.
1239 * If the current icon theme is changed, the icon will be updated
1242 * Return value: a new #GtkStatusIcon
1247 gtk_status_icon_new_from_icon_name (const gchar *icon_name)
1249 return g_object_new (GTK_TYPE_STATUS_ICON,
1250 "icon-name", icon_name,
1255 * gtk_status_icon_new_from_gicon:
1258 * Creates a status icon displaying a #GIcon. If the icon is a
1259 * themed icon, it will be updated when the theme changes.
1261 * Return value: a new #GtkStatusIcon
1266 gtk_status_icon_new_from_gicon (GIcon *icon)
1268 return g_object_new (GTK_TYPE_STATUS_ICON,
1274 emit_activate_signal (GtkStatusIcon *status_icon)
1276 g_signal_emit (status_icon,
1277 status_icon_signals [ACTIVATE_SIGNAL], 0);
1281 emit_popup_menu_signal (GtkStatusIcon *status_icon,
1283 guint32 activate_time)
1285 g_signal_emit (status_icon,
1286 status_icon_signals [POPUP_MENU_SIGNAL], 0,
1291 #ifdef GDK_WINDOWING_X11
1294 emit_size_changed_signal (GtkStatusIcon *status_icon,
1297 gboolean handled = FALSE;
1299 g_signal_emit (status_icon,
1300 status_icon_signals [SIZE_CHANGED_SIGNAL], 0,
1309 /* rounds the pixel size to the nearest size avaiable in the theme */
1311 round_pixel_size (GtkWidget *widget,
1315 GtkSettings *settings;
1317 gint w, h, d, dist, size;
1319 screen = gtk_widget_get_screen (widget);
1322 return GTK_ICON_SIZE_MENU;
1324 settings = gtk_settings_get_for_screen (screen);
1329 for (s = GTK_ICON_SIZE_MENU; s <= GTK_ICON_SIZE_DIALOG; s++)
1331 if (gtk_icon_size_lookup_for_settings (settings, s, &w, &h))
1333 d = MAX (abs (pixel_size - w), abs (pixel_size - h));
1346 gtk_status_icon_update_image (GtkStatusIcon *status_icon)
1348 GtkStatusIconPrivate *priv = status_icon->priv;
1349 #ifdef GDK_WINDOWING_WIN32
1352 GtkStyleContext *context;
1354 GtkImageType storage_type = _gtk_icon_helper_get_storage_type (priv->icon_helper);
1358 #ifdef GDK_WINDOWING_X11
1359 widget = priv->image;
1361 widget = priv->dummy_widget;
1364 context = gtk_widget_get_style_context (widget);
1365 round_size = round_pixel_size (widget, priv->size);
1367 if (storage_type == GTK_IMAGE_PIXBUF)
1373 pixbuf = _gtk_icon_helper_ensure_pixbuf (priv->icon_helper, context);
1375 width = gdk_pixbuf_get_width (pixbuf);
1376 height = gdk_pixbuf_get_height (pixbuf);
1378 if (width > round_size || height > round_size)
1380 scaled = gdk_pixbuf_scale_simple (pixbuf,
1381 MIN (round_size, width),
1382 MIN (round_size, height),
1383 GDK_INTERP_BILINEAR);
1384 g_object_unref (pixbuf);
1390 _gtk_icon_helper_set_pixel_size (priv->icon_helper, round_size);
1391 pixbuf = _gtk_icon_helper_ensure_pixbuf (priv->icon_helper, context);
1396 #ifdef GDK_WINDOWING_X11
1397 gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), pixbuf);
1399 #ifdef GDK_WINDOWING_WIN32
1400 prev_hicon = priv->nid.hIcon;
1401 priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (pixbuf);
1402 priv->nid.uFlags |= NIF_ICON;
1403 if (priv->nid.hWnd != NULL && priv->visible)
1404 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1405 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1407 DestroyIcon (prev_hicon);
1409 #ifdef GDK_WINDOWING_QUARTZ
1411 [priv->status_item setImage:pixbuf];
1412 QUARTZ_POOL_RELEASE;
1417 #ifdef GDK_WINDOWING_X11
1418 gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), NULL);
1420 #ifdef GDK_WINDOWING_WIN32
1421 priv->nid.uFlags &= ~NIF_ICON;
1422 if (priv->nid.hWnd != NULL && priv->visible)
1423 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1424 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1426 #ifdef GDK_WINDOWING_QUARTZ
1427 [priv->status_item setImage:NULL];
1431 g_clear_object (&pixbuf);
1434 #ifdef GDK_WINDOWING_X11
1437 gtk_status_icon_size_allocate (GtkStatusIcon *status_icon,
1438 GtkAllocation *allocation)
1440 GtkStatusIconPrivate *priv = status_icon->priv;
1441 GtkOrientation orientation;
1444 orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1446 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1447 size = allocation->height;
1449 size = allocation->width;
1451 if (priv->size != size)
1455 g_object_notify (G_OBJECT (status_icon), "size");
1457 if (!emit_size_changed_signal (status_icon, size))
1458 gtk_status_icon_update_image (status_icon);
1463 gtk_status_icon_screen_changed (GtkStatusIcon *status_icon,
1464 GdkScreen *old_screen)
1466 GtkStatusIconPrivate *priv = status_icon->priv;
1468 if (gtk_widget_get_screen (priv->tray_icon) != old_screen)
1470 g_object_notify (G_OBJECT (status_icon), "screen");
1476 #ifdef GDK_WINDOWING_X11
1479 gtk_status_icon_padding_changed (GtkStatusIcon *status_icon)
1481 GtkStatusIconPrivate *priv = status_icon->priv;
1482 GtkOrientation orientation;
1485 orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1486 padding = _gtk_tray_icon_get_padding (GTK_TRAY_ICON (priv->tray_icon));
1488 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1490 gtk_widget_set_margin_left (priv->image, padding);
1491 gtk_widget_set_margin_right (priv->image, padding);
1495 gtk_widget_set_margin_bottom (priv->image, padding);
1496 gtk_widget_set_margin_top (priv->image, padding);
1501 gtk_status_icon_icon_size_changed (GtkStatusIcon *status_icon)
1503 GtkStatusIconPrivate *priv = status_icon->priv;
1506 icon_size = _gtk_tray_icon_get_icon_size (GTK_TRAY_ICON (priv->tray_icon));
1509 gtk_image_set_pixel_size (GTK_IMAGE (priv->image), icon_size);
1511 gtk_image_set_pixel_size (GTK_IMAGE (priv->image), -1);
1515 gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon)
1517 gtk_status_icon_padding_changed (status_icon);
1518 gtk_status_icon_icon_size_changed (status_icon);
1519 g_object_notify (G_OBJECT (status_icon), "embedded");
1523 gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon)
1525 gtk_status_icon_padding_changed (status_icon);
1526 g_object_notify (G_OBJECT (status_icon), "orientation");
1530 gtk_status_icon_fg_changed (GtkStatusIcon *status_icon)
1532 GtkStatusIconPrivate *priv = status_icon->priv;
1535 g_object_get (priv->tray_icon, "fg-color", &rgba, NULL);
1537 gtk_widget_override_color (priv->image, GTK_STATE_FLAG_NORMAL, rgba);
1539 gdk_rgba_free (rgba);
1543 gtk_status_icon_color_changed (GtkTrayIcon *tray,
1545 GtkStatusIcon *status_icon)
1547 GtkStatusIconPrivate *priv = status_icon->priv;
1550 switch (pspec->name[0])
1570 g_object_get (priv->tray_icon, pspec->name, &rgba, NULL);
1574 gtk_widget_override_symbolic_color (priv->image, name, &rgba);
1579 gtk_status_icon_key_press (GtkStatusIcon *status_icon,
1582 guint state, keyval;
1584 state = event->state & gtk_accelerator_get_default_mod_mask ();
1585 keyval = event->keyval;
1587 (keyval == GDK_KEY_Return ||
1588 keyval == GDK_KEY_KP_Enter ||
1589 keyval == GDK_KEY_ISO_Enter ||
1590 keyval == GDK_KEY_space ||
1591 keyval == GDK_KEY_KP_Space))
1593 emit_activate_signal (status_icon);
1601 gtk_status_icon_popup_menu (GtkStatusIcon *status_icon)
1603 emit_popup_menu_signal (status_icon, 0, gtk_get_current_event_time ());
1609 gtk_status_icon_button_press (GtkStatusIcon *status_icon,
1610 GdkEventButton *event)
1612 gboolean handled = FALSE;
1614 g_signal_emit (status_icon,
1615 status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL], 0,
1620 if (gdk_event_triggers_context_menu ((GdkEvent *) event))
1622 emit_popup_menu_signal (status_icon, event->button, event->time);
1625 else if (event->button == GDK_BUTTON_PRIMARY && event->type == GDK_BUTTON_PRESS)
1627 emit_activate_signal (status_icon);
1635 gtk_status_icon_button_release (GtkStatusIcon *status_icon,
1636 GdkEventButton *event)
1638 gboolean handled = FALSE;
1639 g_signal_emit (status_icon,
1640 status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL], 0,
1645 #ifdef GDK_WINDOWING_X11
1647 gtk_status_icon_scroll (GtkStatusIcon *status_icon,
1648 GdkEventScroll *event)
1650 gboolean handled = FALSE;
1651 g_signal_emit (status_icon,
1652 status_icon_signals [SCROLL_EVENT_SIGNAL], 0,
1658 gtk_status_icon_query_tooltip (GtkStatusIcon *status_icon,
1661 gboolean keyboard_tip,
1662 GtkTooltip *tooltip)
1664 gboolean handled = FALSE;
1665 g_signal_emit (status_icon,
1666 status_icon_signals [QUERY_TOOLTIP_SIGNAL], 0,
1667 x, y, keyboard_tip, tooltip, &handled);
1670 #endif /* GDK_WINDOWING_X11 */
1673 gtk_status_icon_reset_image_data (GtkStatusIcon *status_icon)
1675 GtkStatusIconPrivate *priv = status_icon->priv;
1676 GtkImageType storage_type = _gtk_icon_helper_get_storage_type (priv->icon_helper);
1678 switch (storage_type)
1680 case GTK_IMAGE_PIXBUF:
1681 g_object_notify (G_OBJECT (status_icon), "pixbuf");
1683 case GTK_IMAGE_STOCK:
1684 g_object_notify (G_OBJECT (status_icon), "stock");
1686 case GTK_IMAGE_ICON_NAME:
1687 g_object_notify (G_OBJECT (status_icon), "icon-name");
1689 case GTK_IMAGE_GICON:
1690 g_object_notify (G_OBJECT (status_icon), "gicon");
1692 case GTK_IMAGE_EMPTY:
1695 g_assert_not_reached ();
1699 _gtk_icon_helper_clear (priv->icon_helper);
1700 g_object_notify (G_OBJECT (status_icon), "storage-type");
1704 gtk_status_icon_set_image (GtkStatusIcon *status_icon,
1705 GtkImageType storage_type,
1708 GtkStatusIconPrivate *priv = status_icon->priv;
1710 g_object_freeze_notify (G_OBJECT (status_icon));
1712 gtk_status_icon_reset_image_data (status_icon);
1714 g_object_notify (G_OBJECT (status_icon), "storage-type");
1716 /* the icon size we pass here doesn't really matter, since
1717 * we force a pixel size before doing the actual rendering anyway.
1719 switch (storage_type)
1721 case GTK_IMAGE_PIXBUF:
1722 _gtk_icon_helper_set_pixbuf (priv->icon_helper, data);
1723 g_object_notify (G_OBJECT (status_icon), "pixbuf");
1725 case GTK_IMAGE_STOCK:
1726 _gtk_icon_helper_set_stock_id (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1727 g_object_notify (G_OBJECT (status_icon), "stock");
1729 case GTK_IMAGE_ICON_NAME:
1730 _gtk_icon_helper_set_icon_name (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1731 g_object_notify (G_OBJECT (status_icon), "icon-name");
1733 case GTK_IMAGE_GICON:
1734 _gtk_icon_helper_set_gicon (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1735 g_object_notify (G_OBJECT (status_icon), "gicon");
1738 g_warning ("Image type %u not handled by GtkStatusIcon", storage_type);
1741 g_object_thaw_notify (G_OBJECT (status_icon));
1743 gtk_status_icon_update_image (status_icon);
1747 * gtk_status_icon_set_from_pixbuf:
1748 * @status_icon: a #GtkStatusIcon
1749 * @pixbuf: (allow-none): a #GdkPixbuf or %NULL
1751 * Makes @status_icon display @pixbuf.
1752 * See gtk_status_icon_new_from_pixbuf() for details.
1757 gtk_status_icon_set_from_pixbuf (GtkStatusIcon *status_icon,
1760 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1761 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
1763 gtk_status_icon_set_image (status_icon, GTK_IMAGE_PIXBUF,
1768 * gtk_status_icon_set_from_file:
1769 * @status_icon: a #GtkStatusIcon
1770 * @filename: (type filename): a filename
1772 * Makes @status_icon display the file @filename.
1773 * See gtk_status_icon_new_from_file() for details.
1778 gtk_status_icon_set_from_file (GtkStatusIcon *status_icon,
1779 const gchar *filename)
1783 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1784 g_return_if_fail (filename != NULL);
1786 pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
1788 gtk_status_icon_set_from_pixbuf (status_icon, pixbuf);
1791 g_object_unref (pixbuf);
1795 * gtk_status_icon_set_from_stock:
1796 * @status_icon: a #GtkStatusIcon
1797 * @stock_id: a stock icon id
1799 * Makes @status_icon display the stock icon with the id @stock_id.
1800 * See gtk_status_icon_new_from_stock() for details.
1805 gtk_status_icon_set_from_stock (GtkStatusIcon *status_icon,
1806 const gchar *stock_id)
1808 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1809 g_return_if_fail (stock_id != NULL);
1811 gtk_status_icon_set_image (status_icon, GTK_IMAGE_STOCK,
1812 (gpointer) stock_id);
1816 * gtk_status_icon_set_from_icon_name:
1817 * @status_icon: a #GtkStatusIcon
1818 * @icon_name: an icon name
1820 * Makes @status_icon display the icon named @icon_name from the
1821 * current icon theme.
1822 * See gtk_status_icon_new_from_icon_name() for details.
1827 gtk_status_icon_set_from_icon_name (GtkStatusIcon *status_icon,
1828 const gchar *icon_name)
1830 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1831 g_return_if_fail (icon_name != NULL);
1833 gtk_status_icon_set_image (status_icon, GTK_IMAGE_ICON_NAME,
1834 (gpointer) icon_name);
1838 * gtk_status_icon_set_from_gicon:
1839 * @status_icon: a #GtkStatusIcon
1842 * Makes @status_icon display the #GIcon.
1843 * See gtk_status_icon_new_from_gicon() for details.
1848 gtk_status_icon_set_from_gicon (GtkStatusIcon *status_icon,
1851 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1852 g_return_if_fail (icon != NULL);
1854 gtk_status_icon_set_image (status_icon, GTK_IMAGE_GICON,
1859 * gtk_status_icon_get_storage_type:
1860 * @status_icon: a #GtkStatusIcon
1862 * Gets the type of representation being used by the #GtkStatusIcon
1863 * to store image data. If the #GtkStatusIcon has no image data,
1864 * the return value will be %GTK_IMAGE_EMPTY.
1866 * Return value: the image representation being used
1871 gtk_status_icon_get_storage_type (GtkStatusIcon *status_icon)
1873 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), GTK_IMAGE_EMPTY);
1875 return _gtk_icon_helper_get_storage_type (status_icon->priv->icon_helper);
1878 * gtk_status_icon_get_pixbuf:
1879 * @status_icon: a #GtkStatusIcon
1881 * Gets the #GdkPixbuf being displayed by the #GtkStatusIcon.
1882 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1883 * %GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()).
1884 * The caller of this function does not own a reference to the
1887 * Return value: (transfer none): the displayed pixbuf,
1888 * or %NULL if the image is empty.
1893 gtk_status_icon_get_pixbuf (GtkStatusIcon *status_icon)
1895 GtkStatusIconPrivate *priv;
1897 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1899 priv = status_icon->priv;
1901 return _gtk_icon_helper_peek_pixbuf (priv->icon_helper);
1905 * gtk_status_icon_get_stock:
1906 * @status_icon: a #GtkStatusIcon
1908 * Gets the id of the stock icon being displayed by the #GtkStatusIcon.
1909 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1910 * %GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()).
1911 * The returned string is owned by the #GtkStatusIcon and should not
1912 * be freed or modified.
1914 * Return value: stock id of the displayed stock icon,
1915 * or %NULL if the image is empty.
1920 gtk_status_icon_get_stock (GtkStatusIcon *status_icon)
1922 GtkStatusIconPrivate *priv;
1924 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1926 priv = status_icon->priv;
1928 return _gtk_icon_helper_get_stock_id (priv->icon_helper);
1932 * gtk_status_icon_get_icon_name:
1933 * @status_icon: a #GtkStatusIcon
1935 * Gets the name of the icon being displayed by the #GtkStatusIcon.
1936 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1937 * %GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()).
1938 * The returned string is owned by the #GtkStatusIcon and should not
1939 * be freed or modified.
1941 * Return value: name of the displayed icon, or %NULL if the image is empty.
1946 gtk_status_icon_get_icon_name (GtkStatusIcon *status_icon)
1948 GtkStatusIconPrivate *priv;
1950 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1952 priv = status_icon->priv;
1954 return _gtk_icon_helper_get_icon_name (priv->icon_helper);
1958 * gtk_status_icon_get_gicon:
1959 * @status_icon: a #GtkStatusIcon
1961 * Retrieves the #GIcon being displayed by the #GtkStatusIcon.
1962 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1963 * %GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()).
1964 * The caller of this function does not own a reference to the
1967 * If this function fails, @icon is left unchanged;
1969 * Returns: (transfer none): the displayed icon, or %NULL if the image is empty
1974 gtk_status_icon_get_gicon (GtkStatusIcon *status_icon)
1976 GtkStatusIconPrivate *priv;
1978 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1980 priv = status_icon->priv;
1982 return _gtk_icon_helper_peek_gicon (priv->icon_helper);
1986 * gtk_status_icon_get_size:
1987 * @status_icon: a #GtkStatusIcon
1989 * Gets the size in pixels that is available for the image.
1990 * Stock icons and named icons adapt their size automatically
1991 * if the size of the notification area changes. For other
1992 * storage types, the size-changed signal can be used to
1993 * react to size changes.
1995 * Note that the returned size is only meaningful while the
1996 * status icon is embedded (see gtk_status_icon_is_embedded()).
1998 * Return value: the size that is available for the image
2003 gtk_status_icon_get_size (GtkStatusIcon *status_icon)
2005 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), 0);
2007 return status_icon->priv->size;
2011 * gtk_status_icon_set_screen:
2012 * @status_icon: a #GtkStatusIcon
2013 * @screen: a #GdkScreen
2015 * Sets the #GdkScreen where @status_icon is displayed; if
2016 * the icon is already mapped, it will be unmapped, and
2017 * then remapped on the new screen.
2022 gtk_status_icon_set_screen (GtkStatusIcon *status_icon,
2025 g_return_if_fail (GDK_IS_SCREEN (screen));
2027 #ifdef GDK_WINDOWING_X11
2028 gtk_window_set_screen (GTK_WINDOW (status_icon->priv->tray_icon), screen);
2033 * gtk_status_icon_get_screen:
2034 * @status_icon: a #GtkStatusIcon
2036 * Returns the #GdkScreen associated with @status_icon.
2038 * Return value: (transfer none): a #GdkScreen.
2043 gtk_status_icon_get_screen (GtkStatusIcon *status_icon)
2045 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2047 #ifdef GDK_WINDOWING_X11
2048 return gtk_window_get_screen (GTK_WINDOW (status_icon->priv->tray_icon));
2050 return gdk_screen_get_default ();
2055 * gtk_status_icon_set_visible:
2056 * @status_icon: a #GtkStatusIcon
2057 * @visible: %TRUE to show the status icon, %FALSE to hide it
2059 * Shows or hides a status icon.
2064 gtk_status_icon_set_visible (GtkStatusIcon *status_icon,
2067 GtkStatusIconPrivate *priv;
2069 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2071 priv = status_icon->priv;
2073 visible = visible != FALSE;
2075 if (priv->visible != visible)
2077 priv->visible = visible;
2079 #ifdef GDK_WINDOWING_X11
2081 gtk_widget_show (priv->tray_icon);
2082 else if (gtk_widget_get_realized (priv->tray_icon))
2084 gtk_widget_hide (priv->tray_icon);
2085 gtk_widget_unrealize (priv->tray_icon);
2088 #ifdef GDK_WINDOWING_WIN32
2089 if (priv->nid.hWnd != NULL)
2092 Shell_NotifyIconW (NIM_ADD, &priv->nid);
2094 Shell_NotifyIconW (NIM_DELETE, &priv->nid);
2097 #ifdef GDK_WINDOWING_QUARTZ
2099 [priv->status_item setVisible:visible];
2100 QUARTZ_POOL_RELEASE;
2102 g_object_notify (G_OBJECT (status_icon), "visible");
2107 * gtk_status_icon_get_visible:
2108 * @status_icon: a #GtkStatusIcon
2110 * Returns whether the status icon is visible or not.
2111 * Note that being visible does not guarantee that
2112 * the user can actually see the icon, see also
2113 * gtk_status_icon_is_embedded().
2115 * Return value: %TRUE if the status icon is visible
2120 gtk_status_icon_get_visible (GtkStatusIcon *status_icon)
2122 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2124 return status_icon->priv->visible;
2128 * gtk_status_icon_is_embedded:
2129 * @status_icon: a #GtkStatusIcon
2131 * Returns whether the status icon is embedded in a notification
2134 * Return value: %TRUE if the status icon is embedded in
2135 * a notification area.
2140 gtk_status_icon_is_embedded (GtkStatusIcon *status_icon)
2142 #ifdef GDK_WINDOWING_X11
2146 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2148 #ifdef GDK_WINDOWING_X11
2149 plug = GTK_PLUG (status_icon->priv->tray_icon);
2151 if (gtk_plug_get_embedded (plug))
2156 #ifdef GDK_WINDOWING_WIN32
2159 #ifdef GDK_WINDOWING_QUARTZ
2165 * gtk_status_icon_position_menu:
2166 * @menu: the #GtkMenu
2167 * @x: (out): return location for the x position
2168 * @y: (out): return location for the y position
2169 * @push_in: (out): whether the first menu item should be offset
2170 * (pushed in) to be aligned with the menu popup position
2171 * (only useful for GtkOptionMenu).
2172 * @user_data: (type GtkStatusIcon): the status icon to position the menu on
2174 * Menu positioning function to use with gtk_menu_popup()
2175 * to position @menu aligned to the status icon @user_data.
2180 gtk_status_icon_position_menu (GtkMenu *menu,
2186 #ifdef GDK_WINDOWING_X11
2187 GtkAllocation allocation;
2188 GtkStatusIcon *status_icon;
2189 GtkStatusIconPrivate *priv;
2190 GtkTrayIcon *tray_icon;
2193 GtkTextDirection direction;
2194 GtkRequisition menu_req;
2195 GdkRectangle monitor;
2197 gint monitor_num, height, width, xoffset, yoffset;
2199 g_return_if_fail (GTK_IS_MENU (menu));
2200 g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2202 status_icon = GTK_STATUS_ICON (user_data);
2203 priv = status_icon->priv;
2204 tray_icon = GTK_TRAY_ICON (priv->tray_icon);
2205 widget = priv->tray_icon;
2207 direction = gtk_widget_get_direction (widget);
2209 screen = gtk_widget_get_screen (widget);
2210 gtk_menu_set_screen (menu, screen);
2212 window = gtk_widget_get_window (widget);
2213 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
2214 if (monitor_num < 0)
2216 gtk_menu_set_monitor (menu, monitor_num);
2218 gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
2220 gdk_window_get_origin (window, x, y);
2222 menu_req.width = gtk_widget_get_allocated_width (GTK_WIDGET (menu));
2223 menu_req.height = gtk_widget_get_allocated_height (GTK_WIDGET (menu));
2225 gtk_widget_get_allocation (widget, &allocation);
2226 if (_gtk_tray_icon_get_orientation (tray_icon) == GTK_ORIENTATION_VERTICAL)
2229 height = allocation.height;
2230 xoffset = allocation.width;
2235 width = allocation.width;
2238 yoffset = allocation.height;
2241 if (direction == GTK_TEXT_DIR_RTL)
2243 if ((*x - (menu_req.width - width)) >= monitor.x)
2244 *x -= menu_req.width - width;
2245 else if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2247 else if ((monitor.x + monitor.width - (*x + xoffset)) < *x)
2248 *x -= menu_req.width - width;
2254 if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2256 else if ((*x - (menu_req.width - width)) >= monitor.x)
2257 *x -= menu_req.width - width;
2258 else if ((monitor.x + monitor.width - (*x + xoffset)) > *x)
2261 *x -= menu_req.width - width;
2264 if ((*y + yoffset + menu_req.height) < (monitor.y + monitor.height))
2266 else if ((*y - (menu_req.height - height)) >= monitor.y)
2267 *y -= menu_req.height - height;
2268 else if (monitor.y + monitor.height - (*y + yoffset) > *y)
2271 *y -= menu_req.height - height;
2274 #endif /* GDK_WINDOWING_X11 */
2276 #ifdef GDK_WINDOWING_WIN32
2277 GtkStatusIcon *status_icon;
2278 GtkStatusIconPrivate *priv;
2279 GtkRequisition menu_req;
2281 g_return_if_fail (GTK_IS_MENU (menu));
2282 g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2284 status_icon = GTK_STATUS_ICON (user_data);
2285 priv = status_icon->priv;
2287 gtk_widget_size_request (GTK_WIDGET (menu), &menu_req);
2289 *x = priv->last_click_x;
2290 *y = priv->taskbar_top - menu_req.height;
2297 * gtk_status_icon_get_geometry:
2298 * @status_icon: a #GtkStatusIcon
2299 * @screen: (out) (transfer none) (allow-none): return location for
2300 * the screen, or %NULL if the information is not needed
2301 * @area: (out) (allow-none): return location for the area occupied by
2302 * the status icon, or %NULL
2303 * @orientation: (out) (allow-none): return location for the
2304 * orientation of the panel in which the status icon is embedded,
2305 * or %NULL. A panel at the top or bottom of the screen is
2306 * horizontal, a panel at the left or right is vertical.
2308 * Obtains information about the location of the status icon
2309 * on screen. This information can be used to e.g. position
2310 * popups like notification bubbles.
2312 * See gtk_status_icon_position_menu() for a more convenient
2313 * alternative for positioning menus.
2315 * Note that some platforms do not allow GTK+ to provide
2316 * this information, and even on platforms that do allow it,
2317 * the information is not reliable unless the status icon
2318 * is embedded in a notification area, see
2319 * gtk_status_icon_is_embedded().
2321 * Return value: %TRUE if the location information has
2327 gtk_status_icon_get_geometry (GtkStatusIcon *status_icon,
2330 GtkOrientation *orientation)
2332 #ifdef GDK_WINDOWING_X11
2333 GtkAllocation allocation;
2335 GtkStatusIconPrivate *priv;
2338 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2340 priv = status_icon->priv;
2341 widget = priv->tray_icon;
2344 *screen = gtk_widget_get_screen (widget);
2348 gdk_window_get_origin (gtk_widget_get_window (widget),
2351 gtk_widget_get_allocation (widget, &allocation);
2354 area->width = allocation.width;
2355 area->height = allocation.height;
2359 *orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (widget));
2364 #endif /* GDK_WINDOWING_X11 */
2368 * gtk_status_icon_set_has_tooltip:
2369 * @status_icon: a #GtkStatusIcon
2370 * @has_tooltip: whether or not @status_icon has a tooltip
2372 * Sets the has-tooltip property on @status_icon to @has_tooltip.
2373 * See #GtkStatusIcon:has-tooltip for more information.
2378 gtk_status_icon_set_has_tooltip (GtkStatusIcon *status_icon,
2379 gboolean has_tooltip)
2381 GtkStatusIconPrivate *priv;
2383 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2385 priv = status_icon->priv;
2387 #ifdef GDK_WINDOWING_X11
2388 gtk_widget_set_has_tooltip (priv->tray_icon, has_tooltip);
2390 #ifdef GDK_WINDOWING_WIN32
2391 if (!has_tooltip && priv->tooltip_text)
2392 gtk_status_icon_set_tooltip_text (status_icon, NULL);
2394 #ifdef GDK_WINDOWING_QUARTZ
2395 if (!has_tooltip && priv->tooltip_text)
2396 gtk_status_icon_set_tooltip_text (status_icon, NULL);
2401 * gtk_status_icon_get_has_tooltip:
2402 * @status_icon: a #GtkStatusIcon
2404 * Returns the current value of the has-tooltip property.
2405 * See #GtkStatusIcon:has-tooltip for more information.
2407 * Return value: current value of has-tooltip on @status_icon.
2412 gtk_status_icon_get_has_tooltip (GtkStatusIcon *status_icon)
2414 GtkStatusIconPrivate *priv;
2415 gboolean has_tooltip = FALSE;
2417 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2419 priv = status_icon->priv;
2421 #ifdef GDK_WINDOWING_X11
2422 has_tooltip = gtk_widget_get_has_tooltip (priv->tray_icon);
2424 #ifdef GDK_WINDOWING_WIN32
2425 has_tooltip = (priv->tooltip_text != NULL);
2427 #ifdef GDK_WINDOWING_QUARTZ
2428 has_tooltip = (priv->tooltip_text != NULL);
2435 * gtk_status_icon_set_tooltip_text:
2436 * @status_icon: a #GtkStatusIcon
2437 * @text: the contents of the tooltip for @status_icon
2439 * Sets @text as the contents of the tooltip.
2441 * This function will take care of setting #GtkStatusIcon:has-tooltip to
2442 * %TRUE and of the default handler for the #GtkStatusIcon::query-tooltip
2445 * See also the #GtkStatusIcon:tooltip-text property and
2446 * gtk_tooltip_set_text().
2451 gtk_status_icon_set_tooltip_text (GtkStatusIcon *status_icon,
2454 GtkStatusIconPrivate *priv;
2456 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2458 priv = status_icon->priv;
2460 #ifdef GDK_WINDOWING_X11
2462 gtk_widget_set_tooltip_text (priv->tray_icon, text);
2465 #ifdef GDK_WINDOWING_WIN32
2467 priv->nid.uFlags &= ~NIF_TIP;
2470 WCHAR *wcs = g_utf8_to_utf16 (text, -1, NULL, NULL, NULL);
2472 priv->nid.uFlags |= NIF_TIP;
2473 wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
2474 priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
2477 if (priv->nid.hWnd != NULL && priv->visible)
2478 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
2479 g_warning (G_STRLOC ": Shell_NotifyIconW(NIM_MODIFY) failed");
2481 g_free (priv->tooltip_text);
2482 priv->tooltip_text = g_strdup (text);
2484 #ifdef GDK_WINDOWING_QUARTZ
2486 [priv->status_item setToolTip:text];
2487 QUARTZ_POOL_RELEASE;
2489 g_free (priv->tooltip_text);
2490 priv->tooltip_text = g_strdup (text);
2495 * gtk_status_icon_get_tooltip_text:
2496 * @status_icon: a #GtkStatusIcon
2498 * Gets the contents of the tooltip for @status_icon.
2500 * Return value: the tooltip text, or %NULL. You should free the
2501 * returned string with g_free() when done.
2506 gtk_status_icon_get_tooltip_text (GtkStatusIcon *status_icon)
2508 GtkStatusIconPrivate *priv;
2509 gchar *tooltip_text = NULL;
2511 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2513 priv = status_icon->priv;
2515 #ifdef GDK_WINDOWING_X11
2516 tooltip_text = gtk_widget_get_tooltip_text (priv->tray_icon);
2518 #ifdef GDK_WINDOWING_WIN32
2519 if (priv->tooltip_text)
2520 tooltip_text = g_strdup (priv->tooltip_text);
2522 #ifdef GDK_WINDOWING_QUARTZ
2523 if (priv->tooltip_text)
2524 tooltip_text = g_strdup (priv->tooltip_text);
2527 return tooltip_text;
2531 * gtk_status_icon_set_tooltip_markup:
2532 * @status_icon: a #GtkStatusIcon
2533 * @markup: (allow-none): the contents of the tooltip for @status_icon, or %NULL
2535 * Sets @markup as the contents of the tooltip, which is marked up with
2536 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
2538 * This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
2539 * and of the default handler for the #GtkStatusIcon::query-tooltip signal.
2541 * See also the #GtkStatusIcon:tooltip-markup property and
2542 * gtk_tooltip_set_markup().
2547 gtk_status_icon_set_tooltip_markup (GtkStatusIcon *status_icon,
2548 const gchar *markup)
2550 GtkStatusIconPrivate *priv;
2551 #ifndef GDK_WINDOWING_X11
2555 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2557 priv = status_icon->priv;
2559 #ifdef GDK_WINDOWING_X11
2560 gtk_widget_set_tooltip_markup (priv->tray_icon, markup);
2562 #ifdef GDK_WINDOWING_WIN32
2564 pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2565 gtk_status_icon_set_tooltip_text (status_icon, text);
2568 #ifdef GDK_WINDOWING_QUARTZ
2570 pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2571 gtk_status_icon_set_tooltip_text (status_icon, text);
2577 * gtk_status_icon_get_tooltip_markup:
2578 * @status_icon: a #GtkStatusIcon
2580 * Gets the contents of the tooltip for @status_icon.
2582 * Return value: the tooltip text, or %NULL. You should free the
2583 * returned string with g_free() when done.
2588 gtk_status_icon_get_tooltip_markup (GtkStatusIcon *status_icon)
2590 GtkStatusIconPrivate *priv;
2591 gchar *markup = NULL;
2593 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2595 priv = status_icon->priv;
2597 #ifdef GDK_WINDOWING_X11
2598 markup = gtk_widget_get_tooltip_markup (priv->tray_icon);
2600 #ifdef GDK_WINDOWING_WIN32
2601 if (priv->tooltip_text)
2602 markup = g_markup_escape_text (priv->tooltip_text, -1);
2604 #ifdef GDK_WINDOWING_QUARTZ
2605 if (priv->tooltip_text)
2606 markup = g_markup_escape_text (priv->tooltip_text, -1);
2613 * gtk_status_icon_get_x11_window_id:
2614 * @status_icon: a #GtkStatusIcon
2616 * This function is only useful on the X11/freedesktop.org platform.
2617 * It returns a window ID for the widget in the underlying
2618 * status icon implementation. This is useful for the Galago
2619 * notification service, which can send a window ID in the protocol
2620 * in order for the server to position notification windows
2621 * pointing to a status icon reliably.
2623 * This function is not intended for other use cases which are
2624 * more likely to be met by one of the non-X11 specific methods, such
2625 * as gtk_status_icon_position_menu().
2627 * Return value: An 32 bit unsigned integer identifier for the
2628 * underlying X11 Window
2633 gtk_status_icon_get_x11_window_id (GtkStatusIcon *status_icon)
2635 #ifdef GDK_WINDOWING_X11
2636 gtk_widget_realize (GTK_WIDGET (status_icon->priv->tray_icon));
2637 return GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (status_icon->priv->tray_icon)));
2644 * gtk_status_icon_set_title:
2645 * @status_icon: a #GtkStatusIcon
2648 * Sets the title of this tray icon.
2649 * This should be a short, human-readable, localized string
2650 * describing the tray icon. It may be used by tools like screen
2651 * readers to render the tray icon.
2656 gtk_status_icon_set_title (GtkStatusIcon *status_icon,
2659 GtkStatusIconPrivate *priv;
2661 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2663 priv = status_icon->priv;
2665 #ifdef GDK_WINDOWING_X11
2666 gtk_window_set_title (GTK_WINDOW (priv->tray_icon), title);
2668 #ifdef GDK_WINDOWING_QUARTZ
2669 g_free (priv->title);
2670 priv->title = g_strdup (title);
2672 #ifdef GDK_WINDOWING_WIN32
2673 g_free (priv->title);
2674 priv->title = g_strdup (title);
2677 g_object_notify (G_OBJECT (status_icon), "title");
2681 * gtk_status_icon_get_title:
2682 * @status_icon: a #GtkStatusIcon
2684 * Gets the title of this tray icon. See gtk_status_icon_set_title().
2686 * Returns: the title of the status icon
2691 gtk_status_icon_get_title (GtkStatusIcon *status_icon)
2693 GtkStatusIconPrivate *priv;
2695 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2697 priv = status_icon->priv;
2699 #ifdef GDK_WINDOWING_X11
2700 return gtk_window_get_title (GTK_WINDOW (priv->tray_icon));
2702 #ifdef GDK_WINDOWING_QUARTZ
2705 #ifdef GDK_WINDOWING_WIN32
2712 * gtk_status_icon_set_name:
2713 * @status_icon: a #GtkStatusIcon
2716 * Sets the name of this tray icon.
2717 * This should be a string identifying this icon. It is may be
2718 * used for sorting the icons in the tray and will not be shown to
2724 gtk_status_icon_set_name (GtkStatusIcon *status_icon,
2727 GtkStatusIconPrivate *priv;
2729 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2731 priv = status_icon->priv;
2733 #ifdef GDK_WINDOWING_X11
2734 if (gtk_widget_get_realized (priv->tray_icon))
2736 /* gtk_window_set_wmclass() only operates on non-realized windows,
2737 * so temporarily unrealize the tray here
2739 gtk_widget_hide (priv->tray_icon);
2740 gtk_widget_unrealize (priv->tray_icon);
2741 gtk_window_set_wmclass (GTK_WINDOW (priv->tray_icon), name, name);
2742 gtk_widget_show (priv->tray_icon);
2745 gtk_window_set_wmclass (GTK_WINDOW (priv->tray_icon), name, name);