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, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 * Mark McLoughlin <mark@skynet.ie>
25 * Hans Breuer <hans@breuer.org>
26 * Tor Lillqvist <tml@novell.com>
27 * Mikael Hallendal <micke@imendio.com>
34 #include "gtkstatusicon.h"
37 #include "gtkiconfactory.h"
39 #include "gtkmarshalers.h"
40 #include "gtksizerequest.h"
41 #include "gtkprivate.h"
42 #include "gtkwidget.h"
43 #include "gtktooltip.h"
44 #include "gtkicontheme.h"
46 #include "gtktypebuiltins.h"
48 #ifdef GDK_WINDOWING_X11
49 #include "gdk/x11/gdkx.h"
50 #include "gtktrayicon.h"
53 #ifdef GDK_WINDOWING_WIN32
54 #include "gdk/win32/gdkwin32.h"
55 #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1)
58 #define BLINK_TIMEOUT 500
86 BUTTON_PRESS_EVENT_SIGNAL,
87 BUTTON_RELEASE_EVENT_SIGNAL,
93 static guint status_icon_signals [LAST_SIGNAL] = { 0 };
95 #ifdef GDK_WINDOWING_QUARTZ
96 #include "gtkstatusicon-quartz.c"
99 struct _GtkStatusIconPrivate
101 #ifdef GDK_WINDOWING_X11
102 GtkWidget *tray_icon;
106 #ifdef GDK_WINDOWING_WIN32
107 GtkWidget *dummy_widget;
109 gint last_click_x, last_click_y;
110 GtkOrientation orientation;
115 #ifdef GDK_WINDOWING_QUARTZ
116 GtkWidget *dummy_widget;
117 GtkQuartzStatusIcon *status_item;
127 GtkImageType storage_type;
140 static GObject* gtk_status_icon_constructor (GType type,
141 guint n_construct_properties,
142 GObjectConstructParam *construct_params);
143 static void gtk_status_icon_finalize (GObject *object);
144 static void gtk_status_icon_set_property (GObject *object,
148 static void gtk_status_icon_get_property (GObject *object,
153 #ifdef GDK_WINDOWING_X11
154 static void gtk_status_icon_size_allocate (GtkStatusIcon *status_icon,
155 GtkAllocation *allocation);
156 static void gtk_status_icon_screen_changed (GtkStatusIcon *status_icon,
157 GdkScreen *old_screen);
158 static void gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon);
159 static void gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon);
160 static void gtk_status_icon_padding_changed (GtkStatusIcon *status_icon);
161 static void gtk_status_icon_fg_changed (GtkStatusIcon *status_icon);
162 static void gtk_status_icon_color_changed (GtkTrayIcon *tray,
164 GtkStatusIcon *status_icon);
165 static gboolean gtk_status_icon_scroll (GtkStatusIcon *status_icon,
166 GdkEventScroll *event);
167 static gboolean gtk_status_icon_query_tooltip (GtkStatusIcon *status_icon,
170 gboolean keyboard_tip,
171 GtkTooltip *tooltip);
173 static gboolean gtk_status_icon_key_press (GtkStatusIcon *status_icon,
175 static void gtk_status_icon_popup_menu (GtkStatusIcon *status_icon);
177 static gboolean gtk_status_icon_button_press (GtkStatusIcon *status_icon,
178 GdkEventButton *event);
179 static gboolean gtk_status_icon_button_release (GtkStatusIcon *status_icon,
180 GdkEventButton *event);
181 static void gtk_status_icon_reset_image_data (GtkStatusIcon *status_icon);
182 static void gtk_status_icon_update_image (GtkStatusIcon *status_icon);
184 G_DEFINE_TYPE (GtkStatusIcon, gtk_status_icon, G_TYPE_OBJECT)
187 gtk_status_icon_class_init (GtkStatusIconClass *class)
189 GObjectClass *gobject_class = (GObjectClass *) class;
191 gobject_class->constructor = gtk_status_icon_constructor;
192 gobject_class->finalize = gtk_status_icon_finalize;
193 gobject_class->set_property = gtk_status_icon_set_property;
194 gobject_class->get_property = gtk_status_icon_get_property;
196 class->button_press_event = NULL;
197 class->button_release_event = NULL;
198 class->scroll_event = NULL;
199 class->query_tooltip = NULL;
201 g_object_class_install_property (gobject_class,
203 g_param_spec_object ("pixbuf",
205 P_("A GdkPixbuf to display"),
207 GTK_PARAM_READWRITE));
209 g_object_class_install_property (gobject_class,
211 g_param_spec_string ("file",
213 P_("Filename to load and display"),
215 GTK_PARAM_WRITABLE));
217 g_object_class_install_property (gobject_class,
219 g_param_spec_string ("stock",
221 P_("Stock ID for a stock image to display"),
223 GTK_PARAM_READWRITE));
225 g_object_class_install_property (gobject_class,
227 g_param_spec_string ("icon-name",
229 P_("The name of the icon from the icon theme"),
231 GTK_PARAM_READWRITE));
234 * GtkStatusIcon:gicon:
236 * The #GIcon displayed in the #GtkStatusIcon. For themed icons,
237 * the image will be updated automatically if the theme changes.
241 g_object_class_install_property (gobject_class,
243 g_param_spec_object ("gicon",
245 P_("The GIcon being displayed"),
247 GTK_PARAM_READWRITE));
249 g_object_class_install_property (gobject_class,
251 g_param_spec_enum ("storage-type",
253 P_("The representation being used for image data"),
256 GTK_PARAM_READABLE));
258 g_object_class_install_property (gobject_class,
260 g_param_spec_int ("size",
262 P_("The size of the icon"),
266 GTK_PARAM_READABLE));
268 g_object_class_install_property (gobject_class,
270 g_param_spec_object ("screen",
272 P_("The screen where this status icon will be displayed"),
274 GTK_PARAM_READWRITE));
276 g_object_class_install_property (gobject_class,
278 g_param_spec_boolean ("visible",
280 P_("Whether the status icon is visible"),
282 GTK_PARAM_READWRITE));
286 * GtkStatusIcon:embedded:
288 * %TRUE if the statusicon is embedded in a notification area.
292 g_object_class_install_property (gobject_class,
294 g_param_spec_boolean ("embedded",
296 P_("Whether the status icon is embedded"),
298 GTK_PARAM_READABLE));
301 * GtkStatusIcon:orientation:
303 * The orientation of the tray in which the statusicon
308 g_object_class_install_property (gobject_class,
310 g_param_spec_enum ("orientation",
312 P_("The orientation of the tray"),
313 GTK_TYPE_ORIENTATION,
314 GTK_ORIENTATION_HORIZONTAL,
315 GTK_PARAM_READABLE));
318 * GtkStatusIcon:has-tooltip:
320 * Enables or disables the emission of #GtkStatusIcon::query-tooltip on
321 * @status_icon. A value of %TRUE indicates that @status_icon can have a
322 * tooltip, in this case the status icon will be queried using
323 * #GtkStatusIcon::query-tooltip to determine whether it will provide a
326 * Note that setting this property to %TRUE for the first time will change
327 * the event masks of the windows of this status icon to include leave-notify
328 * and motion-notify events. This will not be undone when the property is set
331 * Whether this property is respected is platform dependent.
332 * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
336 g_object_class_install_property (gobject_class,
338 g_param_spec_boolean ("has-tooltip",
340 P_("Whether this tray icon has a tooltip"),
342 GTK_PARAM_READWRITE));
344 * GtkStatusIcon:tooltip-text:
346 * Sets the text of tooltip to be the given string.
348 * Also see gtk_tooltip_set_text().
350 * This is a convenience property which will take care of getting the
351 * tooltip shown if the given string is not %NULL.
352 * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
353 * the default handler for the #GtkStatusIcon::query-tooltip signal
354 * will take care of displaying the tooltip.
356 * Note that some platforms have limitations on the length of tooltips
357 * that they allow on status icons, e.g. Windows only shows the first
362 g_object_class_install_property (gobject_class,
364 g_param_spec_string ("tooltip-text",
366 P_("The contents of the tooltip for this widget"),
368 GTK_PARAM_READWRITE));
370 * GtkStatusIcon:tooltip-markup:
372 * Sets the text of tooltip to be the given string, which is marked up
373 * with the <link linkend="PangoMarkupFormat">Pango text markup
374 * language</link>. Also see gtk_tooltip_set_markup().
376 * This is a convenience property which will take care of getting the
377 * tooltip shown if the given string is not %NULL.
378 * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
379 * the default handler for the #GtkStatusIcon::query-tooltip signal
380 * will take care of displaying the tooltip.
382 * On some platforms, embedded markup will be ignored.
386 g_object_class_install_property (gobject_class,
388 g_param_spec_string ("tooltip-markup",
389 P_("Tooltip markup"),
390 P_("The contents of the tooltip for this tray icon"),
392 GTK_PARAM_READWRITE));
396 * GtkStatusIcon:title:
398 * The title of this tray icon. This should be a short, human-readable,
399 * localized string describing the tray icon. It may be used by tools
400 * like screen readers to render the tray icon.
404 g_object_class_install_property (gobject_class,
406 g_param_spec_string ("title",
408 P_("The title of this tray icon"),
410 GTK_PARAM_READWRITE));
413 * GtkStatusIcon::activate:
414 * @status_icon: the object which received the signal
416 * Gets emitted when the user activates the status icon.
417 * If and how status icons can activated is platform-dependent.
419 * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
420 * be used by applications and should be wrapped by language bindings.
424 status_icon_signals [ACTIVATE_SIGNAL] =
425 g_signal_new (I_("activate"),
426 G_TYPE_FROM_CLASS (gobject_class),
427 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
428 G_STRUCT_OFFSET (GtkStatusIconClass, activate),
431 g_cclosure_marshal_VOID__VOID,
436 * GtkStatusIcon::popup-menu:
437 * @status_icon: the object which received the signal
438 * @button: the button that was pressed, or 0 if the
439 * signal is not emitted in response to a button press event
440 * @activate_time: the timestamp of the event that
441 * triggered the signal emission
443 * Gets emitted when the user brings up the context menu
444 * of the status icon. Whether status icons can have context
445 * menus and how these are activated is platform-dependent.
447 * The @button and @activate_time parameters should be
448 * passed as the last to arguments to gtk_menu_popup().
450 * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
451 * be used by applications and should be wrapped by language bindings.
455 status_icon_signals [POPUP_MENU_SIGNAL] =
456 g_signal_new (I_("popup-menu"),
457 G_TYPE_FROM_CLASS (gobject_class),
458 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
459 G_STRUCT_OFFSET (GtkStatusIconClass, popup_menu),
462 _gtk_marshal_VOID__UINT_UINT,
469 * GtkStatusIcon::size-changed:
470 * @status_icon: the object which received the signal
471 * @size: the new size
473 * Gets emitted when the size available for the image
474 * changes, e.g. because the notification area got resized.
476 * Return value: %TRUE if the icon was updated for the new
477 * size. Otherwise, GTK+ will scale the icon as necessary.
481 status_icon_signals [SIZE_CHANGED_SIGNAL] =
482 g_signal_new (I_("size-changed"),
483 G_TYPE_FROM_CLASS (gobject_class),
485 G_STRUCT_OFFSET (GtkStatusIconClass, size_changed),
486 g_signal_accumulator_true_handled,
488 _gtk_marshal_BOOLEAN__INT,
494 * GtkStatusIcon::button-press-event:
495 * @status_icon: the object which received the signal
496 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
499 * The ::button-press-event signal will be emitted when a button
500 * (typically from a mouse) is pressed.
502 * Whether this event is emitted is platform-dependent. Use the ::activate
503 * and ::popup-menu signals in preference.
505 * Return value: %TRUE to stop other handlers from being invoked
506 * for the event. %FALSE to propagate the event further.
510 status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL] =
511 g_signal_new (I_("button_press_event"),
512 G_TYPE_FROM_CLASS (gobject_class),
514 G_STRUCT_OFFSET (GtkStatusIconClass, button_press_event),
515 g_signal_accumulator_true_handled, NULL,
516 _gtk_marshal_BOOLEAN__BOXED,
518 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
521 * GtkStatusIcon::button-release-event:
522 * @status_icon: the object which received the signal
523 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
526 * The ::button-release-event signal will be emitted when a button
527 * (typically from a mouse) is released.
529 * Whether this event is emitted is platform-dependent. Use the ::activate
530 * and ::popup-menu signals in preference.
532 * Return value: %TRUE to stop other handlers from being invoked
533 * for the event. %FALSE to propagate the event further.
537 status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL] =
538 g_signal_new (I_("button_release_event"),
539 G_TYPE_FROM_CLASS (gobject_class),
541 G_STRUCT_OFFSET (GtkStatusIconClass, button_release_event),
542 g_signal_accumulator_true_handled, NULL,
543 _gtk_marshal_BOOLEAN__BOXED,
545 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
548 * GtkStatusIcon::scroll-event:
549 * @status_icon: the object which received the signal.
550 * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
553 * The ::scroll-event signal is emitted when a button in the 4 to 7
554 * range is pressed. Wheel mice are usually configured to generate
555 * button press events for buttons 4 and 5 when the wheel is turned.
557 * Whether this event is emitted is platform-dependent.
559 * Returns: %TRUE to stop other handlers from being invoked for the event.
560 * %FALSE to propagate the event further.
564 status_icon_signals[SCROLL_EVENT_SIGNAL] =
565 g_signal_new (I_("scroll_event"),
566 G_TYPE_FROM_CLASS (gobject_class),
568 G_STRUCT_OFFSET (GtkStatusIconClass, scroll_event),
569 g_signal_accumulator_true_handled, NULL,
570 _gtk_marshal_BOOLEAN__BOXED,
572 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
575 * GtkStatusIcon::query-tooltip:
576 * @status_icon: the object which received the signal
577 * @x: the x coordinate of the cursor position where the request has been
578 * emitted, relative to @status_icon
579 * @y: the y coordinate of the cursor position where the request has been
580 * emitted, relative to @status_icon
581 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
582 * @tooltip: a #GtkTooltip
584 * Emitted when the #GtkSettings:gtk-tooltip-timeout has expired with the
585 * cursor hovering above @status_icon; or emitted when @status_icon got
586 * focus in keyboard mode.
588 * Using the given coordinates, the signal handler should determine
589 * whether a tooltip should be shown for @status_icon. If this is
590 * the case %TRUE should be returned, %FALSE otherwise. Note that if
591 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
592 * should not be used.
594 * The signal handler is free to manipulate @tooltip with the therefore
595 * destined function calls.
597 * Whether this signal is emitted is platform-dependent.
598 * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
600 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
604 status_icon_signals [QUERY_TOOLTIP_SIGNAL] =
605 g_signal_new (I_("query_tooltip"),
606 G_TYPE_FROM_CLASS (gobject_class),
608 G_STRUCT_OFFSET (GtkStatusIconClass, query_tooltip),
609 g_signal_accumulator_true_handled, NULL,
610 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
617 g_type_class_add_private (class, sizeof (GtkStatusIconPrivate));
620 #ifdef GDK_WINDOWING_WIN32
623 build_button_event (GtkStatusIconPrivate *priv,
628 GdkRectangle monitor0;
630 /* We know that gdk/win32 puts the primary monitor at index 0 */
631 gdk_screen_get_monitor_geometry (gdk_screen_get_default (), 0, &monitor0);
632 e->window = g_object_ref (gdk_get_default_root_window ());
633 e->send_event = TRUE;
634 e->time = GetTickCount ();
636 priv->last_click_x = e->x = pos.x + monitor0.x;
637 priv->last_click_y = e->y = pos.y + monitor0.y;
641 //FIXME: e->device = gdk_display_get_default ()->core_pointer;
648 GtkStatusIcon *status_icon;
649 GdkEventButton *event;
650 } ButtonCallbackData;
653 button_callback (gpointer data)
655 ButtonCallbackData *bc = (ButtonCallbackData *) data;
657 if (bc->event->type == GDK_BUTTON_PRESS)
658 gtk_status_icon_button_press (bc->status_icon, bc->event);
660 gtk_status_icon_button_release (bc->status_icon, bc->event);
662 gdk_event_free ((GdkEvent *) bc->event);
668 static UINT taskbar_created_msg = 0;
669 static GSList *status_icons = NULL;
671 static LRESULT CALLBACK
677 if (message == taskbar_created_msg)
681 for (rover = status_icons; rover != NULL; rover = rover->next)
683 GtkStatusIcon *status_icon = GTK_STATUS_ICON (rover->data);
684 GtkStatusIconPrivate *priv = status_icon->priv;
686 priv->nid.hWnd = hwnd;
687 priv->nid.uID = GPOINTER_TO_UINT (status_icon);
688 priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
689 priv->nid.uFlags = NIF_MESSAGE;
691 if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
693 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
694 priv->nid.hWnd = NULL;
698 gtk_status_icon_update_image (status_icon);
703 if (message == WM_GTK_TRAY_NOTIFICATION)
705 ButtonCallbackData *bc;
723 if (HIWORD (wparam) == XBUTTON1)
729 bc = g_new (ButtonCallbackData, 1);
730 bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_PRESS);
731 bc->status_icon = GTK_STATUS_ICON (wparam);
732 build_button_event (bc->status_icon->priv, bc->event, button);
733 g_idle_add (button_callback, bc);
749 if (HIWORD (wparam) == XBUTTON1)
755 bc = g_new (ButtonCallbackData, 1);
756 bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_RELEASE);
757 bc->status_icon = GTK_STATUS_ICON (wparam);
758 build_button_event (bc->status_icon->priv, bc->event, button);
759 g_idle_add (button_callback, bc);
769 return DefWindowProc (hwnd, message, wparam, lparam);
774 create_tray_observer (void)
777 static HWND hwnd = NULL;
779 HINSTANCE hmodule = GetModuleHandle (NULL);
784 taskbar_created_msg = RegisterWindowMessage("TaskbarCreated");
786 memset (&wclass, 0, sizeof(WNDCLASS));
787 wclass.lpszClassName = "gtkstatusicon-observer";
788 wclass.lpfnWndProc = wndproc;
789 wclass.hInstance = hmodule;
791 klass = RegisterClass (&wclass);
795 hwnd = CreateWindow (MAKEINTRESOURCE (klass),
797 0, 0, 1, 1, NULL, NULL,
801 UnregisterClass (MAKEINTRESOURCE(klass), hmodule);
811 gtk_status_icon_init (GtkStatusIcon *status_icon)
813 GtkStatusIconPrivate *priv;
815 priv = G_TYPE_INSTANCE_GET_PRIVATE (status_icon, GTK_TYPE_STATUS_ICON,
816 GtkStatusIconPrivate);
817 status_icon->priv = priv;
819 priv->storage_type = GTK_IMAGE_EMPTY;
820 priv->visible = TRUE;
822 #ifdef GDK_WINDOWING_X11
824 priv->image_width = 0;
825 priv->image_height = 0;
827 priv->tray_icon = GTK_WIDGET (_gtk_tray_icon_new (NULL));
829 gtk_widget_add_events (GTK_WIDGET (priv->tray_icon),
830 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
833 g_signal_connect_swapped (priv->tray_icon, "key-press-event",
834 G_CALLBACK (gtk_status_icon_key_press), status_icon);
835 g_signal_connect_swapped (priv->tray_icon, "popup-menu",
836 G_CALLBACK (gtk_status_icon_popup_menu), status_icon);
837 g_signal_connect_swapped (priv->tray_icon, "notify::embedded",
838 G_CALLBACK (gtk_status_icon_embedded_changed), status_icon);
839 g_signal_connect_swapped (priv->tray_icon, "notify::orientation",
840 G_CALLBACK (gtk_status_icon_orientation_changed), status_icon);
841 g_signal_connect_swapped (priv->tray_icon, "notify::padding",
842 G_CALLBACK (gtk_status_icon_padding_changed), status_icon);
843 g_signal_connect_swapped (priv->tray_icon, "notify::fg-color",
844 G_CALLBACK (gtk_status_icon_fg_changed), status_icon);
845 g_signal_connect (priv->tray_icon, "notify::error-color",
846 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
847 g_signal_connect (priv->tray_icon, "notify::warning-color",
848 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
849 g_signal_connect (priv->tray_icon, "notify::success-color",
850 G_CALLBACK (gtk_status_icon_color_changed), status_icon);
851 g_signal_connect_swapped (priv->tray_icon, "button-press-event",
852 G_CALLBACK (gtk_status_icon_button_press), status_icon);
853 g_signal_connect_swapped (priv->tray_icon, "button-release-event",
854 G_CALLBACK (gtk_status_icon_button_release), status_icon);
855 g_signal_connect_swapped (priv->tray_icon, "scroll-event",
856 G_CALLBACK (gtk_status_icon_scroll), status_icon);
857 g_signal_connect_swapped (priv->tray_icon, "query-tooltip",
858 G_CALLBACK (gtk_status_icon_query_tooltip), status_icon);
859 g_signal_connect_swapped (priv->tray_icon, "screen-changed",
860 G_CALLBACK (gtk_status_icon_screen_changed), status_icon);
861 priv->image = gtk_image_new ();
862 gtk_widget_set_can_focus (priv->image, TRUE);
863 gtk_container_add (GTK_CONTAINER (priv->tray_icon), priv->image);
864 gtk_widget_show (priv->image);
866 /* Force-initialize the symbolic colors */
867 g_object_notify (G_OBJECT (priv->tray_icon), "fg-color");
868 g_object_notify (G_OBJECT (priv->tray_icon), "error-color");
869 g_object_notify (G_OBJECT (priv->tray_icon), "warning-color");
870 g_object_notify (G_OBJECT (priv->tray_icon), "success-color");
872 g_signal_connect_swapped (priv->image, "size-allocate",
873 G_CALLBACK (gtk_status_icon_size_allocate), status_icon);
877 #ifdef GDK_WINDOWING_WIN32
879 /* Get position and orientation of Windows taskbar. */
883 abd.cbSize = sizeof (abd);
884 SHAppBarMessage (ABM_GETTASKBARPOS, &abd);
885 if (abd.rc.bottom - abd.rc.top > abd.rc.right - abd.rc.left)
886 priv->orientation = GTK_ORIENTATION_VERTICAL;
888 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
891 priv->last_click_x = priv->last_click_y = 0;
893 /* Are the system tray icons always 16 pixels square? */
895 priv->image_width = 16;
896 priv->image_height = 16;
898 priv->dummy_widget = gtk_label_new ("");
900 memset (&priv->nid, 0, sizeof (priv->nid));
902 priv->nid.hWnd = create_tray_observer ();
903 priv->nid.uID = GPOINTER_TO_UINT (status_icon);
904 priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
905 priv->nid.uFlags = NIF_MESSAGE;
907 /* To help win7 identify the icon create it with an application "unique" tip */
908 if (g_get_prgname ())
910 WCHAR *wcs = g_utf8_to_utf16 (g_get_prgname (), -1, NULL, NULL, NULL);
912 priv->nid.uFlags |= NIF_TIP;
913 wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
914 priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
918 if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
920 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
921 priv->nid.hWnd = NULL;
924 status_icons = g_slist_append (status_icons, status_icon);
928 #ifdef GDK_WINDOWING_QUARTZ
929 priv->dummy_widget = gtk_label_new ("");
933 priv->status_item = [[GtkQuartzStatusIcon alloc] initWithStatusIcon:status_icon];
935 priv->image_width = priv->image_height = [priv->status_item getHeight];
936 priv->size = priv->image_height;
944 gtk_status_icon_constructor (GType type,
945 guint n_construct_properties,
946 GObjectConstructParam *construct_params)
949 #ifdef GDK_WINDOWING_X11
950 GtkStatusIcon *status_icon;
951 GtkStatusIconPrivate *priv;
954 object = G_OBJECT_CLASS (gtk_status_icon_parent_class)->constructor (type,
955 n_construct_properties,
958 #ifdef GDK_WINDOWING_X11
959 status_icon = GTK_STATUS_ICON (object);
960 priv = status_icon->priv;
963 gtk_widget_show (priv->tray_icon);
970 gtk_status_icon_finalize (GObject *object)
972 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
973 GtkStatusIconPrivate *priv = status_icon->priv;
975 gtk_status_icon_reset_image_data (status_icon);
977 #ifdef GDK_WINDOWING_X11
978 g_signal_handlers_disconnect_by_func (priv->tray_icon,
979 gtk_status_icon_key_press, status_icon);
980 g_signal_handlers_disconnect_by_func (priv->tray_icon,
981 gtk_status_icon_popup_menu, status_icon);
982 g_signal_handlers_disconnect_by_func (priv->tray_icon,
983 gtk_status_icon_embedded_changed, status_icon);
984 g_signal_handlers_disconnect_by_func (priv->tray_icon,
985 gtk_status_icon_orientation_changed, status_icon);
986 g_signal_handlers_disconnect_by_func (priv->tray_icon,
987 gtk_status_icon_padding_changed, status_icon);
988 g_signal_handlers_disconnect_by_func (priv->tray_icon,
989 gtk_status_icon_fg_changed, status_icon);
990 g_signal_handlers_disconnect_by_func (priv->tray_icon,
991 gtk_status_icon_color_changed, status_icon);
992 g_signal_handlers_disconnect_by_func (priv->tray_icon,
993 gtk_status_icon_button_press, status_icon);
994 g_signal_handlers_disconnect_by_func (priv->tray_icon,
995 gtk_status_icon_button_release, status_icon);
996 g_signal_handlers_disconnect_by_func (priv->tray_icon,
997 gtk_status_icon_scroll, status_icon);
998 g_signal_handlers_disconnect_by_func (priv->tray_icon,
999 gtk_status_icon_query_tooltip, status_icon);
1000 g_signal_handlers_disconnect_by_func (priv->tray_icon,
1001 gtk_status_icon_screen_changed, status_icon);
1002 gtk_widget_destroy (priv->image);
1003 gtk_widget_destroy (priv->tray_icon);
1006 #ifdef GDK_WINDOWING_WIN32
1007 if (priv->nid.hWnd != NULL && priv->visible)
1008 Shell_NotifyIconW (NIM_DELETE, &priv->nid);
1009 if (priv->nid.hIcon)
1010 DestroyIcon (priv->nid.hIcon);
1011 g_free (priv->tooltip_text);
1013 gtk_widget_destroy (priv->dummy_widget);
1015 status_icons = g_slist_remove (status_icons, status_icon);
1018 #ifdef GDK_WINDOWING_QUARTZ
1020 [priv->status_item release];
1021 QUARTZ_POOL_RELEASE;
1022 g_free (priv->tooltip_text);
1025 G_OBJECT_CLASS (gtk_status_icon_parent_class)->finalize (object);
1029 gtk_status_icon_set_property (GObject *object,
1031 const GValue *value,
1034 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1039 gtk_status_icon_set_from_pixbuf (status_icon, g_value_get_object (value));
1042 gtk_status_icon_set_from_file (status_icon, g_value_get_string (value));
1045 gtk_status_icon_set_from_stock (status_icon, g_value_get_string (value));
1047 case PROP_ICON_NAME:
1048 gtk_status_icon_set_from_icon_name (status_icon, g_value_get_string (value));
1051 gtk_status_icon_set_from_gicon (status_icon, g_value_get_object (value));
1054 gtk_status_icon_set_screen (status_icon, g_value_get_object (value));
1057 gtk_status_icon_set_visible (status_icon, g_value_get_boolean (value));
1059 case PROP_HAS_TOOLTIP:
1060 gtk_status_icon_set_has_tooltip (status_icon, g_value_get_boolean (value));
1062 case PROP_TOOLTIP_TEXT:
1063 gtk_status_icon_set_tooltip_text (status_icon, g_value_get_string (value));
1065 case PROP_TOOLTIP_MARKUP:
1066 gtk_status_icon_set_tooltip_markup (status_icon, g_value_get_string (value));
1069 gtk_status_icon_set_title (status_icon, g_value_get_string (value));
1072 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1078 gtk_status_icon_get_property (GObject *object,
1083 GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1084 GtkStatusIconPrivate *priv = status_icon->priv;
1086 /* The "getter" functions whine if you try to get the wrong
1087 * storage type. This function is instead robust against that,
1088 * so that GUI builders don't have to jump through hoops
1089 * to avoid g_warning
1095 if (priv->storage_type != GTK_IMAGE_PIXBUF)
1096 g_value_set_object (value, NULL);
1098 g_value_set_object (value, gtk_status_icon_get_pixbuf (status_icon));
1101 if (priv->storage_type != GTK_IMAGE_STOCK)
1102 g_value_set_string (value, NULL);
1104 g_value_set_string (value, gtk_status_icon_get_stock (status_icon));
1106 case PROP_ICON_NAME:
1107 if (priv->storage_type != GTK_IMAGE_ICON_NAME)
1108 g_value_set_string (value, NULL);
1110 g_value_set_string (value, gtk_status_icon_get_icon_name (status_icon));
1113 if (priv->storage_type != GTK_IMAGE_GICON)
1114 g_value_set_object (value, NULL);
1116 g_value_set_object (value, gtk_status_icon_get_gicon (status_icon));
1118 case PROP_STORAGE_TYPE:
1119 g_value_set_enum (value, gtk_status_icon_get_storage_type (status_icon));
1122 g_value_set_int (value, gtk_status_icon_get_size (status_icon));
1125 g_value_set_object (value, gtk_status_icon_get_screen (status_icon));
1128 g_value_set_boolean (value, gtk_status_icon_get_visible (status_icon));
1131 g_value_set_boolean (value, gtk_status_icon_is_embedded (status_icon));
1133 case PROP_ORIENTATION:
1134 #ifdef GDK_WINDOWING_X11
1135 g_value_set_enum (value, _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (status_icon->priv->tray_icon)));
1137 #ifdef GDK_WINDOWING_WIN32
1138 g_value_set_enum (value, status_icon->priv->orientation);
1141 case PROP_HAS_TOOLTIP:
1142 g_value_set_boolean (value, gtk_status_icon_get_has_tooltip (status_icon));
1144 case PROP_TOOLTIP_TEXT:
1145 g_value_set_string (value, gtk_status_icon_get_tooltip_text (status_icon));
1147 case PROP_TOOLTIP_MARKUP:
1148 g_value_set_string (value, gtk_status_icon_get_tooltip_markup (status_icon));
1151 g_value_set_string (value, gtk_status_icon_get_title (status_icon));
1154 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1160 * gtk_status_icon_new:
1162 * Creates an empty status icon object.
1164 * Return value: a new #GtkStatusIcon
1169 gtk_status_icon_new (void)
1171 return g_object_new (GTK_TYPE_STATUS_ICON, NULL);
1175 * gtk_status_icon_new_from_pixbuf:
1176 * @pixbuf: a #GdkPixbuf
1178 * Creates a status icon displaying @pixbuf.
1180 * The image will be scaled down to fit in the available
1181 * space in the notification area, if necessary.
1183 * Return value: a new #GtkStatusIcon
1188 gtk_status_icon_new_from_pixbuf (GdkPixbuf *pixbuf)
1190 return g_object_new (GTK_TYPE_STATUS_ICON,
1196 * gtk_status_icon_new_from_file:
1197 * @filename: (type filename): a filename
1199 * Creates a status icon displaying the file @filename.
1201 * The image will be scaled down to fit in the available
1202 * space in the notification area, if necessary.
1204 * Return value: a new #GtkStatusIcon
1209 gtk_status_icon_new_from_file (const gchar *filename)
1211 return g_object_new (GTK_TYPE_STATUS_ICON,
1217 * gtk_status_icon_new_from_stock:
1218 * @stock_id: a stock icon id
1220 * Creates a status icon displaying a stock icon. Sample stock icon
1221 * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your
1222 * own stock icon names, see gtk_icon_factory_add_default() and
1223 * gtk_icon_factory_add().
1225 * Return value: a new #GtkStatusIcon
1230 gtk_status_icon_new_from_stock (const gchar *stock_id)
1232 return g_object_new (GTK_TYPE_STATUS_ICON,
1238 * gtk_status_icon_new_from_icon_name:
1239 * @icon_name: an icon name
1241 * Creates a status icon displaying an icon from the current icon theme.
1242 * If the current icon theme is changed, the icon will be updated
1245 * Return value: a new #GtkStatusIcon
1250 gtk_status_icon_new_from_icon_name (const gchar *icon_name)
1252 return g_object_new (GTK_TYPE_STATUS_ICON,
1253 "icon-name", icon_name,
1258 * gtk_status_icon_new_from_gicon:
1261 * Creates a status icon displaying a #GIcon. If the icon is a
1262 * themed icon, it will be updated when the theme changes.
1264 * Return value: a new #GtkStatusIcon
1269 gtk_status_icon_new_from_gicon (GIcon *icon)
1271 return g_object_new (GTK_TYPE_STATUS_ICON,
1277 emit_activate_signal (GtkStatusIcon *status_icon)
1279 g_signal_emit (status_icon,
1280 status_icon_signals [ACTIVATE_SIGNAL], 0);
1284 emit_popup_menu_signal (GtkStatusIcon *status_icon,
1286 guint32 activate_time)
1288 g_signal_emit (status_icon,
1289 status_icon_signals [POPUP_MENU_SIGNAL], 0,
1294 #ifdef GDK_WINDOWING_X11
1297 emit_size_changed_signal (GtkStatusIcon *status_icon,
1300 gboolean handled = FALSE;
1302 g_signal_emit (status_icon,
1303 status_icon_signals [SIZE_CHANGED_SIGNAL], 0,
1312 #ifdef GDK_WINDOWING_X11
1315 find_icon_size (GtkWidget *widget,
1319 GtkSettings *settings;
1320 GtkIconSize s, size;
1323 screen = gtk_widget_get_screen (widget);
1326 return GTK_ICON_SIZE_MENU;
1328 settings = gtk_settings_get_for_screen (screen);
1331 size = GTK_ICON_SIZE_MENU;
1333 for (s = GTK_ICON_SIZE_MENU; s <= GTK_ICON_SIZE_DIALOG; s++)
1335 if (gtk_icon_size_lookup_for_settings (settings, s, &w, &h) &&
1336 w <= pixel_size && h <= pixel_size)
1338 d = MAX (pixel_size - w, pixel_size - h);
1353 gtk_status_icon_update_image (GtkStatusIcon *status_icon)
1355 GtkStatusIconPrivate *priv = status_icon->priv;
1356 #ifdef GDK_WINDOWING_WIN32
1360 switch (priv->storage_type)
1362 case GTK_IMAGE_PIXBUF:
1366 pixbuf = priv->image_data.pixbuf;
1377 width = gdk_pixbuf_get_width (pixbuf);
1378 height = gdk_pixbuf_get_height (pixbuf);
1380 if (width > size || height > size)
1381 scaled = gdk_pixbuf_scale_simple (pixbuf,
1384 GDK_INTERP_BILINEAR);
1386 scaled = g_object_ref (pixbuf);
1388 #ifdef GDK_WINDOWING_X11
1389 gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), scaled);
1391 #ifdef GDK_WINDOWING_WIN32
1392 prev_hicon = priv->nid.hIcon;
1393 priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (scaled);
1394 priv->nid.uFlags |= NIF_ICON;
1395 if (priv->nid.hWnd != NULL && priv->visible)
1396 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1397 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1399 DestroyIcon (prev_hicon);
1401 #ifdef GDK_WINDOWING_QUARTZ
1403 [priv->status_item setImage:scaled];
1404 QUARTZ_POOL_RELEASE;
1407 g_object_unref (scaled);
1411 #ifdef GDK_WINDOWING_X11
1412 gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), NULL);
1414 #ifdef GDK_WINDOWING_WIN32
1415 priv->nid.uFlags &= ~NIF_ICON;
1416 if (priv->nid.hWnd != NULL && priv->visible)
1417 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1418 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1420 #ifdef GDK_WINDOWING_QUARTZ
1421 [priv->status_item setImage:NULL];
1427 case GTK_IMAGE_STOCK:
1429 #ifdef GDK_WINDOWING_X11
1430 GtkIconSize size = find_icon_size (priv->image, priv->size);
1431 gtk_image_set_from_stock (GTK_IMAGE (priv->image),
1432 priv->image_data.stock_id,
1435 #ifdef GDK_WINDOWING_WIN32
1438 gtk_widget_render_icon_pixbuf (priv->dummy_widget,
1439 priv->image_data.stock_id,
1440 GTK_ICON_SIZE_SMALL_TOOLBAR);
1442 prev_hicon = priv->nid.hIcon;
1443 priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (pixbuf);
1444 priv->nid.uFlags |= NIF_ICON;
1445 if (priv->nid.hWnd != NULL && priv->visible)
1446 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1447 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1449 DestroyIcon (prev_hicon);
1450 g_object_unref (pixbuf);
1453 #ifdef GDK_WINDOWING_QUARTZ
1457 pixbuf = gtk_widget_render_icon_pixbuf (priv->dummy_widget,
1458 priv->image_data.stock_id,
1459 GTK_ICON_SIZE_SMALL_TOOLBAR);
1461 [priv->status_item setImage:pixbuf];
1462 QUARTZ_POOL_RELEASE;
1463 g_object_unref (pixbuf);
1469 case GTK_IMAGE_ICON_NAME:
1471 #ifdef GDK_WINDOWING_X11
1472 GtkIconSize size = find_icon_size (priv->image, priv->size);
1473 gtk_image_set_from_icon_name (GTK_IMAGE (priv->image),
1474 priv->image_data.icon_name,
1477 #ifdef GDK_WINDOWING_WIN32
1480 gtk_icon_theme_load_icon (gtk_icon_theme_get_default (),
1481 priv->image_data.icon_name,
1485 prev_hicon = priv->nid.hIcon;
1486 priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (pixbuf);
1487 priv->nid.uFlags |= NIF_ICON;
1488 if (priv->nid.hWnd != NULL && priv->visible)
1489 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1490 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1492 DestroyIcon (prev_hicon);
1493 g_object_unref (pixbuf);
1496 #ifdef GDK_WINDOWING_QUARTZ
1500 pixbuf = gtk_icon_theme_load_icon (gtk_icon_theme_get_default (),
1501 priv->image_data.icon_name,
1506 [priv->status_item setImage:pixbuf];
1507 QUARTZ_POOL_RELEASE;
1508 g_object_unref (pixbuf);
1515 case GTK_IMAGE_GICON:
1517 #ifdef GDK_WINDOWING_X11
1518 GtkIconSize size = find_icon_size (priv->image, priv->size);
1519 gtk_image_set_from_gicon (GTK_IMAGE (priv->image),
1520 priv->image_data.gicon,
1523 #ifdef GDK_WINDOWING_WIN32
1526 gtk_icon_theme_lookup_by_gicon (gtk_icon_theme_get_default (),
1527 priv->image_data.gicon,
1530 GdkPixbuf *pixbuf = gtk_icon_info_load_icon (info, NULL);
1532 prev_hicon = priv->nid.hIcon;
1533 priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (pixbuf);
1534 priv->nid.uFlags |= NIF_ICON;
1535 if (priv->nid.hWnd != NULL && priv->visible)
1536 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1537 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1539 DestroyIcon (prev_hicon);
1540 g_object_unref (pixbuf);
1543 #ifdef GDK_WINDOWING_QUARTZ
1546 gtk_icon_theme_lookup_by_gicon (gtk_icon_theme_get_default (),
1547 priv->image_data.gicon,
1550 GdkPixbuf *pixbuf = gtk_icon_info_load_icon (info, NULL);
1553 [priv->status_item setImage:pixbuf];
1554 QUARTZ_POOL_RELEASE;
1555 g_object_unref (pixbuf);
1562 case GTK_IMAGE_EMPTY:
1563 #ifdef GDK_WINDOWING_X11
1564 gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), NULL);
1566 #ifdef GDK_WINDOWING_WIN32
1567 priv->nid.uFlags &= ~NIF_ICON;
1568 if (priv->nid.hWnd != NULL && priv->visible)
1569 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1570 g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1572 #ifdef GDK_WINDOWING_QUARTZ
1575 [priv->status_item setImage:NULL];
1576 QUARTZ_POOL_RELEASE;
1581 g_assert_not_reached ();
1586 #ifdef GDK_WINDOWING_X11
1589 gtk_status_icon_size_allocate (GtkStatusIcon *status_icon,
1590 GtkAllocation *allocation)
1592 GtkStatusIconPrivate *priv = status_icon->priv;
1593 GtkOrientation orientation;
1597 orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1599 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1600 size = allocation->height;
1602 size = allocation->width;
1604 gtk_misc_get_padding (GTK_MISC (priv->image), &xpad, &ypad);
1606 priv->image_width = allocation->width - xpad * 2;
1607 priv->image_height = allocation->height - ypad * 2;
1609 if (priv->size != size)
1613 g_object_notify (G_OBJECT (status_icon), "size");
1615 if (!emit_size_changed_signal (status_icon, size))
1616 gtk_status_icon_update_image (status_icon);
1621 gtk_status_icon_screen_changed (GtkStatusIcon *status_icon,
1622 GdkScreen *old_screen)
1624 GtkStatusIconPrivate *priv = status_icon->priv;
1626 if (gtk_widget_get_screen (priv->tray_icon) != old_screen)
1628 g_object_notify (G_OBJECT (status_icon), "screen");
1634 #ifdef GDK_WINDOWING_X11
1637 gtk_status_icon_padding_changed (GtkStatusIcon *status_icon)
1639 GtkStatusIconPrivate *priv = status_icon->priv;
1640 GtkOrientation orientation;
1643 orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1644 padding = _gtk_tray_icon_get_padding (GTK_TRAY_ICON (priv->tray_icon));
1646 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1647 gtk_misc_set_padding (GTK_MISC (priv->image), padding, 0);
1649 gtk_misc_set_padding (GTK_MISC (priv->image), 0, padding);
1653 gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon)
1655 gtk_status_icon_padding_changed (status_icon);
1656 g_object_notify (G_OBJECT (status_icon), "embedded");
1660 gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon)
1662 gtk_status_icon_padding_changed (status_icon);
1663 g_object_notify (G_OBJECT (status_icon), "orientation");
1667 gtk_status_icon_fg_changed (GtkStatusIcon *status_icon)
1669 GtkStatusIconPrivate *priv = status_icon->priv;
1672 g_object_get (priv->tray_icon, "fg-color", &color, NULL);
1673 gtk_widget_modify_fg (priv->image, GTK_STATE_NORMAL, color);
1674 gdk_color_free (color);
1678 gtk_status_icon_color_changed (GtkTrayIcon *tray,
1680 GtkStatusIcon *status_icon)
1682 GtkStatusIconPrivate *priv = status_icon->priv;
1686 switch (pspec->name[0])
1706 g_object_get (priv->tray_icon, pspec->name, &color, NULL);
1708 rgba.red = color->red / 65535.;
1709 rgba.green = color->green / 65535.;
1710 rgba.blue = color->blue / 65535.;
1712 gdk_color_free (color);
1714 gtk_widget_override_symbolic_color (priv->image, name, &rgba);
1719 gtk_status_icon_key_press (GtkStatusIcon *status_icon,
1722 guint state, keyval;
1724 state = event->state & gtk_accelerator_get_default_mod_mask ();
1725 keyval = event->keyval;
1727 (keyval == GDK_KEY_Return ||
1728 keyval == GDK_KEY_KP_Enter ||
1729 keyval == GDK_KEY_ISO_Enter ||
1730 keyval == GDK_KEY_space ||
1731 keyval == GDK_KEY_KP_Space))
1733 emit_activate_signal (status_icon);
1741 gtk_status_icon_popup_menu (GtkStatusIcon *status_icon)
1743 emit_popup_menu_signal (status_icon, 0, gtk_get_current_event_time ());
1749 gtk_status_icon_button_press (GtkStatusIcon *status_icon,
1750 GdkEventButton *event)
1752 gboolean handled = FALSE;
1754 g_signal_emit (status_icon,
1755 status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL], 0,
1760 if (event->button == 1 && event->type == GDK_BUTTON_PRESS)
1762 emit_activate_signal (status_icon);
1765 else if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
1767 emit_popup_menu_signal (status_icon, event->button, event->time);
1775 gtk_status_icon_button_release (GtkStatusIcon *status_icon,
1776 GdkEventButton *event)
1778 gboolean handled = FALSE;
1779 g_signal_emit (status_icon,
1780 status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL], 0,
1785 #ifdef GDK_WINDOWING_X11
1787 gtk_status_icon_scroll (GtkStatusIcon *status_icon,
1788 GdkEventScroll *event)
1790 gboolean handled = FALSE;
1791 g_signal_emit (status_icon,
1792 status_icon_signals [SCROLL_EVENT_SIGNAL], 0,
1798 gtk_status_icon_query_tooltip (GtkStatusIcon *status_icon,
1801 gboolean keyboard_tip,
1802 GtkTooltip *tooltip)
1804 gboolean handled = FALSE;
1805 g_signal_emit (status_icon,
1806 status_icon_signals [QUERY_TOOLTIP_SIGNAL], 0,
1807 x, y, keyboard_tip, tooltip, &handled);
1810 #endif /* GDK_WINDOWING_X11 */
1813 gtk_status_icon_reset_image_data (GtkStatusIcon *status_icon)
1815 GtkStatusIconPrivate *priv = status_icon->priv;
1817 switch (priv->storage_type)
1819 case GTK_IMAGE_PIXBUF:
1820 if (priv->image_data.pixbuf)
1821 g_object_unref (priv->image_data.pixbuf);
1822 priv->image_data.pixbuf = NULL;
1823 g_object_notify (G_OBJECT (status_icon), "pixbuf");
1826 case GTK_IMAGE_STOCK:
1827 g_free (priv->image_data.stock_id);
1828 priv->image_data.stock_id = NULL;
1830 g_object_notify (G_OBJECT (status_icon), "stock");
1833 case GTK_IMAGE_ICON_NAME:
1834 g_free (priv->image_data.icon_name);
1835 priv->image_data.icon_name = NULL;
1837 g_object_notify (G_OBJECT (status_icon), "icon-name");
1840 case GTK_IMAGE_GICON:
1841 if (priv->image_data.gicon)
1842 g_object_unref (priv->image_data.gicon);
1843 priv->image_data.gicon = NULL;
1845 g_object_notify (G_OBJECT (status_icon), "gicon");
1848 case GTK_IMAGE_EMPTY:
1851 g_assert_not_reached ();
1855 priv->storage_type = GTK_IMAGE_EMPTY;
1856 g_object_notify (G_OBJECT (status_icon), "storage-type");
1860 gtk_status_icon_set_image (GtkStatusIcon *status_icon,
1861 GtkImageType storage_type,
1864 GtkStatusIconPrivate *priv = status_icon->priv;
1866 g_object_freeze_notify (G_OBJECT (status_icon));
1868 gtk_status_icon_reset_image_data (status_icon);
1870 priv->storage_type = storage_type;
1871 g_object_notify (G_OBJECT (status_icon), "storage-type");
1873 switch (storage_type)
1875 case GTK_IMAGE_PIXBUF:
1876 priv->image_data.pixbuf = (GdkPixbuf *)data;
1877 g_object_notify (G_OBJECT (status_icon), "pixbuf");
1879 case GTK_IMAGE_STOCK:
1880 priv->image_data.stock_id = g_strdup ((const gchar *)data);
1881 g_object_notify (G_OBJECT (status_icon), "stock");
1883 case GTK_IMAGE_ICON_NAME:
1884 priv->image_data.icon_name = g_strdup ((const gchar *)data);
1885 g_object_notify (G_OBJECT (status_icon), "icon-name");
1887 case GTK_IMAGE_GICON:
1888 priv->image_data.gicon = (GIcon *)data;
1889 g_object_notify (G_OBJECT (status_icon), "gicon");
1892 g_warning ("Image type %u not handled by GtkStatusIcon", storage_type);
1895 g_object_thaw_notify (G_OBJECT (status_icon));
1897 gtk_status_icon_update_image (status_icon);
1901 * gtk_status_icon_set_from_pixbuf:
1902 * @status_icon: a #GtkStatusIcon
1903 * @pixbuf: (allow-none): a #GdkPixbuf or %NULL
1905 * Makes @status_icon display @pixbuf.
1906 * See gtk_status_icon_new_from_pixbuf() for details.
1911 gtk_status_icon_set_from_pixbuf (GtkStatusIcon *status_icon,
1914 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1915 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
1918 g_object_ref (pixbuf);
1920 gtk_status_icon_set_image (status_icon, GTK_IMAGE_PIXBUF,
1925 * gtk_status_icon_set_from_file:
1926 * @status_icon: a #GtkStatusIcon
1927 * @filename: (type filename): a filename
1929 * Makes @status_icon display the file @filename.
1930 * See gtk_status_icon_new_from_file() for details.
1935 gtk_status_icon_set_from_file (GtkStatusIcon *status_icon,
1936 const gchar *filename)
1940 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1941 g_return_if_fail (filename != NULL);
1943 pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
1945 gtk_status_icon_set_from_pixbuf (status_icon, pixbuf);
1948 g_object_unref (pixbuf);
1952 * gtk_status_icon_set_from_stock:
1953 * @status_icon: a #GtkStatusIcon
1954 * @stock_id: a stock icon id
1956 * Makes @status_icon display the stock icon with the id @stock_id.
1957 * See gtk_status_icon_new_from_stock() for details.
1962 gtk_status_icon_set_from_stock (GtkStatusIcon *status_icon,
1963 const gchar *stock_id)
1965 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1966 g_return_if_fail (stock_id != NULL);
1968 gtk_status_icon_set_image (status_icon, GTK_IMAGE_STOCK,
1969 (gpointer) stock_id);
1973 * gtk_status_icon_set_from_icon_name:
1974 * @status_icon: a #GtkStatusIcon
1975 * @icon_name: an icon name
1977 * Makes @status_icon display the icon named @icon_name from the
1978 * current icon theme.
1979 * See gtk_status_icon_new_from_icon_name() for details.
1984 gtk_status_icon_set_from_icon_name (GtkStatusIcon *status_icon,
1985 const gchar *icon_name)
1987 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1988 g_return_if_fail (icon_name != NULL);
1990 gtk_status_icon_set_image (status_icon, GTK_IMAGE_ICON_NAME,
1991 (gpointer) icon_name);
1995 * gtk_status_icon_set_from_gicon:
1996 * @status_icon: a #GtkStatusIcon
1999 * Makes @status_icon display the #GIcon.
2000 * See gtk_status_icon_new_from_gicon() for details.
2005 gtk_status_icon_set_from_gicon (GtkStatusIcon *status_icon,
2008 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2009 g_return_if_fail (icon != NULL);
2012 g_object_ref (icon);
2014 gtk_status_icon_set_image (status_icon, GTK_IMAGE_GICON,
2019 * gtk_status_icon_get_storage_type:
2020 * @status_icon: a #GtkStatusIcon
2022 * Gets the type of representation being used by the #GtkStatusIcon
2023 * to store image data. If the #GtkStatusIcon has no image data,
2024 * the return value will be %GTK_IMAGE_EMPTY.
2026 * Return value: the image representation being used
2031 gtk_status_icon_get_storage_type (GtkStatusIcon *status_icon)
2033 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), GTK_IMAGE_EMPTY);
2035 return status_icon->priv->storage_type;
2038 * gtk_status_icon_get_pixbuf:
2039 * @status_icon: a #GtkStatusIcon
2041 * Gets the #GdkPixbuf being displayed by the #GtkStatusIcon.
2042 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
2043 * %GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()).
2044 * The caller of this function does not own a reference to the
2047 * Return value: (transfer none): the displayed pixbuf,
2048 * or %NULL if the image is empty.
2053 gtk_status_icon_get_pixbuf (GtkStatusIcon *status_icon)
2055 GtkStatusIconPrivate *priv;
2057 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2059 priv = status_icon->priv;
2061 g_return_val_if_fail (priv->storage_type == GTK_IMAGE_PIXBUF ||
2062 priv->storage_type == GTK_IMAGE_EMPTY, NULL);
2064 if (priv->storage_type == GTK_IMAGE_EMPTY)
2065 priv->image_data.pixbuf = NULL;
2067 return priv->image_data.pixbuf;
2071 * gtk_status_icon_get_stock:
2072 * @status_icon: a #GtkStatusIcon
2074 * Gets the id of the stock icon being displayed by the #GtkStatusIcon.
2075 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
2076 * %GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()).
2077 * The returned string is owned by the #GtkStatusIcon and should not
2078 * be freed or modified.
2080 * Return value: stock id of the displayed stock icon,
2081 * or %NULL if the image is empty.
2085 G_CONST_RETURN gchar *
2086 gtk_status_icon_get_stock (GtkStatusIcon *status_icon)
2088 GtkStatusIconPrivate *priv;
2090 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2092 priv = status_icon->priv;
2094 g_return_val_if_fail (priv->storage_type == GTK_IMAGE_STOCK ||
2095 priv->storage_type == GTK_IMAGE_EMPTY, NULL);
2097 if (priv->storage_type == GTK_IMAGE_EMPTY)
2098 priv->image_data.stock_id = NULL;
2100 return priv->image_data.stock_id;
2104 * gtk_status_icon_get_icon_name:
2105 * @status_icon: a #GtkStatusIcon
2107 * Gets the name of the icon being displayed by the #GtkStatusIcon.
2108 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
2109 * %GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()).
2110 * The returned string is owned by the #GtkStatusIcon and should not
2111 * be freed or modified.
2113 * Return value: name of the displayed icon, or %NULL if the image is empty.
2117 G_CONST_RETURN gchar *
2118 gtk_status_icon_get_icon_name (GtkStatusIcon *status_icon)
2120 GtkStatusIconPrivate *priv;
2122 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2124 priv = status_icon->priv;
2126 g_return_val_if_fail (priv->storage_type == GTK_IMAGE_ICON_NAME ||
2127 priv->storage_type == GTK_IMAGE_EMPTY, NULL);
2129 if (priv->storage_type == GTK_IMAGE_EMPTY)
2130 priv->image_data.icon_name = NULL;
2132 return priv->image_data.icon_name;
2136 * gtk_status_icon_get_gicon:
2137 * @status_icon: a #GtkStatusIcon
2139 * Retrieves the #GIcon being displayed by the #GtkStatusIcon.
2140 * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
2141 * %GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()).
2142 * The caller of this function does not own a reference to the
2145 * If this function fails, @icon is left unchanged;
2147 * Returns: (transfer none): the displayed icon, or %NULL if the image is empty
2152 gtk_status_icon_get_gicon (GtkStatusIcon *status_icon)
2154 GtkStatusIconPrivate *priv;
2156 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2158 priv = status_icon->priv;
2160 g_return_val_if_fail (priv->storage_type == GTK_IMAGE_GICON ||
2161 priv->storage_type == GTK_IMAGE_EMPTY, NULL);
2163 if (priv->storage_type == GTK_IMAGE_EMPTY)
2164 priv->image_data.gicon = NULL;
2166 return priv->image_data.gicon;
2170 * gtk_status_icon_get_size:
2171 * @status_icon: a #GtkStatusIcon
2173 * Gets the size in pixels that is available for the image.
2174 * Stock icons and named icons adapt their size automatically
2175 * if the size of the notification area changes. For other
2176 * storage types, the size-changed signal can be used to
2177 * react to size changes.
2179 * Note that the returned size is only meaningful while the
2180 * status icon is embedded (see gtk_status_icon_is_embedded()).
2182 * Return value: the size that is available for the image
2187 gtk_status_icon_get_size (GtkStatusIcon *status_icon)
2189 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), 0);
2191 return status_icon->priv->size;
2195 * gtk_status_icon_set_screen:
2196 * @status_icon: a #GtkStatusIcon
2197 * @screen: a #GdkScreen
2199 * Sets the #GdkScreen where @status_icon is displayed; if
2200 * the icon is already mapped, it will be unmapped, and
2201 * then remapped on the new screen.
2206 gtk_status_icon_set_screen (GtkStatusIcon *status_icon,
2209 g_return_if_fail (GDK_IS_SCREEN (screen));
2211 #ifdef GDK_WINDOWING_X11
2212 gtk_window_set_screen (GTK_WINDOW (status_icon->priv->tray_icon), screen);
2217 * gtk_status_icon_get_screen:
2218 * @status_icon: a #GtkStatusIcon
2220 * Returns the #GdkScreen associated with @status_icon.
2222 * Return value: (transfer none): a #GdkScreen.
2227 gtk_status_icon_get_screen (GtkStatusIcon *status_icon)
2229 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2231 #ifdef GDK_WINDOWING_X11
2232 return gtk_window_get_screen (GTK_WINDOW (status_icon->priv->tray_icon));
2234 return gdk_screen_get_default ();
2239 * gtk_status_icon_set_visible:
2240 * @status_icon: a #GtkStatusIcon
2241 * @visible: %TRUE to show the status icon, %FALSE to hide it
2243 * Shows or hides a status icon.
2248 gtk_status_icon_set_visible (GtkStatusIcon *status_icon,
2251 GtkStatusIconPrivate *priv;
2253 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2255 priv = status_icon->priv;
2257 visible = visible != FALSE;
2259 if (priv->visible != visible)
2261 priv->visible = visible;
2263 #ifdef GDK_WINDOWING_X11
2265 gtk_widget_show (priv->tray_icon);
2266 else if (gtk_widget_get_realized (priv->tray_icon))
2268 gtk_widget_hide (priv->tray_icon);
2269 gtk_widget_unrealize (priv->tray_icon);
2272 #ifdef GDK_WINDOWING_WIN32
2273 if (priv->nid.hWnd != NULL)
2276 Shell_NotifyIconW (NIM_ADD, &priv->nid);
2278 Shell_NotifyIconW (NIM_DELETE, &priv->nid);
2281 #ifdef GDK_WINDOWING_QUARTZ
2283 [priv->status_item setVisible:visible];
2284 QUARTZ_POOL_RELEASE;
2286 g_object_notify (G_OBJECT (status_icon), "visible");
2291 * gtk_status_icon_get_visible:
2292 * @status_icon: a #GtkStatusIcon
2294 * Returns whether the status icon is visible or not.
2295 * Note that being visible does not guarantee that
2296 * the user can actually see the icon, see also
2297 * gtk_status_icon_is_embedded().
2299 * Return value: %TRUE if the status icon is visible
2304 gtk_status_icon_get_visible (GtkStatusIcon *status_icon)
2306 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2308 return status_icon->priv->visible;
2312 * gtk_status_icon_is_embedded:
2313 * @status_icon: a #GtkStatusIcon
2315 * Returns whether the status icon is embedded in a notification
2318 * Return value: %TRUE if the status icon is embedded in
2319 * a notification area.
2324 gtk_status_icon_is_embedded (GtkStatusIcon *status_icon)
2326 #ifdef GDK_WINDOWING_X11
2330 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2332 #ifdef GDK_WINDOWING_X11
2333 plug = GTK_PLUG (status_icon->priv->tray_icon);
2335 if (gtk_plug_get_embedded (plug))
2340 #ifdef GDK_WINDOWING_WIN32
2343 #ifdef GDK_WINDOWING_QUARTZ
2349 * gtk_status_icon_position_menu:
2350 * @menu: the #GtkMenu
2351 * @x: (out): return location for the x position
2352 * @y: (out): return location for the y position
2353 * @push_in: (out): whether the first menu item should be offset
2354 * (pushed in) to be aligned with the menu popup position
2355 * (only useful for GtkOptionMenu).
2356 * @user_data: (type GtkStatusIcon): the status icon to position the menu on
2358 * Menu positioning function to use with gtk_menu_popup()
2359 * to position @menu aligned to the status icon @user_data.
2364 gtk_status_icon_position_menu (GtkMenu *menu,
2370 #ifdef GDK_WINDOWING_X11
2371 GtkAllocation allocation;
2372 GtkStatusIcon *status_icon;
2373 GtkStatusIconPrivate *priv;
2374 GtkTrayIcon *tray_icon;
2377 GtkTextDirection direction;
2378 GtkRequisition menu_req;
2379 GdkRectangle monitor;
2381 gint monitor_num, height, width, xoffset, yoffset;
2383 g_return_if_fail (GTK_IS_MENU (menu));
2384 g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2386 status_icon = GTK_STATUS_ICON (user_data);
2387 priv = status_icon->priv;
2388 tray_icon = GTK_TRAY_ICON (priv->tray_icon);
2389 widget = priv->tray_icon;
2391 direction = gtk_widget_get_direction (widget);
2393 screen = gtk_widget_get_screen (widget);
2394 gtk_menu_set_screen (menu, screen);
2396 window = gtk_widget_get_window (widget);
2397 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
2398 if (monitor_num < 0)
2400 gtk_menu_set_monitor (menu, monitor_num);
2402 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
2404 gdk_window_get_origin (window, x, y);
2406 gtk_widget_get_preferred_size (GTK_WIDGET (menu),
2409 gtk_widget_get_allocation (widget, &allocation);
2410 if (_gtk_tray_icon_get_orientation (tray_icon) == GTK_ORIENTATION_VERTICAL)
2413 height = allocation.height;
2414 xoffset = allocation.width;
2419 width = allocation.width;
2422 yoffset = allocation.height;
2425 if (direction == GTK_TEXT_DIR_RTL)
2427 if ((*x - (menu_req.width - width)) >= monitor.x)
2428 *x -= menu_req.width - width;
2429 else if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2431 else if ((monitor.x + monitor.width - (*x + xoffset)) < *x)
2432 *x -= menu_req.width - width;
2438 if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2440 else if ((*x - (menu_req.width - width)) >= monitor.x)
2441 *x -= menu_req.width - width;
2442 else if ((monitor.x + monitor.width - (*x + xoffset)) > *x)
2445 *x -= menu_req.width - width;
2448 if ((*y + yoffset + menu_req.height) < (monitor.y + monitor.height))
2450 else if ((*y - (menu_req.height - height)) >= monitor.y)
2451 *y -= menu_req.height - height;
2452 else if (monitor.y + monitor.height - (*y + yoffset) > *y)
2455 *y -= menu_req.height - height;
2458 #endif /* GDK_WINDOWING_X11 */
2460 #ifdef GDK_WINDOWING_WIN32
2461 GtkStatusIcon *status_icon;
2462 GtkStatusIconPrivate *priv;
2464 g_return_if_fail (GTK_IS_MENU (menu));
2465 g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2467 status_icon = GTK_STATUS_ICON (user_data);
2468 priv = status_icon->priv;
2470 *x = priv->last_click_x;
2471 *y = priv->last_click_y;
2477 * gtk_status_icon_get_geometry:
2478 * @status_icon: a #GtkStatusIcon
2479 * @screen: (out) (transfer none) (allow-none): return location for
2480 * the screen, or %NULL if the information is not needed
2481 * @area: (out) (allow-none): return location for the area occupied by
2482 * the status icon, or %NULL
2483 * @orientation: (out) (allow-none): return location for the
2484 * orientation of the panel in which the status icon is embedded,
2485 * or %NULL. A panel at the top or bottom of the screen is
2486 * horizontal, a panel at the left or right is vertical.
2488 * Obtains information about the location of the status icon
2489 * on screen. This information can be used to e.g. position
2490 * popups like notification bubbles.
2492 * See gtk_status_icon_position_menu() for a more convenient
2493 * alternative for positioning menus.
2495 * Note that some platforms do not allow GTK+ to provide
2496 * this information, and even on platforms that do allow it,
2497 * the information is not reliable unless the status icon
2498 * is embedded in a notification area, see
2499 * gtk_status_icon_is_embedded().
2501 * Return value: %TRUE if the location information has
2507 gtk_status_icon_get_geometry (GtkStatusIcon *status_icon,
2510 GtkOrientation *orientation)
2512 #ifdef GDK_WINDOWING_X11
2513 GtkAllocation allocation;
2515 GtkStatusIconPrivate *priv;
2518 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2520 priv = status_icon->priv;
2521 widget = priv->tray_icon;
2524 *screen = gtk_widget_get_screen (widget);
2528 gdk_window_get_origin (gtk_widget_get_window (widget),
2531 gtk_widget_get_allocation (widget, &allocation);
2534 area->width = allocation.width;
2535 area->height = allocation.height;
2539 *orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (widget));
2544 #endif /* GDK_WINDOWING_X11 */
2548 * gtk_status_icon_set_has_tooltip:
2549 * @status_icon: a #GtkStatusIcon
2550 * @has_tooltip: whether or not @status_icon has a tooltip
2552 * Sets the has-tooltip property on @status_icon to @has_tooltip.
2553 * See #GtkStatusIcon:has-tooltip for more information.
2558 gtk_status_icon_set_has_tooltip (GtkStatusIcon *status_icon,
2559 gboolean has_tooltip)
2561 GtkStatusIconPrivate *priv;
2563 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2565 priv = status_icon->priv;
2567 #ifdef GDK_WINDOWING_X11
2568 gtk_widget_set_has_tooltip (priv->tray_icon, has_tooltip);
2570 #ifdef GDK_WINDOWING_WIN32
2571 if (!has_tooltip && priv->tooltip_text)
2572 gtk_status_icon_set_tooltip_text (status_icon, NULL);
2574 #ifdef GDK_WINDOWING_QUARTZ
2575 if (!has_tooltip && priv->tooltip_text)
2576 gtk_status_icon_set_tooltip_text (status_icon, NULL);
2581 * gtk_status_icon_get_has_tooltip:
2582 * @status_icon: a #GtkStatusIcon
2584 * Returns the current value of the has-tooltip property.
2585 * See #GtkStatusIcon:has-tooltip for more information.
2587 * Return value: current value of has-tooltip on @status_icon.
2592 gtk_status_icon_get_has_tooltip (GtkStatusIcon *status_icon)
2594 GtkStatusIconPrivate *priv;
2595 gboolean has_tooltip = FALSE;
2597 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2599 priv = status_icon->priv;
2601 #ifdef GDK_WINDOWING_X11
2602 has_tooltip = gtk_widget_get_has_tooltip (priv->tray_icon);
2604 #ifdef GDK_WINDOWING_WIN32
2605 has_tooltip = (priv->tooltip_text != NULL);
2607 #ifdef GDK_WINDOWING_QUARTZ
2608 has_tooltip = (priv->tooltip_text != NULL);
2615 * gtk_status_icon_set_tooltip_text:
2616 * @status_icon: a #GtkStatusIcon
2617 * @text: the contents of the tooltip for @status_icon
2619 * Sets @text as the contents of the tooltip.
2621 * This function will take care of setting #GtkStatusIcon:has-tooltip to
2622 * %TRUE and of the default handler for the #GtkStatusIcon::query-tooltip
2625 * See also the #GtkStatusIcon:tooltip-text property and
2626 * gtk_tooltip_set_text().
2631 gtk_status_icon_set_tooltip_text (GtkStatusIcon *status_icon,
2634 GtkStatusIconPrivate *priv;
2636 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2638 priv = status_icon->priv;
2640 #ifdef GDK_WINDOWING_X11
2642 gtk_widget_set_tooltip_text (priv->tray_icon, text);
2645 #ifdef GDK_WINDOWING_WIN32
2647 priv->nid.uFlags &= ~NIF_TIP;
2650 WCHAR *wcs = g_utf8_to_utf16 (text, -1, NULL, NULL, NULL);
2652 priv->nid.uFlags |= NIF_TIP;
2653 wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
2654 priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
2657 if (priv->nid.hWnd != NULL && priv->visible)
2658 if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
2659 g_warning (G_STRLOC ": Shell_NotifyIconW(NIM_MODIFY) failed");
2661 g_free (priv->tooltip_text);
2662 priv->tooltip_text = g_strdup (text);
2664 #ifdef GDK_WINDOWING_QUARTZ
2666 [priv->status_item setToolTip:text];
2667 QUARTZ_POOL_RELEASE;
2669 g_free (priv->tooltip_text);
2670 priv->tooltip_text = g_strdup (text);
2675 * gtk_status_icon_get_tooltip_text:
2676 * @status_icon: a #GtkStatusIcon
2678 * Gets the contents of the tooltip for @status_icon.
2680 * Return value: the tooltip text, or %NULL. You should free the
2681 * returned string with g_free() when done.
2686 gtk_status_icon_get_tooltip_text (GtkStatusIcon *status_icon)
2688 GtkStatusIconPrivate *priv;
2689 gchar *tooltip_text = NULL;
2691 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2693 priv = status_icon->priv;
2695 #ifdef GDK_WINDOWING_X11
2696 tooltip_text = gtk_widget_get_tooltip_text (priv->tray_icon);
2698 #ifdef GDK_WINDOWING_WIN32
2699 if (priv->tooltip_text)
2700 tooltip_text = g_strdup (priv->tooltip_text);
2702 #ifdef GDK_WINDOWING_QUARTZ
2703 if (priv->tooltip_text)
2704 tooltip_text = g_strdup (priv->tooltip_text);
2707 return tooltip_text;
2711 * gtk_status_icon_set_tooltip_markup:
2712 * @status_icon: a #GtkStatusIcon
2713 * @markup: (allow-none): the contents of the tooltip for @status_icon, or %NULL
2715 * Sets @markup as the contents of the tooltip, which is marked up with
2716 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
2718 * This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
2719 * and of the default handler for the #GtkStatusIcon::query-tooltip signal.
2721 * See also the #GtkStatusIcon:tooltip-markup property and
2722 * gtk_tooltip_set_markup().
2727 gtk_status_icon_set_tooltip_markup (GtkStatusIcon *status_icon,
2728 const gchar *markup)
2730 GtkStatusIconPrivate *priv;
2731 #ifndef GDK_WINDOWING_X11
2735 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2737 priv = status_icon->priv;
2739 #ifdef GDK_WINDOWING_X11
2740 gtk_widget_set_tooltip_markup (priv->tray_icon, markup);
2742 #ifdef GDK_WINDOWING_WIN32
2744 pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2745 gtk_status_icon_set_tooltip_text (status_icon, text);
2748 #ifdef GDK_WINDOWING_QUARTZ
2750 pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2751 gtk_status_icon_set_tooltip_text (status_icon, text);
2757 * gtk_status_icon_get_tooltip_markup:
2758 * @status_icon: a #GtkStatusIcon
2760 * Gets the contents of the tooltip for @status_icon.
2762 * Return value: the tooltip text, or %NULL. You should free the
2763 * returned string with g_free() when done.
2768 gtk_status_icon_get_tooltip_markup (GtkStatusIcon *status_icon)
2770 GtkStatusIconPrivate *priv;
2771 gchar *markup = NULL;
2773 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2775 priv = status_icon->priv;
2777 #ifdef GDK_WINDOWING_X11
2778 markup = gtk_widget_get_tooltip_markup (priv->tray_icon);
2780 #ifdef GDK_WINDOWING_WIN32
2781 if (priv->tooltip_text)
2782 markup = g_markup_escape_text (priv->tooltip_text, -1);
2784 #ifdef GDK_WINDOWING_QUARTZ
2785 if (priv->tooltip_text)
2786 markup = g_markup_escape_text (priv->tooltip_text, -1);
2793 * gtk_status_icon_get_x11_window_id:
2794 * @status_icon: a #GtkStatusIcon
2796 * This function is only useful on the X11/freedesktop.org platform.
2797 * It returns a window ID for the widget in the underlying
2798 * status icon implementation. This is useful for the Galago
2799 * notification service, which can send a window ID in the protocol
2800 * in order for the server to position notification windows
2801 * pointing to a status icon reliably.
2803 * This function is not intended for other use cases which are
2804 * more likely to be met by one of the non-X11 specific methods, such
2805 * as gtk_status_icon_position_menu().
2807 * Return value: An 32 bit unsigned integer identifier for the
2808 * underlying X11 Window
2813 gtk_status_icon_get_x11_window_id (GtkStatusIcon *status_icon)
2815 #ifdef GDK_WINDOWING_X11
2816 gtk_widget_realize (GTK_WIDGET (status_icon->priv->tray_icon));
2817 return GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (status_icon->priv->tray_icon)));
2824 * gtk_status_icon_set_title:
2825 * @status_icon: a #GtkStatusIcon
2828 * Sets the title of this tray icon.
2829 * This should be a short, human-readable, localized string
2830 * describing the tray icon. It may be used by tools like screen
2831 * readers to render the tray icon.
2836 gtk_status_icon_set_title (GtkStatusIcon *status_icon,
2839 GtkStatusIconPrivate *priv;
2841 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2843 priv = status_icon->priv;
2845 #ifdef GDK_WINDOWING_X11
2846 gtk_window_set_title (GTK_WINDOW (priv->tray_icon), title);
2848 #ifdef GDK_WINDOWING_QUARTZ
2849 g_free (priv->title);
2850 priv->title = g_strdup (title);
2852 #ifdef GDK_WINDOWING_WIN32
2853 g_free (priv->title);
2854 priv->title = g_strdup (title);
2857 g_object_notify (G_OBJECT (status_icon), "title");
2861 * gtk_status_icon_get_title:
2862 * @status_icon: a #GtkStatusIcon
2864 * Gets the title of this tray icon. See gtk_status_icon_set_title().
2866 * Returns: the title of the status icon
2870 G_CONST_RETURN gchar *
2871 gtk_status_icon_get_title (GtkStatusIcon *status_icon)
2873 GtkStatusIconPrivate *priv;
2875 g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2877 priv = status_icon->priv;
2879 #ifdef GDK_WINDOWING_X11
2880 return gtk_window_get_title (GTK_WINDOW (priv->tray_icon));
2882 #ifdef GDK_WINDOWING_QUARTZ
2885 #ifdef GDK_WINDOWING_WIN32
2892 * gtk_status_icon_set_name:
2893 * @status_icon: a #GtkStatusIcon
2896 * Sets the name of this tray icon.
2897 * This should be a string identifying this icon. It is may be
2898 * used for sorting the icons in the tray and will not be shown to
2904 gtk_status_icon_set_name (GtkStatusIcon *status_icon,
2907 GtkStatusIconPrivate *priv;
2909 g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2911 priv = status_icon->priv;
2913 #ifdef GDK_WINDOWING_X11
2914 gtk_window_set_wmclass (GTK_WINDOW (priv->tray_icon), name, name);