Pileus Git - ~andy/gtk/blob - gtk/gtkstatusicon.c

   1 /* gtkstatusicon.c:
   2  *
   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
   7  *
   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.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  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/>.
  20  *
  21  * Authors:
  22  *      Mark McLoughlin <mark@skynet.ie>
  23  *      Hans Breuer <hans@breuer.org>
  24  *      Tor Lillqvist <tml@novell.com>
  25  *      Mikael Hallendal <micke@imendio.com>
  26  */
  27
  28 #include "config.h"
  29
  30 #include <string.h>
  31 #include <stdlib.h>
  32
  33 #include "gtkstatusicon.h"
  34
  35 #include "gtkintl.h"
  36 #include "gtkiconfactory.h"
  37 #include "gtkiconhelperprivate.h"
  38 #include "gtkmain.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"
  45 #include "gtklabel.h"
  46 #include "gtktypebuiltins.h"
  47
  48 #ifdef GDK_WINDOWING_X11
  49 #include "gdk/x11/gdkx.h"
  50 #include "gtktrayicon.h"
  51 #endif
  52
  53 #ifdef GDK_WINDOWING_WIN32
  54 #include "gdk/win32/gdkwin32.h"
  55 #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1)
  56 #endif
  57
  58
  59 /**
  60  * SECTION:gtkstatusicon
  61  * @Short_description: Display an icon in the system tray
  62  * @Title: GtkStatusIcon
  63  *
  64  * The "system tray" or notification area is normally used for transient icons
  65  * that indicate some special state. For example, a system tray icon might
  66  * appear to tell the user that they have new mail, or have an incoming instant
  67  * message, or something along those lines. The basic idea is that creating an
  68  * icon in the notification area is less annoying than popping up a dialog.
  69  *
  70  * A #GtkStatusIcon object can be used to display an icon in a "system tray".
  71  * The icon can have a tooltip, and the user can interact with it by
  72  * activating it or popping up a context menu. Critical information should
  73  * not solely be displayed in a #GtkStatusIcon, since it may not be
  74  * visible (e.g. when the user doesn't have a notification area on his panel).
  75  * This can be checked with gtk_status_icon_is_embedded().
  76  *
  77  * On X11, the implementation follows the freedesktop.org "System Tray"
  78  * <ulink url="http://www.freedesktop.org/wiki/Specifications/systemtray-spec">specification</ulink>.
  79  * Implementations of the "tray" side of this specification can
  80  * be found e.g. in the GNOME 2 and KDE panel applications.
  81  *
  82  * Note that a GtkStatusIcon is <emphasis>not</emphasis> a widget, but just
  83  * a #GObject. Making it a widget would be impractical, since the system tray
  84  * on Win32 doesn't allow to embed arbitrary widgets.
  85  */
  86
  87
  88 #define BLINK_TIMEOUT 500
  89
  90 enum
  91 {
  92   PROP_0,
  93   PROP_PIXBUF,
  94   PROP_FILE,
  95   PROP_STOCK,
  96   PROP_ICON_NAME,
  97   PROP_GICON,
  98   PROP_STORAGE_TYPE,
  99   PROP_SIZE,
 100   PROP_SCREEN,
 101   PROP_VISIBLE,
 102   PROP_ORIENTATION,
 103   PROP_EMBEDDED,
 104   PROP_BLINKING,
 105   PROP_HAS_TOOLTIP,
 106   PROP_TOOLTIP_TEXT,
 107   PROP_TOOLTIP_MARKUP,
 108   PROP_TITLE
 109 };
 110
 111 enum
 112 {
 113   ACTIVATE_SIGNAL,
 114   POPUP_MENU_SIGNAL,
 115   SIZE_CHANGED_SIGNAL,
 116   BUTTON_PRESS_EVENT_SIGNAL,
 117   BUTTON_RELEASE_EVENT_SIGNAL,
 118   SCROLL_EVENT_SIGNAL,
 119   QUERY_TOOLTIP_SIGNAL,
 120   LAST_SIGNAL
 121 };
 122
 123 static guint status_icon_signals [LAST_SIGNAL] = { 0 };
 124
 125 #ifdef GDK_WINDOWING_QUARTZ
 126 #include "gtkstatusicon-quartz.c"
 127 #endif
 128
 129 struct _GtkStatusIconPrivate
 130 {
 131 #ifdef GDK_WINDOWING_X11
 132   GtkWidget    *tray_icon;
 133   GtkWidget    *image;
 134 #else
 135   GtkWidget    *dummy_widget;
 136 #endif
 137
 138 #ifdef GDK_WINDOWING_WIN32
 139   NOTIFYICONDATAW nid;
 140   gint          taskbar_top;
 141   gint          last_click_x, last_click_y;
 142   GtkOrientation orientation;
 143   gchar         *tooltip_text;
 144   gchar         *title;
 145 #endif
 146
 147 #ifdef GDK_WINDOWING_QUARTZ
 148   GtkQuartzStatusIcon *status_item;
 149   gchar         *tooltip_text;
 150   gchar         *title;
 151 #endif
 152
 153   gint           size;
 154   GtkIconHelper *icon_helper;
 155   guint          visible : 1;
 156 };
 157
 158 static GObject* gtk_status_icon_constructor      (GType                  type,
 159                                                   guint                  n_construct_properties,
 160                                                   GObjectConstructParam *construct_params);
 161 static void     gtk_status_icon_finalize         (GObject        *object);
 162 static void     gtk_status_icon_set_property     (GObject        *object,
 163                                                   guint           prop_id,
 164                                                   const GValue   *value,
 165                                                   GParamSpec     *pspec);
 166 static void     gtk_status_icon_get_property     (GObject        *object,
 167                                                   guint           prop_id,
 168                                                   GValue         *value,
 169                                                   GParamSpec     *pspec);
 170
 171 #ifdef GDK_WINDOWING_X11
 172 static void     gtk_status_icon_size_allocate    (GtkStatusIcon  *status_icon,
 173                                                   GtkAllocation  *allocation);
 174 static void     gtk_status_icon_screen_changed   (GtkStatusIcon  *status_icon,
 175                                                   GdkScreen      *old_screen);
 176 static void     gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon);
 177 static void     gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon);
 178 static void     gtk_status_icon_padding_changed  (GtkStatusIcon *status_icon);
 179 static void     gtk_status_icon_icon_size_changed(GtkStatusIcon *status_icon);
 180 static void     gtk_status_icon_fg_changed       (GtkStatusIcon *status_icon);
 181 static void     gtk_status_icon_color_changed    (GtkTrayIcon   *tray,
 182                                                   GParamSpec    *pspec,
 183                                                   GtkStatusIcon *status_icon);
 184 static gboolean gtk_status_icon_scroll           (GtkStatusIcon  *status_icon,
 185                                                   GdkEventScroll *event);
 186 static gboolean gtk_status_icon_query_tooltip    (GtkStatusIcon *status_icon,
 187                                                   gint           x,
 188                                                   gint           y,
 189                                                   gboolean       keyboard_tip,
 190                                                   GtkTooltip    *tooltip);
 191
 192 static gboolean gtk_status_icon_key_press        (GtkStatusIcon  *status_icon,
 193                                                   GdkEventKey    *event);
 194 static void     gtk_status_icon_popup_menu       (GtkStatusIcon  *status_icon);
 195 #endif
 196 static gboolean gtk_status_icon_button_press     (GtkStatusIcon  *status_icon,
 197                                                   GdkEventButton *event);
 198 static gboolean gtk_status_icon_button_release   (GtkStatusIcon  *status_icon,
 199                                                   GdkEventButton *event);
 200 static void     gtk_status_icon_reset_image_data (GtkStatusIcon  *status_icon);
 201 static void     gtk_status_icon_update_image    (GtkStatusIcon *status_icon);
 202
 203 G_DEFINE_TYPE (GtkStatusIcon, gtk_status_icon, G_TYPE_OBJECT)
 204
 205 static void
 206 gtk_status_icon_class_init (GtkStatusIconClass *class)
 207 {
 208   GObjectClass *gobject_class = (GObjectClass *) class;
 209
 210   gobject_class->constructor  = gtk_status_icon_constructor;
 211   gobject_class->finalize     = gtk_status_icon_finalize;
 212   gobject_class->set_property = gtk_status_icon_set_property;
 213   gobject_class->get_property = gtk_status_icon_get_property;
 214
 215   class->button_press_event   = NULL;
 216   class->button_release_event = NULL;
 217   class->scroll_event         = NULL;
 218   class->query_tooltip        = NULL;
 219
 220   g_object_class_install_property (gobject_class,
 221                                    PROP_PIXBUF,
 222                                    g_param_spec_object ("pixbuf",
 223                                                         P_("Pixbuf"),
 224                                                         P_("A GdkPixbuf to display"),
 225                                                         GDK_TYPE_PIXBUF,
 226                                                         GTK_PARAM_READWRITE));
 227
 228   g_object_class_install_property (gobject_class,
 229                                    PROP_FILE,
 230                                    g_param_spec_string ("file",
 231                                                         P_("Filename"),
 232                                                         P_("Filename to load and display"),
 233                                                         NULL,
 234                                                         GTK_PARAM_WRITABLE));
 235
 236   g_object_class_install_property (gobject_class,
 237                                    PROP_STOCK,
 238                                    g_param_spec_string ("stock",
 239                                                         P_("Stock ID"),
 240                                                         P_("Stock ID for a stock image to display"),
 241                                                         NULL,
 242                                                         GTK_PARAM_READWRITE));
 243
 244   g_object_class_install_property (gobject_class,
 245                                    PROP_ICON_NAME,
 246                                    g_param_spec_string ("icon-name",
 247                                                         P_("Icon Name"),
 248                                                         P_("The name of the icon from the icon theme"),
 249                                                         NULL,
 250                                                         GTK_PARAM_READWRITE));
 251
 252   /**
 253    * GtkStatusIcon:gicon:
 254    *
 255    * The #GIcon displayed in the #GtkStatusIcon. For themed icons,
 256    * the image will be updated automatically if the theme changes.
 257    *
 258    * Since: 2.14
 259    */
 260   g_object_class_install_property (gobject_class,
 261                                    PROP_GICON,
 262                                    g_param_spec_object ("gicon",
 263                                                         P_("GIcon"),
 264                                                         P_("The GIcon being displayed"),
 265                                                         G_TYPE_ICON,
 266                                                         GTK_PARAM_READWRITE));
 267
 268   g_object_class_install_property (gobject_class,
 269                                    PROP_STORAGE_TYPE,
 270                                    g_param_spec_enum ("storage-type",
 271                                                       P_("Storage type"),
 272                                                       P_("The representation being used for image data"),
 273                                                       GTK_TYPE_IMAGE_TYPE,
 274                                                       GTK_IMAGE_EMPTY,
 275                                                       GTK_PARAM_READABLE));
 276
 277   g_object_class_install_property (gobject_class,
 278                                    PROP_SIZE,
 279                                    g_param_spec_int ("size",
 280                                                      P_("Size"),
 281                                                      P_("The size of the icon"),
 282                                                      0,
 283                                                      G_MAXINT,
 284                                                      0,
 285                                                      GTK_PARAM_READABLE));
 286
 287   g_object_class_install_property (gobject_class,
 288                                    PROP_SCREEN,
 289                                    g_param_spec_object ("screen",
 290                                                         P_("Screen"),
 291                                                         P_("The screen where this status icon will be displayed"),
 292                                                         GDK_TYPE_SCREEN,
 293                                                         GTK_PARAM_READWRITE));
 294
 295   g_object_class_install_property (gobject_class,
 296                                    PROP_VISIBLE,
 297                                    g_param_spec_boolean ("visible",
 298                                                          P_("Visible"),
 299                                                          P_("Whether the status icon is visible"),
 300                                                          TRUE,
 301                                                          GTK_PARAM_READWRITE));
 302
 303
 304   /**
 305    * GtkStatusIcon:embedded:
 306    *
 307    * %TRUE if the statusicon is embedded in a notification area.
 308    *
 309    * Since: 2.12
 310    */
 311   g_object_class_install_property (gobject_class,
 312                                    PROP_EMBEDDED,
 313                                    g_param_spec_boolean ("embedded",
 314                                                          P_("Embedded"),
 315                                                          P_("Whether the status icon is embedded"),
 316                                                          FALSE,
 317                                                          GTK_PARAM_READABLE));
 318
 319   /**
 320    * GtkStatusIcon:orientation:
 321    *
 322    * The orientation of the tray in which the statusicon
 323    * is embedded.
 324    *
 325    * Since: 2.12
 326    */
 327   g_object_class_install_property (gobject_class,
 328                                    PROP_ORIENTATION,
 329                                    g_param_spec_enum ("orientation",
 330                                                       P_("Orientation"),
 331                                                       P_("The orientation of the tray"),
 332                                                       GTK_TYPE_ORIENTATION,
 333                                                       GTK_ORIENTATION_HORIZONTAL,
 334                                                       GTK_PARAM_READABLE));
 335
 336 /**
 337  * GtkStatusIcon:has-tooltip:
 338  *
 339  * Enables or disables the emission of #GtkStatusIcon::query-tooltip on
 340  * @status_icon.  A value of %TRUE indicates that @status_icon can have a
 341  * tooltip, in this case the status icon will be queried using
 342  * #GtkStatusIcon::query-tooltip to determine whether it will provide a
 343  * tooltip or not.
 344  *
 345  * Note that setting this property to %TRUE for the first time will change
 346  * the event masks of the windows of this status icon to include leave-notify
 347  * and motion-notify events. This will not be undone when the property is set
 348  * to %FALSE again.
 349  *
 350  * Whether this property is respected is platform dependent.
 351  * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
 352  *
 353  * Since: 2.16
 354  */
 355   g_object_class_install_property (gobject_class,
 356                                    PROP_HAS_TOOLTIP,
 357                                    g_param_spec_boolean ("has-tooltip",
 358                                                          P_("Has tooltip"),
 359                                                          P_("Whether this tray icon has a tooltip"),
 360                                                          FALSE,
 361                                                          GTK_PARAM_READWRITE));
 362   /**
 363    * GtkStatusIcon:tooltip-text:
 364    *
 365    * Sets the text of tooltip to be the given string.
 366    *
 367    * Also see gtk_tooltip_set_text().
 368    *
 369    * This is a convenience property which will take care of getting the
 370    * tooltip shown if the given string is not %NULL.
 371    * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
 372    * the default handler for the #GtkStatusIcon::query-tooltip signal
 373    * will take care of displaying the tooltip.
 374    *
 375    * Note that some platforms have limitations on the length of tooltips
 376    * that they allow on status icons, e.g. Windows only shows the first
 377    * 64 characters.
 378    *
 379    * Since: 2.16
 380    */
 381   g_object_class_install_property (gobject_class,
 382                                    PROP_TOOLTIP_TEXT,
 383                                    g_param_spec_string ("tooltip-text",
 384                                                         P_("Tooltip Text"),
 385                                                         P_("The contents of the tooltip for this widget"),
 386                                                         NULL,
 387                                                         GTK_PARAM_READWRITE));
 388   /**
 389    * GtkStatusIcon:tooltip-markup:
 390    *
 391    * Sets the text of tooltip to be the given string, which is marked up
 392    * with the <link linkend="PangoMarkupFormat">Pango text markup
 393    * language</link>. Also see gtk_tooltip_set_markup().
 394    *
 395    * This is a convenience property which will take care of getting the
 396    * tooltip shown if the given string is not %NULL.
 397    * #GtkStatusIcon:has-tooltip will automatically be set to %TRUE and
 398    * the default handler for the #GtkStatusIcon::query-tooltip signal
 399    * will take care of displaying the tooltip.
 400    *
 401    * On some platforms, embedded markup will be ignored.
 402    *
 403    * Since: 2.16
 404    */
 405   g_object_class_install_property (gobject_class,
 406                                    PROP_TOOLTIP_MARKUP,
 407                                    g_param_spec_string ("tooltip-markup",
 408                                                         P_("Tooltip markup"),
 409                                                         P_("The contents of the tooltip for this tray icon"),
 410                                                         NULL,
 411                                                         GTK_PARAM_READWRITE));
 412
 413
 414   /**
 415    * GtkStatusIcon:title:
 416    *
 417    * The title of this tray icon. This should be a short, human-readable,
 418    * localized string describing the tray icon. It may be used by tools
 419    * like screen readers to render the tray icon.
 420    *
 421    * Since: 2.18
 422    */
 423   g_object_class_install_property (gobject_class,
 424                                    PROP_TITLE,
 425                                    g_param_spec_string ("title",
 426                                                         P_("Title"),
 427                                                         P_("The title of this tray icon"),
 428                                                         NULL,
 429                                                         GTK_PARAM_READWRITE));
 430
 431   /**
 432    * GtkStatusIcon::activate:
 433    * @status_icon: the object which received the signal
 434    *
 435    * Gets emitted when the user activates the status icon.
 436    * If and how status icons can activated is platform-dependent.
 437    *
 438    * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
 439    * be used by applications and should be wrapped by language bindings.
 440    *
 441    * Since: 2.10
 442    */
 443   status_icon_signals [ACTIVATE_SIGNAL] =
 444     g_signal_new (I_("activate"),
 445                   G_TYPE_FROM_CLASS (gobject_class),
 446                   G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
 447                   G_STRUCT_OFFSET (GtkStatusIconClass, activate),
 448                   NULL,
 449                   NULL,
 450                   g_cclosure_marshal_VOID__VOID,
 451                   G_TYPE_NONE,
 452                   0);
 453
 454   /**
 455    * GtkStatusIcon::popup-menu:
 456    * @status_icon: the object which received the signal
 457    * @button: the button that was pressed, or 0 if the
 458    *   signal is not emitted in response to a button press event
 459    * @activate_time: the timestamp of the event that
 460    *   triggered the signal emission
 461    *
 462    * Gets emitted when the user brings up the context menu
 463    * of the status icon. Whether status icons can have context
 464    * menus and how these are activated is platform-dependent.
 465    *
 466    * The @button and @activate_time parameters should be
 467    * passed as the last to arguments to gtk_menu_popup().
 468    *
 469    * Unlike most G_SIGNAL_ACTION signals, this signal is meant to
 470    * be used by applications and should be wrapped by language bindings.
 471    *
 472    * Since: 2.10
 473    */
 474   status_icon_signals [POPUP_MENU_SIGNAL] =
 475     g_signal_new (I_("popup-menu"),
 476                   G_TYPE_FROM_CLASS (gobject_class),
 477                   G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
 478                   G_STRUCT_OFFSET (GtkStatusIconClass, popup_menu),
 479                   NULL,
 480                   NULL,
 481                   _gtk_marshal_VOID__UINT_UINT,
 482                   G_TYPE_NONE,
 483                   2,
 484                   G_TYPE_UINT,
 485                   G_TYPE_UINT);
 486
 487   /**
 488    * GtkStatusIcon::size-changed:
 489    * @status_icon: the object which received the signal
 490    * @size: the new size
 491    *
 492    * Gets emitted when the size available for the image
 493    * changes, e.g. because the notification area got resized.
 494    *
 495    * Return value: %TRUE if the icon was updated for the new
 496    * size. Otherwise, GTK+ will scale the icon as necessary.
 497    *
 498    * Since: 2.10
 499    */
 500   status_icon_signals [SIZE_CHANGED_SIGNAL] =
 501     g_signal_new (I_("size-changed"),
 502                   G_TYPE_FROM_CLASS (gobject_class),
 503                   G_SIGNAL_RUN_LAST,
 504                   G_STRUCT_OFFSET (GtkStatusIconClass, size_changed),
 505                   g_signal_accumulator_true_handled,
 506                   NULL,
 507                   _gtk_marshal_BOOLEAN__INT,
 508                   G_TYPE_BOOLEAN,
 509                   1,
 510                   G_TYPE_INT);
 511
 512   /**
 513    * GtkStatusIcon::button-press-event:
 514    * @status_icon: the object which received the signal
 515    * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
 516    *                                 this signal
 517    *
 518    * The ::button-press-event signal will be emitted when a button
 519    * (typically from a mouse) is pressed.
 520    *
 521    * Whether this event is emitted is platform-dependent.  Use the ::activate
 522    * and ::popup-menu signals in preference.
 523    *
 524    * Return value: %TRUE to stop other handlers from being invoked
 525    * for the event. %FALSE to propagate the event further.
 526    *
 527    * Since: 2.14
 528    */
 529   status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL] =
 530     g_signal_new (I_("button_press_event"),
 531                   G_TYPE_FROM_CLASS (gobject_class),
 532                   G_SIGNAL_RUN_LAST,
 533                   G_STRUCT_OFFSET (GtkStatusIconClass, button_press_event),
 534                   g_signal_accumulator_true_handled, NULL,
 535                   _gtk_marshal_BOOLEAN__BOXED,
 536                   G_TYPE_BOOLEAN, 1,
 537                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
 538
 539   /**
 540    * GtkStatusIcon::button-release-event:
 541    * @status_icon: the object which received the signal
 542    * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
 543    *                                 this signal
 544    *
 545    * The ::button-release-event signal will be emitted when a button
 546    * (typically from a mouse) is released.
 547    *
 548    * Whether this event is emitted is platform-dependent.  Use the ::activate
 549    * and ::popup-menu signals in preference.
 550    *
 551    * Return value: %TRUE to stop other handlers from being invoked
 552    * for the event. %FALSE to propagate the event further.
 553    *
 554    * Since: 2.14
 555    */
 556   status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL] =
 557     g_signal_new (I_("button_release_event"),
 558                   G_TYPE_FROM_CLASS (gobject_class),
 559                   G_SIGNAL_RUN_LAST,
 560                   G_STRUCT_OFFSET (GtkStatusIconClass, button_release_event),
 561                   g_signal_accumulator_true_handled, NULL,
 562                   _gtk_marshal_BOOLEAN__BOXED,
 563                   G_TYPE_BOOLEAN, 1,
 564                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
 565
 566   /**
 567    * GtkStatusIcon::scroll-event:
 568    * @status_icon: the object which received the signal.
 569    * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
 570    *                                 this signal
 571    *
 572    * The ::scroll-event signal is emitted when a button in the 4 to 7
 573    * range is pressed. Wheel mice are usually configured to generate
 574    * button press events for buttons 4 and 5 when the wheel is turned.
 575    *
 576    * Whether this event is emitted is platform-dependent.
 577    *
 578    * Returns: %TRUE to stop other handlers from being invoked for the event.
 579    *   %FALSE to propagate the event further.
 580    *
 581    * Since: 2.16
 582    */
 583   status_icon_signals[SCROLL_EVENT_SIGNAL] =
 584     g_signal_new (I_("scroll_event"),
 585                   G_TYPE_FROM_CLASS (gobject_class),
 586                   G_SIGNAL_RUN_LAST,
 587                   G_STRUCT_OFFSET (GtkStatusIconClass, scroll_event),
 588                   g_signal_accumulator_true_handled, NULL,
 589                   _gtk_marshal_BOOLEAN__BOXED,
 590                   G_TYPE_BOOLEAN, 1,
 591                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
 592
 593   /**
 594    * GtkStatusIcon::query-tooltip:
 595    * @status_icon: the object which received the signal
 596    * @x: the x coordinate of the cursor position where the request has been
 597    *     emitted, relative to @status_icon
 598    * @y: the y coordinate of the cursor position where the request has been
 599    *     emitted, relative to @status_icon
 600    * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
 601    * @tooltip: a #GtkTooltip
 602    *
 603    * Emitted when the #GtkSettings:gtk-tooltip-timeout has expired with the
 604    * cursor hovering above @status_icon; or emitted when @status_icon got
 605    * focus in keyboard mode.
 606    *
 607    * Using the given coordinates, the signal handler should determine
 608    * whether a tooltip should be shown for @status_icon. If this is
 609    * the case %TRUE should be returned, %FALSE otherwise. Note that if
 610    * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
 611    * should not be used.
 612    *
 613    * The signal handler is free to manipulate @tooltip with the therefore
 614    * destined function calls.
 615    *
 616    * Whether this signal is emitted is platform-dependent.
 617    * For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference.
 618    *
 619    * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
 620    *
 621    * Since: 2.16
 622    */
 623   status_icon_signals [QUERY_TOOLTIP_SIGNAL] =
 624     g_signal_new (I_("query_tooltip"),
 625                   G_TYPE_FROM_CLASS (gobject_class),
 626                   G_SIGNAL_RUN_LAST,
 627                   G_STRUCT_OFFSET (GtkStatusIconClass, query_tooltip),
 628                   g_signal_accumulator_true_handled, NULL,
 629                   _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
 630                   G_TYPE_BOOLEAN, 4,
 631                   G_TYPE_INT,
 632                   G_TYPE_INT,
 633                   G_TYPE_BOOLEAN,
 634                   GTK_TYPE_TOOLTIP);
 635
 636   g_type_class_add_private (class, sizeof (GtkStatusIconPrivate));
 637 }
 638
 639 #ifdef GDK_WINDOWING_WIN32
 640
 641 static void
 642 build_button_event (GtkStatusIconPrivate *priv,
 643                     GdkEventButton       *e,
 644                     guint                 button)
 645 {
 646   POINT pos;
 647   GdkRectangle monitor0;
 648
 649   /* We know that gdk/win32 puts the primary monitor at index 0 */
 650   gdk_screen_get_monitor_geometry (gdk_screen_get_default (), 0, &monitor0);
 651   e->window = g_object_ref (gdk_get_default_root_window ());
 652   e->send_event = TRUE;
 653   e->time = GetTickCount ();
 654   GetCursorPos (&pos);
 655   priv->last_click_x = e->x = pos.x + monitor0.x;
 656   priv->last_click_y = e->y = pos.y + monitor0.y;
 657   e->axes = NULL;
 658   e->state = 0;
 659   e->button = button;
 660   //FIXME: e->device = gdk_display_get_default ()->core_pointer;
 661   e->x_root = e->x;
 662   e->y_root = e->y;
 663 }
 664
 665 typedef struct
 666 {
 667   GtkStatusIcon *status_icon;
 668   GdkEventButton *event;
 669 } ButtonCallbackData;
 670
 671 static gboolean
 672 button_callback (gpointer data)
 673 {
 674   ButtonCallbackData *bc = (ButtonCallbackData *) data;
 675
 676   if (bc->event->type == GDK_BUTTON_PRESS)
 677     gtk_status_icon_button_press (bc->status_icon, bc->event);
 678   else
 679     gtk_status_icon_button_release (bc->status_icon, bc->event);
 680
 681   gdk_event_free ((GdkEvent *) bc->event);
 682   g_free (data);
 683
 684   return G_SOURCE_REMOVE;
 685 }
 686
 687 static UINT taskbar_created_msg = 0;
 688 static GSList *status_icons = NULL;
 689
 690 static LRESULT CALLBACK
 691 wndproc (HWND   hwnd,
 692          UINT   message,
 693          WPARAM wparam,
 694          LPARAM lparam)
 695 {
 696   if (message == taskbar_created_msg)
 697     {
 698       GSList *rover;
 699
 700       for (rover = status_icons; rover != NULL; rover = rover->next)
 701         {
 702           GtkStatusIcon *status_icon = GTK_STATUS_ICON (rover->data);
 703           GtkStatusIconPrivate *priv = status_icon->priv;
 704
 705           priv->nid.hWnd = hwnd;
 706           priv->nid.uID = GPOINTER_TO_UINT (status_icon);
 707           priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
 708           priv->nid.uFlags = NIF_MESSAGE;
 709
 710           if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
 711             {
 712               g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
 713               priv->nid.hWnd = NULL;
 714               continue;
 715             }
 716
 717           gtk_status_icon_update_image (status_icon);
 718         }
 719       return 0;
 720     }
 721
 722   if (message == WM_GTK_TRAY_NOTIFICATION)
 723     {
 724       ButtonCallbackData *bc;
 725       guint button;
 726
 727       switch (lparam)
 728         {
 729         case WM_LBUTTONDOWN:
 730           button = 1;
 731           goto buttondown0;
 732
 733         case WM_MBUTTONDOWN:
 734           button = 2;
 735           goto buttondown0;
 736
 737         case WM_RBUTTONDOWN:
 738           button = 3;
 739           goto buttondown0;
 740
 741         case WM_XBUTTONDOWN:
 742           if (HIWORD (wparam) == XBUTTON1)
 743             button = 4;
 744           else
 745             button = 5;
 746
 747         buttondown0:
 748           bc = g_new (ButtonCallbackData, 1);
 749           bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_PRESS);
 750           bc->status_icon = GTK_STATUS_ICON (wparam);
 751           build_button_event (bc->status_icon->priv, bc->event, button);
 752           g_idle_add (button_callback, bc);
 753           break;
 754
 755         case WM_LBUTTONUP:
 756           button = 1;
 757           goto buttonup0;
 758
 759         case WM_MBUTTONUP:
 760           button = 2;
 761           goto buttonup0;
 762
 763         case WM_RBUTTONUP:
 764           button = 3;
 765           goto buttonup0;
 766
 767         case WM_XBUTTONUP:
 768           if (HIWORD (wparam) == XBUTTON1)
 769             button = 4;
 770           else
 771             button = 5;
 772
 773         buttonup0:
 774           bc = g_new (ButtonCallbackData, 1);
 775           bc->event = (GdkEventButton *) gdk_event_new (GDK_BUTTON_RELEASE);
 776           bc->status_icon = GTK_STATUS_ICON (wparam);
 777           build_button_event (bc->status_icon->priv, bc->event, button);
 778           g_idle_add (button_callback, bc);
 779           break;
 780
 781         default :
 782           break;
 783         }
 784         return 0;
 785     }
 786   else
 787     {
 788       return DefWindowProc (hwnd, message, wparam, lparam);
 789     }
 790 }
 791
 792 static HWND
 793 create_tray_observer (void)
 794 {
 795   WNDCLASS    wclass;
 796   static HWND hwnd = NULL;
 797   ATOM        klass;
 798   HINSTANCE   hmodule = GetModuleHandle (NULL);
 799
 800   if (hwnd)
 801     return hwnd;
 802
 803   taskbar_created_msg = RegisterWindowMessage("TaskbarCreated");
 804
 805   memset (&wclass, 0, sizeof(WNDCLASS));
 806   wclass.lpszClassName = "gtkstatusicon-observer";
 807   wclass.lpfnWndProc   = wndproc;
 808   wclass.hInstance     = hmodule;
 809
 810   klass = RegisterClass (&wclass);
 811   if (!klass)
 812     return NULL;
 813
 814   hwnd = CreateWindow (MAKEINTRESOURCE (klass),
 815                        NULL, WS_POPUP,
 816                        0, 0, 1, 1, NULL, NULL,
 817                        hmodule, NULL);
 818   if (!hwnd)
 819     {
 820       UnregisterClass (MAKEINTRESOURCE(klass), hmodule);
 821       return NULL;
 822     }
 823
 824   return hwnd;
 825 }
 826
 827 #endif
 828
 829 static void
 830 gtk_status_icon_init (GtkStatusIcon *status_icon)
 831 {
 832   GtkStatusIconPrivate *priv;
 833
 834   priv = G_TYPE_INSTANCE_GET_PRIVATE (status_icon, GTK_TYPE_STATUS_ICON,
 835                                       GtkStatusIconPrivate);
 836   status_icon->priv = priv;
 837
 838   priv->icon_helper = _gtk_icon_helper_new ();
 839   priv->visible      = TRUE;
 840
 841 #ifdef GDK_WINDOWING_X11
 842   priv->size         = 0;
 843   priv->tray_icon = GTK_WIDGET (_gtk_tray_icon_new (NULL));
 844
 845   gtk_widget_add_events (GTK_WIDGET (priv->tray_icon),
 846                          GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
 847                          GDK_SCROLL_MASK);
 848
 849   g_signal_connect_swapped (priv->tray_icon, "key-press-event",
 850                             G_CALLBACK (gtk_status_icon_key_press), status_icon);
 851   g_signal_connect_swapped (priv->tray_icon, "popup-menu",
 852                             G_CALLBACK (gtk_status_icon_popup_menu), status_icon);
 853   g_signal_connect_swapped (priv->tray_icon, "notify::embedded",
 854                             G_CALLBACK (gtk_status_icon_embedded_changed), status_icon);
 855   g_signal_connect_swapped (priv->tray_icon, "notify::orientation",
 856                             G_CALLBACK (gtk_status_icon_orientation_changed), status_icon);
 857   g_signal_connect_swapped (priv->tray_icon, "notify::padding",
 858                             G_CALLBACK (gtk_status_icon_padding_changed), status_icon);
 859   g_signal_connect_swapped (priv->tray_icon, "notify::icon-size",
 860                             G_CALLBACK (gtk_status_icon_icon_size_changed), status_icon);
 861   g_signal_connect_swapped (priv->tray_icon, "notify::fg-color",
 862                             G_CALLBACK (gtk_status_icon_fg_changed), status_icon);
 863   g_signal_connect (priv->tray_icon, "notify::error-color",
 864                     G_CALLBACK (gtk_status_icon_color_changed), status_icon);
 865   g_signal_connect (priv->tray_icon, "notify::warning-color",
 866                     G_CALLBACK (gtk_status_icon_color_changed), status_icon);
 867   g_signal_connect (priv->tray_icon, "notify::success-color",
 868                     G_CALLBACK (gtk_status_icon_color_changed), status_icon);
 869   g_signal_connect_swapped (priv->tray_icon, "button-press-event",
 870                             G_CALLBACK (gtk_status_icon_button_press), status_icon);
 871   g_signal_connect_swapped (priv->tray_icon, "button-release-event",
 872                             G_CALLBACK (gtk_status_icon_button_release), status_icon);
 873   g_signal_connect_swapped (priv->tray_icon, "scroll-event",
 874                             G_CALLBACK (gtk_status_icon_scroll), status_icon);
 875   g_signal_connect_swapped (priv->tray_icon, "query-tooltip",
 876                             G_CALLBACK (gtk_status_icon_query_tooltip), status_icon);
 877   g_signal_connect_swapped (priv->tray_icon, "screen-changed",
 878                             G_CALLBACK (gtk_status_icon_screen_changed), status_icon);
 879   priv->image = gtk_image_new ();
 880   gtk_widget_set_can_focus (priv->image, TRUE);
 881   gtk_container_add (GTK_CONTAINER (priv->tray_icon), priv->image);
 882   gtk_widget_show (priv->image);
 883
 884   /* Force-initialize the symbolic colors */
 885   g_object_notify (G_OBJECT (priv->tray_icon), "fg-color");
 886   g_object_notify (G_OBJECT (priv->tray_icon), "error-color");
 887   g_object_notify (G_OBJECT (priv->tray_icon), "warning-color");
 888   g_object_notify (G_OBJECT (priv->tray_icon), "success-color");
 889
 890   g_signal_connect_swapped (priv->image, "size-allocate",
 891                             G_CALLBACK (gtk_status_icon_size_allocate), status_icon);
 892
 893 #else /* !GDK_WINDOWING_X11 */
 894   priv->dummy_widget = gtk_label_new ("");
 895 #endif
 896
 897 #ifdef GDK_WINDOWING_WIN32
 898
 899   /* Get position and orientation of Windows taskbar. */
 900   {
 901     APPBARDATA abd;
 902
 903     abd.cbSize = sizeof (abd);
 904     SHAppBarMessage (ABM_GETTASKBARPOS, &abd);
 905     if (abd.rc.bottom - abd.rc.top > abd.rc.right - abd.rc.left)
 906       priv->orientation = GTK_ORIENTATION_VERTICAL;
 907     else
 908       priv->orientation = GTK_ORIENTATION_HORIZONTAL;
 909
 910     priv->taskbar_top = abd.rc.top;
 911   }
 912
 913   priv->last_click_x = priv->last_click_y = 0;
 914
 915   /* Are the system tray icons always 16 pixels square? */
 916   priv->size         = 16;
 917
 918   memset (&priv->nid, 0, sizeof (priv->nid));
 919
 920   priv->nid.hWnd = create_tray_observer ();
 921   priv->nid.uID = GPOINTER_TO_UINT (status_icon);
 922   priv->nid.uCallbackMessage = WM_GTK_TRAY_NOTIFICATION;
 923   priv->nid.uFlags = NIF_MESSAGE;
 924
 925   /* To help win7 identify the icon create it with an application "unique" tip */
 926   if (g_get_prgname ())
 927   {
 928     WCHAR *wcs = g_utf8_to_utf16 (g_get_prgname (), -1, NULL, NULL, NULL);
 929
 930     priv->nid.uFlags |= NIF_TIP;
 931     wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
 932     priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
 933     g_free (wcs);
 934   }
 935
 936   if (!Shell_NotifyIconW (NIM_ADD, &priv->nid))
 937     {
 938       g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_ADD) failed");
 939       priv->nid.hWnd = NULL;
 940     }
 941
 942   status_icons = g_slist_append (status_icons, status_icon);
 943
 944 #endif
 945
 946 #ifdef GDK_WINDOWING_QUARTZ
 947   QUARTZ_POOL_ALLOC;
 948
 949   priv->status_item = [[GtkQuartzStatusIcon alloc] initWithStatusIcon:status_icon];
 950   priv->size = [priv->status_item getHeight];
 951
 952   QUARTZ_POOL_RELEASE;
 953
 954 #endif
 955 }
 956
 957 static GObject*
 958 gtk_status_icon_constructor (GType                  type,
 959                              guint                  n_construct_properties,
 960                              GObjectConstructParam *construct_params)
 961 {
 962   GObject *object;
 963 #ifdef GDK_WINDOWING_X11
 964   GtkStatusIcon *status_icon;
 965   GtkStatusIconPrivate *priv;
 966 #endif
 967
 968   object = G_OBJECT_CLASS (gtk_status_icon_parent_class)->constructor (type,
 969                                                                        n_construct_properties,
 970                                                                        construct_params);
 971
 972 #ifdef GDK_WINDOWING_X11
 973   status_icon = GTK_STATUS_ICON (object);
 974   priv = status_icon->priv;
 975
 976   if (priv->visible)
 977     gtk_widget_show (priv->tray_icon);
 978 #endif
 979
 980   return object;
 981 }
 982
 983 static void
 984 gtk_status_icon_finalize (GObject *object)
 985 {
 986   GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
 987   GtkStatusIconPrivate *priv = status_icon->priv;
 988
 989   gtk_status_icon_reset_image_data (status_icon);
 990   g_clear_object (&priv->icon_helper);
 991
 992 #ifdef GDK_WINDOWING_X11
 993   g_signal_handlers_disconnect_by_func (priv->tray_icon,
 994                                         gtk_status_icon_key_press, status_icon);
 995   g_signal_handlers_disconnect_by_func (priv->tray_icon,
 996                                         gtk_status_icon_popup_menu, status_icon);
 997   g_signal_handlers_disconnect_by_func (priv->tray_icon,
 998                                         gtk_status_icon_embedded_changed, status_icon);
 999   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1000                                         gtk_status_icon_orientation_changed, status_icon);
1001   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1002                                         gtk_status_icon_padding_changed, status_icon);
1003   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1004                                         gtk_status_icon_icon_size_changed, status_icon);
1005   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1006                                         gtk_status_icon_fg_changed, status_icon);
1007   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1008                                         gtk_status_icon_color_changed, status_icon);
1009   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1010                                         gtk_status_icon_button_press, status_icon);
1011   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1012                                         gtk_status_icon_button_release, status_icon);
1013   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1014                                         gtk_status_icon_scroll, status_icon);
1015   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1016                                         gtk_status_icon_query_tooltip, status_icon);
1017   g_signal_handlers_disconnect_by_func (priv->tray_icon,
1018                                         gtk_status_icon_screen_changed, status_icon);
1019   gtk_widget_destroy (priv->image);
1020   gtk_widget_destroy (priv->tray_icon);
1021 #else /* !GDK_WINDOWING_X11 */
1022   gtk_widget_destroy (priv->dummy_widget);
1023 #endif
1024
1025 #ifdef GDK_WINDOWING_WIN32
1026   if (priv->nid.hWnd != NULL && priv->visible)
1027     Shell_NotifyIconW (NIM_DELETE, &priv->nid);
1028   if (priv->nid.hIcon)
1029     DestroyIcon (priv->nid.hIcon);
1030   g_free (priv->tooltip_text);
1031
1032   status_icons = g_slist_remove (status_icons, status_icon);
1033 #endif
1034
1035 #ifdef GDK_WINDOWING_QUARTZ
1036   QUARTZ_POOL_ALLOC;
1037   [priv->status_item release];
1038   QUARTZ_POOL_RELEASE;
1039   g_free (priv->tooltip_text);
1040 #endif
1041
1042   G_OBJECT_CLASS (gtk_status_icon_parent_class)->finalize (object);
1043 }
1044
1045 static void
1046 gtk_status_icon_set_property (GObject      *object,
1047                               guint         prop_id,
1048                               const GValue *value,
1049                               GParamSpec   *pspec)
1050 {
1051   GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1052
1053   switch (prop_id)
1054     {
1055     case PROP_PIXBUF:
1056       gtk_status_icon_set_from_pixbuf (status_icon, g_value_get_object (value));
1057       break;
1058     case PROP_FILE:
1059       gtk_status_icon_set_from_file (status_icon, g_value_get_string (value));
1060       break;
1061     case PROP_STOCK:
1062       gtk_status_icon_set_from_stock (status_icon, g_value_get_string (value));
1063       break;
1064     case PROP_ICON_NAME:
1065       gtk_status_icon_set_from_icon_name (status_icon, g_value_get_string (value));
1066       break;
1067     case PROP_GICON:
1068       gtk_status_icon_set_from_gicon (status_icon, g_value_get_object (value));
1069       break;
1070     case PROP_SCREEN:
1071       gtk_status_icon_set_screen (status_icon, g_value_get_object (value));
1072       break;
1073     case PROP_VISIBLE:
1074       gtk_status_icon_set_visible (status_icon, g_value_get_boolean (value));
1075       break;
1076     case PROP_HAS_TOOLTIP:
1077       gtk_status_icon_set_has_tooltip (status_icon, g_value_get_boolean (value));
1078       break;
1079     case PROP_TOOLTIP_TEXT:
1080       gtk_status_icon_set_tooltip_text (status_icon, g_value_get_string (value));
1081       break;
1082     case PROP_TOOLTIP_MARKUP:
1083       gtk_status_icon_set_tooltip_markup (status_icon, g_value_get_string (value));
1084       break;
1085     case PROP_TITLE:
1086       gtk_status_icon_set_title (status_icon, g_value_get_string (value));
1087       break;
1088     default:
1089       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1090       break;
1091     }
1092 }
1093
1094 static void
1095 gtk_status_icon_get_property (GObject    *object,
1096                               guint       prop_id,
1097                               GValue     *value,
1098                               GParamSpec *pspec)
1099 {
1100   GtkStatusIcon *status_icon = GTK_STATUS_ICON (object);
1101
1102   switch (prop_id)
1103     {
1104     case PROP_PIXBUF:
1105       g_value_set_object (value, gtk_status_icon_get_pixbuf (status_icon));
1106       break;
1107     case PROP_STOCK:
1108       g_value_set_string (value, gtk_status_icon_get_stock (status_icon));
1109       break;
1110     case PROP_ICON_NAME:
1111       g_value_set_string (value, gtk_status_icon_get_icon_name (status_icon));
1112       break;
1113     case PROP_GICON:
1114       g_value_set_object (value, gtk_status_icon_get_gicon (status_icon));
1115       break;
1116     case PROP_STORAGE_TYPE:
1117       g_value_set_enum (value, gtk_status_icon_get_storage_type (status_icon));
1118       break;
1119     case PROP_SIZE:
1120       g_value_set_int (value, gtk_status_icon_get_size (status_icon));
1121       break;
1122     case PROP_SCREEN:
1123       g_value_set_object (value, gtk_status_icon_get_screen (status_icon));
1124       break;
1125     case PROP_VISIBLE:
1126       g_value_set_boolean (value, gtk_status_icon_get_visible (status_icon));
1127       break;
1128     case PROP_EMBEDDED:
1129       g_value_set_boolean (value, gtk_status_icon_is_embedded (status_icon));
1130       break;
1131     case PROP_ORIENTATION:
1132 #ifdef GDK_WINDOWING_X11
1133       g_value_set_enum (value, _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (status_icon->priv->tray_icon)));
1134 #endif
1135 #ifdef GDK_WINDOWING_WIN32
1136       g_value_set_enum (value, status_icon->priv->orientation);
1137 #endif
1138       break;
1139     case PROP_HAS_TOOLTIP:
1140       g_value_set_boolean (value, gtk_status_icon_get_has_tooltip (status_icon));
1141       break;
1142     case PROP_TOOLTIP_TEXT:
1143       g_value_set_string (value, gtk_status_icon_get_tooltip_text (status_icon));
1144       break;
1145     case PROP_TOOLTIP_MARKUP:
1146       g_value_set_string (value, gtk_status_icon_get_tooltip_markup (status_icon));
1147       break;
1148     case PROP_TITLE:
1149       g_value_set_string (value, gtk_status_icon_get_title (status_icon));
1150       break;
1151     default:
1152       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1153       break;
1154     }
1155 }
1156
1157 /**
1158  * gtk_status_icon_new:
1159  *
1160  * Creates an empty status icon object.
1161  *
1162  * Return value: a new #GtkStatusIcon
1163  *
1164  * Since: 2.10
1165  **/
1166 GtkStatusIcon *
1167 gtk_status_icon_new (void)
1168 {
1169   return g_object_new (GTK_TYPE_STATUS_ICON, NULL);
1170 }
1171
1172 /**
1173  * gtk_status_icon_new_from_pixbuf:
1174  * @pixbuf: a #GdkPixbuf
1175  *
1176  * Creates a status icon displaying @pixbuf.
1177  *
1178  * The image will be scaled down to fit in the available
1179  * space in the notification area, if necessary.
1180  *
1181  * Return value: a new #GtkStatusIcon
1182  *
1183  * Since: 2.10
1184  **/
1185 GtkStatusIcon *
1186 gtk_status_icon_new_from_pixbuf (GdkPixbuf *pixbuf)
1187 {
1188   return g_object_new (GTK_TYPE_STATUS_ICON,
1189                        "pixbuf", pixbuf,
1190                        NULL);
1191 }
1192
1193 /**
1194  * gtk_status_icon_new_from_file:
1195  * @filename: (type filename): a filename
1196  *
1197  * Creates a status icon displaying the file @filename.
1198  *
1199  * The image will be scaled down to fit in the available
1200  * space in the notification area, if necessary.
1201  *
1202  * Return value: a new #GtkStatusIcon
1203  *
1204  * Since: 2.10
1205  **/
1206 GtkStatusIcon *
1207 gtk_status_icon_new_from_file (const gchar *filename)
1208 {
1209   return g_object_new (GTK_TYPE_STATUS_ICON,
1210                        "file", filename,
1211                        NULL);
1212 }
1213
1214 /**
1215  * gtk_status_icon_new_from_stock:
1216  * @stock_id: a stock icon id
1217  *
1218  * Creates a status icon displaying a stock icon. Sample stock icon
1219  * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your
1220  * own stock icon names, see gtk_icon_factory_add_default() and
1221  * gtk_icon_factory_add().
1222  *
1223  * Return value: a new #GtkStatusIcon
1224  *
1225  * Since: 2.10
1226  **/
1227 GtkStatusIcon *
1228 gtk_status_icon_new_from_stock (const gchar *stock_id)
1229 {
1230   return g_object_new (GTK_TYPE_STATUS_ICON,
1231                        "stock", stock_id,
1232                        NULL);
1233 }
1234
1235 /**
1236  * gtk_status_icon_new_from_icon_name:
1237  * @icon_name: an icon name
1238  *
1239  * Creates a status icon displaying an icon from the current icon theme.
1240  * If the current icon theme is changed, the icon will be updated
1241  * appropriately.
1242  *
1243  * Return value: a new #GtkStatusIcon
1244  *
1245  * Since: 2.10
1246  **/
1247 GtkStatusIcon *
1248 gtk_status_icon_new_from_icon_name (const gchar *icon_name)
1249 {
1250   return g_object_new (GTK_TYPE_STATUS_ICON,
1251                        "icon-name", icon_name,
1252                        NULL);
1253 }
1254
1255 /**
1256  * gtk_status_icon_new_from_gicon:
1257  * @icon: a #GIcon
1258  *
1259  * Creates a status icon displaying a #GIcon. If the icon is a
1260  * themed icon, it will be updated when the theme changes.
1261  *
1262  * Return value: a new #GtkStatusIcon
1263  *
1264  * Since: 2.14
1265  **/
1266 GtkStatusIcon *
1267 gtk_status_icon_new_from_gicon (GIcon *icon)
1268 {
1269   return g_object_new (GTK_TYPE_STATUS_ICON,
1270                        "gicon", icon,
1271                        NULL);
1272 }
1273
1274 static void
1275 emit_activate_signal (GtkStatusIcon *status_icon)
1276 {
1277   g_signal_emit (status_icon,
1278                  status_icon_signals [ACTIVATE_SIGNAL], 0);
1279 }
1280
1281 static void
1282 emit_popup_menu_signal (GtkStatusIcon *status_icon,
1283                         guint          button,
1284                         guint32        activate_time)
1285 {
1286   g_signal_emit (status_icon,
1287                  status_icon_signals [POPUP_MENU_SIGNAL], 0,
1288                  button,
1289                  activate_time);
1290 }
1291
1292 #ifdef GDK_WINDOWING_X11
1293
1294 static gboolean
1295 emit_size_changed_signal (GtkStatusIcon *status_icon,
1296                           gint           size)
1297 {
1298   gboolean handled = FALSE;
1299
1300   g_signal_emit (status_icon,
1301                  status_icon_signals [SIZE_CHANGED_SIGNAL], 0,
1302                  size,
1303                  &handled);
1304
1305   return handled;
1306 }
1307
1308 #endif
1309
1310 /* rounds the pixel size to the nearest size avaiable in the theme */
1311 static gint
1312 round_pixel_size (GtkWidget *widget,
1313                   gint       pixel_size)
1314 {
1315   GdkScreen *screen;
1316   GtkSettings *settings;
1317   GtkIconSize s;
1318   gint w, h, d, dist, size;
1319
1320   screen = gtk_widget_get_screen (widget);
1321
1322   if (!screen)
1323     return GTK_ICON_SIZE_MENU;
1324
1325   settings = gtk_settings_get_for_screen (screen);
1326
1327   dist = G_MAXINT;
1328   size = 0;
1329
1330   for (s = GTK_ICON_SIZE_MENU; s <= GTK_ICON_SIZE_DIALOG; s++)
1331     {
1332       if (gtk_icon_size_lookup_for_settings (settings, s, &w, &h))
1333         {
1334           d = MAX (abs (pixel_size - w), abs (pixel_size - h));
1335           if (d < dist)
1336             {
1337               dist = d;
1338               size = MAX (w, h);
1339             }
1340         }
1341     }
1342
1343   return size;
1344 }
1345
1346 static void
1347 gtk_status_icon_update_image (GtkStatusIcon *status_icon)
1348 {
1349   GtkStatusIconPrivate *priv = status_icon->priv;
1350 #ifdef GDK_WINDOWING_WIN32
1351   HICON prev_hicon;
1352 #endif
1353   GtkStyleContext *context;
1354   GtkWidget *widget;
1355   GtkImageType storage_type = _gtk_icon_helper_get_storage_type (priv->icon_helper);
1356   GdkPixbuf *pixbuf;
1357   gint round_size;
1358
1359 #ifdef GDK_WINDOWING_X11
1360   widget = priv->image;
1361 #else
1362   widget = priv->dummy_widget;
1363 #endif
1364
1365   context = gtk_widget_get_style_context (widget);
1366   round_size = round_pixel_size (widget, priv->size);
1367
1368   if (storage_type == GTK_IMAGE_PIXBUF)
1369     {
1370       GdkPixbuf *scaled;
1371       gint width;
1372       gint height;
1373
1374       pixbuf = _gtk_icon_helper_ensure_pixbuf (priv->icon_helper, context);
1375
1376       width  = gdk_pixbuf_get_width  (pixbuf);
1377       height = gdk_pixbuf_get_height (pixbuf);
1378
1379       if (width > round_size || height > round_size)
1380         {
1381           scaled = gdk_pixbuf_scale_simple (pixbuf,
1382                                             MIN (round_size, width),
1383                                             MIN (round_size, height),
1384                                             GDK_INTERP_BILINEAR);
1385           g_object_unref (pixbuf);
1386           pixbuf = scaled;
1387         }
1388     }
1389   else
1390     {
1391       _gtk_icon_helper_set_pixel_size (priv->icon_helper, round_size);
1392       pixbuf = _gtk_icon_helper_ensure_pixbuf (priv->icon_helper, context);
1393     }
1394
1395   if (pixbuf != NULL)
1396     {
1397 #ifdef GDK_WINDOWING_X11
1398       gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), pixbuf);
1399 #endif
1400 #ifdef GDK_WINDOWING_WIN32
1401       prev_hicon = priv->nid.hIcon;
1402       priv->nid.hIcon = gdk_win32_pixbuf_to_hicon_libgtk_only (pixbuf);
1403       priv->nid.uFlags |= NIF_ICON;
1404       if (priv->nid.hWnd != NULL && priv->visible)
1405         if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1406           g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1407       if (prev_hicon)
1408         DestroyIcon (prev_hicon);
1409 #endif
1410 #ifdef GDK_WINDOWING_QUARTZ
1411       QUARTZ_POOL_ALLOC;
1412       [priv->status_item setImage:pixbuf];
1413       QUARTZ_POOL_RELEASE;
1414 #endif
1415     }
1416   else
1417     {
1418 #ifdef GDK_WINDOWING_X11
1419       gtk_image_set_from_pixbuf (GTK_IMAGE (priv->image), NULL);
1420 #endif
1421 #ifdef GDK_WINDOWING_WIN32
1422       priv->nid.uFlags &= ~NIF_ICON;
1423       if (priv->nid.hWnd != NULL && priv->visible)
1424         if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
1425           g_warning (G_STRLOC ": Shell_NotifyIcon(NIM_MODIFY) failed");
1426 #endif
1427 #ifdef GDK_WINDOWING_QUARTZ
1428       [priv->status_item setImage:NULL];
1429 #endif
1430     }
1431
1432   g_clear_object (&pixbuf);
1433 }
1434
1435 #ifdef GDK_WINDOWING_X11
1436
1437 static void
1438 gtk_status_icon_size_allocate (GtkStatusIcon *status_icon,
1439                                GtkAllocation *allocation)
1440 {
1441   GtkStatusIconPrivate *priv = status_icon->priv;
1442   GtkOrientation orientation;
1443   gint size;
1444
1445   orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1446
1447   if (orientation == GTK_ORIENTATION_HORIZONTAL)
1448     size = allocation->height;
1449   else
1450     size = allocation->width;
1451
1452   if (priv->size != size)
1453     {
1454       priv->size = size;
1455
1456       g_object_notify (G_OBJECT (status_icon), "size");
1457
1458       if (!emit_size_changed_signal (status_icon, size))
1459         gtk_status_icon_update_image (status_icon);
1460     }
1461 }
1462
1463 static void
1464 gtk_status_icon_screen_changed (GtkStatusIcon *status_icon,
1465                                 GdkScreen *old_screen)
1466 {
1467   GtkStatusIconPrivate *priv = status_icon->priv;
1468
1469   if (gtk_widget_get_screen (priv->tray_icon) != old_screen)
1470     {
1471       g_object_notify (G_OBJECT (status_icon), "screen");
1472     }
1473 }
1474
1475 #endif
1476
1477 #ifdef GDK_WINDOWING_X11
1478
1479 static void
1480 gtk_status_icon_padding_changed (GtkStatusIcon *status_icon)
1481 {
1482   GtkStatusIconPrivate *priv = status_icon->priv;
1483   GtkOrientation orientation;
1484   gint padding;
1485
1486   orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (priv->tray_icon));
1487   padding = _gtk_tray_icon_get_padding (GTK_TRAY_ICON (priv->tray_icon));
1488
1489   if (orientation == GTK_ORIENTATION_HORIZONTAL)
1490     {
1491       gtk_widget_set_margin_left (priv->image, padding);
1492       gtk_widget_set_margin_right (priv->image, padding);
1493     }
1494   else
1495     {
1496       gtk_widget_set_margin_bottom (priv->image, padding);
1497       gtk_widget_set_margin_top (priv->image, padding);
1498     }
1499 }
1500
1501 static void
1502 gtk_status_icon_icon_size_changed (GtkStatusIcon *status_icon)
1503 {
1504   GtkStatusIconPrivate *priv = status_icon->priv;
1505   gint icon_size;
1506
1507   icon_size = _gtk_tray_icon_get_icon_size (GTK_TRAY_ICON (priv->tray_icon));
1508
1509   if (icon_size != 0)
1510     gtk_image_set_pixel_size (GTK_IMAGE (priv->image), icon_size);
1511   else
1512     gtk_image_set_pixel_size (GTK_IMAGE (priv->image), -1);
1513 }
1514
1515 static void
1516 gtk_status_icon_embedded_changed (GtkStatusIcon *status_icon)
1517 {
1518   gtk_status_icon_padding_changed (status_icon);
1519   gtk_status_icon_icon_size_changed (status_icon);
1520   g_object_notify (G_OBJECT (status_icon), "embedded");
1521 }
1522
1523 static void
1524 gtk_status_icon_orientation_changed (GtkStatusIcon *status_icon)
1525 {
1526   gtk_status_icon_padding_changed (status_icon);
1527   g_object_notify (G_OBJECT (status_icon), "orientation");
1528 }
1529
1530 static void
1531 gtk_status_icon_fg_changed (GtkStatusIcon *status_icon)
1532 {
1533   GtkStatusIconPrivate *priv = status_icon->priv;
1534   GdkRGBA *rgba;
1535
1536   g_object_get (priv->tray_icon, "fg-color", &rgba, NULL);
1537
1538   gtk_widget_override_color (priv->image, GTK_STATE_FLAG_NORMAL, rgba);
1539
1540   gdk_rgba_free (rgba);
1541 }
1542
1543 static void
1544 gtk_status_icon_color_changed (GtkTrayIcon   *tray,
1545                                GParamSpec    *pspec,
1546                                GtkStatusIcon *status_icon)
1547 {
1548   GtkStatusIconPrivate *priv = status_icon->priv;
1549   const gchar *name;
1550
1551   switch (pspec->name[0])
1552     {
1553     case 'e':
1554       name = "error";
1555       break;
1556     case 'w':
1557       name = "warning";
1558       break;
1559     case 's':
1560       name = "success";
1561       break;
1562     default:
1563       name = NULL;
1564       break;
1565     }
1566
1567   if (name)
1568     {
1569       GdkRGBA rgba;
1570
1571       g_object_get (priv->tray_icon, pspec->name, &rgba, NULL);
1572
1573       rgba.alpha = 1;
1574
1575       gtk_widget_override_symbolic_color (priv->image, name, &rgba);
1576     }
1577 }
1578
1579 static gboolean
1580 gtk_status_icon_key_press (GtkStatusIcon  *status_icon,
1581                            GdkEventKey    *event)
1582 {
1583   guint state, keyval;
1584
1585   state = event->state & gtk_accelerator_get_default_mod_mask ();
1586   keyval = event->keyval;
1587   if (state == 0 &&
1588       (keyval == GDK_KEY_Return ||
1589        keyval == GDK_KEY_KP_Enter ||
1590        keyval == GDK_KEY_ISO_Enter ||
1591        keyval == GDK_KEY_space ||
1592        keyval == GDK_KEY_KP_Space))
1593     {
1594       emit_activate_signal (status_icon);
1595       return TRUE;
1596     }
1597
1598   return FALSE;
1599 }
1600
1601 static void
1602 gtk_status_icon_popup_menu (GtkStatusIcon  *status_icon)
1603 {
1604   emit_popup_menu_signal (status_icon, 0, gtk_get_current_event_time ());
1605 }
1606
1607 #endif
1608
1609 static gboolean
1610 gtk_status_icon_button_press (GtkStatusIcon  *status_icon,
1611                               GdkEventButton *event)
1612 {
1613   gboolean handled = FALSE;
1614
1615   g_signal_emit (status_icon,
1616                  status_icon_signals [BUTTON_PRESS_EVENT_SIGNAL], 0,
1617                  event, &handled);
1618   if (handled)
1619     return TRUE;
1620
1621   if (gdk_event_triggers_context_menu ((GdkEvent *) event))
1622     {
1623       emit_popup_menu_signal (status_icon, event->button, event->time);
1624       return TRUE;
1625     }
1626   else if (event->button == GDK_BUTTON_PRIMARY && event->type == GDK_BUTTON_PRESS)
1627     {
1628       emit_activate_signal (status_icon);
1629       return TRUE;
1630     }
1631
1632   return FALSE;
1633 }
1634
1635 static gboolean
1636 gtk_status_icon_button_release (GtkStatusIcon  *status_icon,
1637                                 GdkEventButton *event)
1638 {
1639   gboolean handled = FALSE;
1640   g_signal_emit (status_icon,
1641                  status_icon_signals [BUTTON_RELEASE_EVENT_SIGNAL], 0,
1642                  event, &handled);
1643   return handled;
1644 }
1645
1646 #ifdef GDK_WINDOWING_X11
1647 static gboolean
1648 gtk_status_icon_scroll (GtkStatusIcon  *status_icon,
1649                         GdkEventScroll *event)
1650 {
1651   gboolean handled = FALSE;
1652   g_signal_emit (status_icon,
1653                  status_icon_signals [SCROLL_EVENT_SIGNAL], 0,
1654                  event, &handled);
1655   return handled;
1656 }
1657
1658 static gboolean
1659 gtk_status_icon_query_tooltip (GtkStatusIcon *status_icon,
1660                                gint           x,
1661                                gint           y,
1662                                gboolean       keyboard_tip,
1663                                GtkTooltip    *tooltip)
1664 {
1665   gboolean handled = FALSE;
1666   g_signal_emit (status_icon,
1667                  status_icon_signals [QUERY_TOOLTIP_SIGNAL], 0,
1668                  x, y, keyboard_tip, tooltip, &handled);
1669   return handled;
1670 }
1671 #endif /* GDK_WINDOWING_X11 */
1672
1673 static void
1674 gtk_status_icon_reset_image_data (GtkStatusIcon *status_icon)
1675 {
1676   GtkStatusIconPrivate *priv = status_icon->priv;
1677   GtkImageType storage_type = _gtk_icon_helper_get_storage_type (priv->icon_helper);
1678
1679   switch (storage_type)
1680   {
1681     case GTK_IMAGE_PIXBUF:
1682       g_object_notify (G_OBJECT (status_icon), "pixbuf");
1683       break;
1684     case GTK_IMAGE_STOCK:
1685       g_object_notify (G_OBJECT (status_icon), "stock");
1686       break;
1687     case GTK_IMAGE_ICON_NAME:
1688       g_object_notify (G_OBJECT (status_icon), "icon-name");
1689       break;
1690     case GTK_IMAGE_GICON:
1691       g_object_notify (G_OBJECT (status_icon), "gicon");
1692       break;
1693     case GTK_IMAGE_EMPTY:
1694       break;
1695     default:
1696       g_assert_not_reached ();
1697       break;
1698   }
1699
1700   _gtk_icon_helper_clear (priv->icon_helper);
1701   g_object_notify (G_OBJECT (status_icon), "storage-type");
1702 }
1703
1704 static void
1705 gtk_status_icon_set_image (GtkStatusIcon *status_icon,
1706                            GtkImageType   storage_type,
1707                            gpointer       data)
1708 {
1709   GtkStatusIconPrivate *priv = status_icon->priv;
1710
1711   g_object_freeze_notify (G_OBJECT (status_icon));
1712
1713   gtk_status_icon_reset_image_data (status_icon);
1714
1715   g_object_notify (G_OBJECT (status_icon), "storage-type");
1716
1717   /* the icon size we pass here doesn't really matter, since
1718    * we force a pixel size before doing the actual rendering anyway.
1719    */
1720   switch (storage_type)
1721     {
1722     case GTK_IMAGE_PIXBUF:
1723       _gtk_icon_helper_set_pixbuf (priv->icon_helper, data);
1724       g_object_notify (G_OBJECT (status_icon), "pixbuf");
1725       break;
1726     case GTK_IMAGE_STOCK:
1727       _gtk_icon_helper_set_stock_id (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1728       g_object_notify (G_OBJECT (status_icon), "stock");
1729       break;
1730     case GTK_IMAGE_ICON_NAME:
1731       _gtk_icon_helper_set_icon_name (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1732       g_object_notify (G_OBJECT (status_icon), "icon-name");
1733       break;
1734     case GTK_IMAGE_GICON:
1735       _gtk_icon_helper_set_gicon (priv->icon_helper, data, GTK_ICON_SIZE_SMALL_TOOLBAR);
1736       g_object_notify (G_OBJECT (status_icon), "gicon");
1737       break;
1738     default:
1739       g_warning ("Image type %u not handled by GtkStatusIcon", storage_type);
1740     }
1741
1742   g_object_thaw_notify (G_OBJECT (status_icon));
1743
1744   gtk_status_icon_update_image (status_icon);
1745 }
1746
1747 /**
1748  * gtk_status_icon_set_from_pixbuf:
1749  * @status_icon: a #GtkStatusIcon
1750  * @pixbuf: (allow-none): a #GdkPixbuf or %NULL
1751  *
1752  * Makes @status_icon display @pixbuf.
1753  * See gtk_status_icon_new_from_pixbuf() for details.
1754  *
1755  * Since: 2.10
1756  **/
1757 void
1758 gtk_status_icon_set_from_pixbuf (GtkStatusIcon *status_icon,
1759                                  GdkPixbuf     *pixbuf)
1760 {
1761   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1762   g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
1763
1764   gtk_status_icon_set_image (status_icon, GTK_IMAGE_PIXBUF,
1765                              (gpointer) pixbuf);
1766 }
1767
1768 /**
1769  * gtk_status_icon_set_from_file:
1770  * @status_icon: a #GtkStatusIcon
1771  * @filename: (type filename): a filename
1772  *
1773  * Makes @status_icon display the file @filename.
1774  * See gtk_status_icon_new_from_file() for details.
1775  *
1776  * Since: 2.10
1777  **/
1778 void
1779 gtk_status_icon_set_from_file (GtkStatusIcon *status_icon,
1780                                const gchar   *filename)
1781 {
1782   GdkPixbuf *pixbuf;
1783
1784   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1785   g_return_if_fail (filename != NULL);
1786
1787   pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
1788
1789   gtk_status_icon_set_from_pixbuf (status_icon, pixbuf);
1790
1791   if (pixbuf)
1792     g_object_unref (pixbuf);
1793 }
1794
1795 /**
1796  * gtk_status_icon_set_from_stock:
1797  * @status_icon: a #GtkStatusIcon
1798  * @stock_id: a stock icon id
1799  *
1800  * Makes @status_icon display the stock icon with the id @stock_id.
1801  * See gtk_status_icon_new_from_stock() for details.
1802  *
1803  * Since: 2.10
1804  **/
1805 void
1806 gtk_status_icon_set_from_stock (GtkStatusIcon *status_icon,
1807                                 const gchar   *stock_id)
1808 {
1809   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1810   g_return_if_fail (stock_id != NULL);
1811
1812   gtk_status_icon_set_image (status_icon, GTK_IMAGE_STOCK,
1813                              (gpointer) stock_id);
1814 }
1815
1816 /**
1817  * gtk_status_icon_set_from_icon_name:
1818  * @status_icon: a #GtkStatusIcon
1819  * @icon_name: an icon name
1820  *
1821  * Makes @status_icon display the icon named @icon_name from the
1822  * current icon theme.
1823  * See gtk_status_icon_new_from_icon_name() for details.
1824  *
1825  * Since: 2.10
1826  **/
1827 void
1828 gtk_status_icon_set_from_icon_name (GtkStatusIcon *status_icon,
1829                                     const gchar   *icon_name)
1830 {
1831   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1832   g_return_if_fail (icon_name != NULL);
1833
1834   gtk_status_icon_set_image (status_icon, GTK_IMAGE_ICON_NAME,
1835                              (gpointer) icon_name);
1836 }
1837
1838 /**
1839  * gtk_status_icon_set_from_gicon:
1840  * @status_icon: a #GtkStatusIcon
1841  * @icon: a GIcon
1842  *
1843  * Makes @status_icon display the #GIcon.
1844  * See gtk_status_icon_new_from_gicon() for details.
1845  *
1846  * Since: 2.14
1847  **/
1848 void
1849 gtk_status_icon_set_from_gicon (GtkStatusIcon *status_icon,
1850                                 GIcon         *icon)
1851 {
1852   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
1853   g_return_if_fail (icon != NULL);
1854
1855   gtk_status_icon_set_image (status_icon, GTK_IMAGE_GICON,
1856                              (gpointer) icon);
1857 }
1858
1859 /**
1860  * gtk_status_icon_get_storage_type:
1861  * @status_icon: a #GtkStatusIcon
1862  *
1863  * Gets the type of representation being used by the #GtkStatusIcon
1864  * to store image data. If the #GtkStatusIcon has no image data,
1865  * the return value will be %GTK_IMAGE_EMPTY.
1866  *
1867  * Return value: the image representation being used
1868  *
1869  * Since: 2.10
1870  **/
1871 GtkImageType
1872 gtk_status_icon_get_storage_type (GtkStatusIcon *status_icon)
1873 {
1874   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), GTK_IMAGE_EMPTY);
1875
1876   return _gtk_icon_helper_get_storage_type (status_icon->priv->icon_helper);
1877 }
1878 /**
1879  * gtk_status_icon_get_pixbuf:
1880  * @status_icon: a #GtkStatusIcon
1881  *
1882  * Gets the #GdkPixbuf being displayed by the #GtkStatusIcon.
1883  * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1884  * %GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()).
1885  * The caller of this function does not own a reference to the
1886  * returned pixbuf.
1887  *
1888  * Return value: (transfer none): the displayed pixbuf,
1889  *     or %NULL if the image is empty.
1890  *
1891  * Since: 2.10
1892  **/
1893 GdkPixbuf *
1894 gtk_status_icon_get_pixbuf (GtkStatusIcon *status_icon)
1895 {
1896   GtkStatusIconPrivate *priv;
1897
1898   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1899
1900   priv = status_icon->priv;
1901
1902   return _gtk_icon_helper_peek_pixbuf (priv->icon_helper);
1903 }
1904
1905 /**
1906  * gtk_status_icon_get_stock:
1907  * @status_icon: a #GtkStatusIcon
1908  *
1909  * Gets the id of the stock icon being displayed by the #GtkStatusIcon.
1910  * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1911  * %GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()).
1912  * The returned string is owned by the #GtkStatusIcon and should not
1913  * be freed or modified.
1914  *
1915  * Return value: stock id of the displayed stock icon,
1916  *   or %NULL if the image is empty.
1917  *
1918  * Since: 2.10
1919  **/
1920 const gchar *
1921 gtk_status_icon_get_stock (GtkStatusIcon *status_icon)
1922 {
1923   GtkStatusIconPrivate *priv;
1924
1925   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1926
1927   priv = status_icon->priv;
1928
1929   return _gtk_icon_helper_get_stock_id (priv->icon_helper);
1930 }
1931
1932 /**
1933  * gtk_status_icon_get_icon_name:
1934  * @status_icon: a #GtkStatusIcon
1935  *
1936  * Gets the name of the icon being displayed by the #GtkStatusIcon.
1937  * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1938  * %GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()).
1939  * The returned string is owned by the #GtkStatusIcon and should not
1940  * be freed or modified.
1941  *
1942  * Return value: name of the displayed icon, or %NULL if the image is empty.
1943  *
1944  * Since: 2.10
1945  **/
1946 const gchar *
1947 gtk_status_icon_get_icon_name (GtkStatusIcon *status_icon)
1948 {
1949   GtkStatusIconPrivate *priv;
1950
1951   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1952
1953   priv = status_icon->priv;
1954
1955   return _gtk_icon_helper_get_icon_name (priv->icon_helper);
1956 }
1957
1958 /**
1959  * gtk_status_icon_get_gicon:
1960  * @status_icon: a #GtkStatusIcon
1961  *
1962  * Retrieves the #GIcon being displayed by the #GtkStatusIcon.
1963  * The storage type of the status icon must be %GTK_IMAGE_EMPTY or
1964  * %GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()).
1965  * The caller of this function does not own a reference to the
1966  * returned #GIcon.
1967  *
1968  * If this function fails, @icon is left unchanged;
1969  *
1970  * Returns: (transfer none): the displayed icon, or %NULL if the image is empty
1971  *
1972  * Since: 2.14
1973  **/
1974 GIcon *
1975 gtk_status_icon_get_gicon (GtkStatusIcon *status_icon)
1976 {
1977   GtkStatusIconPrivate *priv;
1978
1979   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
1980
1981   priv = status_icon->priv;
1982
1983   return _gtk_icon_helper_peek_gicon (priv->icon_helper);
1984 }
1985
1986 /**
1987  * gtk_status_icon_get_size:
1988  * @status_icon: a #GtkStatusIcon
1989  *
1990  * Gets the size in pixels that is available for the image.
1991  * Stock icons and named icons adapt their size automatically
1992  * if the size of the notification area changes. For other
1993  * storage types, the size-changed signal can be used to
1994  * react to size changes.
1995  *
1996  * Note that the returned size is only meaningful while the
1997  * status icon is embedded (see gtk_status_icon_is_embedded()).
1998  *
1999  * Return value: the size that is available for the image
2000  *
2001  * Since: 2.10
2002  **/
2003 gint
2004 gtk_status_icon_get_size (GtkStatusIcon *status_icon)
2005 {
2006   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), 0);
2007
2008   return status_icon->priv->size;
2009 }
2010
2011 /**
2012  * gtk_status_icon_set_screen:
2013  * @status_icon: a #GtkStatusIcon
2014  * @screen: a #GdkScreen
2015  *
2016  * Sets the #GdkScreen where @status_icon is displayed; if
2017  * the icon is already mapped, it will be unmapped, and
2018  * then remapped on the new screen.
2019  *
2020  * Since: 2.12
2021  */
2022 void
2023 gtk_status_icon_set_screen (GtkStatusIcon *status_icon,
2024                             GdkScreen     *screen)
2025 {
2026   g_return_if_fail (GDK_IS_SCREEN (screen));
2027
2028 #ifdef GDK_WINDOWING_X11
2029   gtk_window_set_screen (GTK_WINDOW (status_icon->priv->tray_icon), screen);
2030 #endif
2031 }
2032
2033 /**
2034  * gtk_status_icon_get_screen:
2035  * @status_icon: a #GtkStatusIcon
2036  *
2037  * Returns the #GdkScreen associated with @status_icon.
2038  *
2039  * Return value: (transfer none): a #GdkScreen.
2040  *
2041  * Since: 2.12
2042  */
2043 GdkScreen *
2044 gtk_status_icon_get_screen (GtkStatusIcon *status_icon)
2045 {
2046   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2047
2048 #ifdef GDK_WINDOWING_X11
2049   return gtk_window_get_screen (GTK_WINDOW (status_icon->priv->tray_icon));
2050 #else
2051   return gdk_screen_get_default ();
2052 #endif
2053 }
2054
2055 /**
2056  * gtk_status_icon_set_visible:
2057  * @status_icon: a #GtkStatusIcon
2058  * @visible: %TRUE to show the status icon, %FALSE to hide it
2059  *
2060  * Shows or hides a status icon.
2061  *
2062  * Since: 2.10
2063  **/
2064 void
2065 gtk_status_icon_set_visible (GtkStatusIcon *status_icon,
2066                              gboolean       visible)
2067 {
2068   GtkStatusIconPrivate *priv;
2069
2070   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2071
2072   priv = status_icon->priv;
2073
2074   visible = visible != FALSE;
2075
2076   if (priv->visible != visible)
2077     {
2078       priv->visible = visible;
2079
2080 #ifdef GDK_WINDOWING_X11
2081       if (visible)
2082         gtk_widget_show (priv->tray_icon);
2083       else if (gtk_widget_get_realized (priv->tray_icon))
2084         {
2085           gtk_widget_hide (priv->tray_icon);
2086           gtk_widget_unrealize (priv->tray_icon);
2087         }
2088 #endif
2089 #ifdef GDK_WINDOWING_WIN32
2090       if (priv->nid.hWnd != NULL)
2091         {
2092           if (visible)
2093             Shell_NotifyIconW (NIM_ADD, &priv->nid);
2094           else
2095             Shell_NotifyIconW (NIM_DELETE, &priv->nid);
2096         }
2097 #endif
2098 #ifdef GDK_WINDOWING_QUARTZ
2099       QUARTZ_POOL_ALLOC;
2100       [priv->status_item setVisible:visible];
2101       QUARTZ_POOL_RELEASE;
2102 #endif
2103       g_object_notify (G_OBJECT (status_icon), "visible");
2104     }
2105 }
2106
2107 /**
2108  * gtk_status_icon_get_visible:
2109  * @status_icon: a #GtkStatusIcon
2110  *
2111  * Returns whether the status icon is visible or not.
2112  * Note that being visible does not guarantee that
2113  * the user can actually see the icon, see also
2114  * gtk_status_icon_is_embedded().
2115  *
2116  * Return value: %TRUE if the status icon is visible
2117  *
2118  * Since: 2.10
2119  **/
2120 gboolean
2121 gtk_status_icon_get_visible (GtkStatusIcon *status_icon)
2122 {
2123   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2124
2125   return status_icon->priv->visible;
2126 }
2127
2128 /**
2129  * gtk_status_icon_is_embedded:
2130  * @status_icon: a #GtkStatusIcon
2131  *
2132  * Returns whether the status icon is embedded in a notification
2133  * area.
2134  *
2135  * Return value: %TRUE if the status icon is embedded in
2136  *   a notification area.
2137  *
2138  * Since: 2.10
2139  **/
2140 gboolean
2141 gtk_status_icon_is_embedded (GtkStatusIcon *status_icon)
2142 {
2143 #ifdef GDK_WINDOWING_X11
2144   GtkPlug *plug;
2145 #endif
2146
2147   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2148
2149 #ifdef GDK_WINDOWING_X11
2150   plug = GTK_PLUG (status_icon->priv->tray_icon);
2151
2152   if (gtk_plug_get_embedded (plug))
2153     return TRUE;
2154   else
2155     return FALSE;
2156 #endif
2157 #ifdef GDK_WINDOWING_WIN32
2158   return TRUE;
2159 #endif
2160 #ifdef GDK_WINDOWING_QUARTZ
2161   return TRUE;
2162 #endif
2163 }
2164
2165 /**
2166  * gtk_status_icon_position_menu:
2167  * @menu: the #GtkMenu
2168  * @x: (out): return location for the x position
2169  * @y: (out): return location for the y position
2170  * @push_in: (out): whether the first menu item should be offset
2171  *           (pushed in) to be aligned with the menu popup position
2172  *           (only useful for GtkOptionMenu).
2173  * @user_data: (type GtkStatusIcon): the status icon to position the menu on
2174  *
2175  * Menu positioning function to use with gtk_menu_popup()
2176  * to position @menu aligned to the status icon @user_data.
2177  *
2178  * Since: 2.10
2179  **/
2180 void
2181 gtk_status_icon_position_menu (GtkMenu  *menu,
2182                                gint     *x,
2183                                gint     *y,
2184                                gboolean *push_in,
2185                                gpointer  user_data)
2186 {
2187 #ifdef GDK_WINDOWING_X11
2188   GtkAllocation allocation;
2189   GtkStatusIcon *status_icon;
2190   GtkStatusIconPrivate *priv;
2191   GtkTrayIcon *tray_icon;
2192   GtkWidget *widget;
2193   GdkScreen *screen;
2194   GtkTextDirection direction;
2195   GtkRequisition menu_req;
2196   GdkRectangle monitor;
2197   GdkWindow *window;
2198   gint monitor_num, height, width, xoffset, yoffset;
2199
2200   g_return_if_fail (GTK_IS_MENU (menu));
2201   g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2202
2203   status_icon = GTK_STATUS_ICON (user_data);
2204   priv = status_icon->priv;
2205   tray_icon = GTK_TRAY_ICON (priv->tray_icon);
2206   widget = priv->tray_icon;
2207
2208   direction = gtk_widget_get_direction (widget);
2209
2210   screen = gtk_widget_get_screen (widget);
2211   gtk_menu_set_screen (menu, screen);
2212
2213   window = gtk_widget_get_window (widget);
2214   monitor_num = gdk_screen_get_monitor_at_window (screen, window);
2215   if (monitor_num < 0)
2216     monitor_num = 0;
2217   gtk_menu_set_monitor (menu, monitor_num);
2218
2219   gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
2220
2221   gdk_window_get_origin (window, x, y);
2222
2223   menu_req.width = gtk_widget_get_allocated_width (GTK_WIDGET (menu));
2224   menu_req.height = gtk_widget_get_allocated_height (GTK_WIDGET (menu));
2225
2226   gtk_widget_get_allocation (widget, &allocation);
2227   if (_gtk_tray_icon_get_orientation (tray_icon) == GTK_ORIENTATION_VERTICAL)
2228     {
2229       width = 0;
2230       height = allocation.height;
2231       xoffset = allocation.width;
2232       yoffset = 0;
2233     }
2234   else
2235     {
2236       width = allocation.width;
2237       height = 0;
2238       xoffset = 0;
2239       yoffset = allocation.height;
2240     }
2241
2242   if (direction == GTK_TEXT_DIR_RTL)
2243     {
2244       if ((*x - (menu_req.width - width)) >= monitor.x)
2245         *x -= menu_req.width - width;
2246       else if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2247         *x += xoffset;
2248       else if ((monitor.x + monitor.width - (*x + xoffset)) < *x)
2249         *x -= menu_req.width - width;
2250       else
2251         *x += xoffset;
2252     }
2253   else
2254     {
2255       if ((*x + xoffset + menu_req.width) < (monitor.x + monitor.width))
2256         *x += xoffset;
2257       else if ((*x - (menu_req.width - width)) >= monitor.x)
2258         *x -= menu_req.width - width;
2259       else if ((monitor.x + monitor.width - (*x + xoffset)) > *x)
2260         *x += xoffset;
2261       else
2262         *x -= menu_req.width - width;
2263     }
2264
2265   if ((*y + yoffset + menu_req.height) < (monitor.y + monitor.height))
2266     *y += yoffset;
2267   else if ((*y - (menu_req.height - height)) >= monitor.y)
2268     *y -= menu_req.height - height;
2269   else if (monitor.y + monitor.height - (*y + yoffset) > *y)
2270     *y += yoffset;
2271   else
2272     *y -= menu_req.height - height;
2273
2274   *push_in = FALSE;
2275 #endif /* GDK_WINDOWING_X11 */
2276
2277 #ifdef GDK_WINDOWING_WIN32
2278   GtkStatusIcon *status_icon;
2279   GtkStatusIconPrivate *priv;
2280   GtkRequisition menu_req;
2281
2282   g_return_if_fail (GTK_IS_MENU (menu));
2283   g_return_if_fail (GTK_IS_STATUS_ICON (user_data));
2284
2285   status_icon = GTK_STATUS_ICON (user_data);
2286   priv = status_icon->priv;
2287
2288   gtk_widget_size_request (GTK_WIDGET (menu), &menu_req);
2289
2290   *x = priv->last_click_x;
2291   *y = priv->taskbar_top - menu_req.height;
2292
2293   *push_in = TRUE;
2294 #endif
2295 }
2296
2297 /**
2298  * gtk_status_icon_get_geometry:
2299  * @status_icon: a #GtkStatusIcon
2300  * @screen: (out) (transfer none) (allow-none): return location for
2301  *          the screen, or %NULL if the information is not needed
2302  * @area: (out) (allow-none): return location for the area occupied by
2303  *        the status icon, or %NULL
2304  * @orientation: (out) (allow-none): return location for the
2305  *    orientation of the panel in which the status icon is embedded,
2306  *    or %NULL. A panel at the top or bottom of the screen is
2307  *    horizontal, a panel at the left or right is vertical.
2308  *
2309  * Obtains information about the location of the status icon
2310  * on screen. This information can be used to e.g. position
2311  * popups like notification bubbles.
2312  *
2313  * See gtk_status_icon_position_menu() for a more convenient
2314  * alternative for positioning menus.
2315  *
2316  * Note that some platforms do not allow GTK+ to provide
2317  * this information, and even on platforms that do allow it,
2318  * the information is not reliable unless the status icon
2319  * is embedded in a notification area, see
2320  * gtk_status_icon_is_embedded().
2321  *
2322  * Return value: %TRUE if the location information has
2323  *               been filled in
2324  *
2325  * Since: 2.10
2326  */
2327 gboolean
2328 gtk_status_icon_get_geometry (GtkStatusIcon    *status_icon,
2329                               GdkScreen       **screen,
2330                               GdkRectangle     *area,
2331                               GtkOrientation   *orientation)
2332 {
2333 #ifdef GDK_WINDOWING_X11
2334   GtkAllocation allocation;
2335   GtkWidget *widget;
2336   GtkStatusIconPrivate *priv;
2337   gint x, y;
2338
2339   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2340
2341   priv = status_icon->priv;
2342   widget = priv->tray_icon;
2343
2344   if (screen)
2345     *screen = gtk_widget_get_screen (widget);
2346
2347   if (area)
2348     {
2349       gdk_window_get_origin (gtk_widget_get_window (widget),
2350                              &x, &y);
2351
2352       gtk_widget_get_allocation (widget, &allocation);
2353       area->x = x;
2354       area->y = y;
2355       area->width = allocation.width;
2356       area->height = allocation.height;
2357     }
2358
2359   if (orientation)
2360     *orientation = _gtk_tray_icon_get_orientation (GTK_TRAY_ICON (widget));
2361
2362   return TRUE;
2363 #else
2364   return FALSE;
2365 #endif /* GDK_WINDOWING_X11 */
2366 }
2367
2368 /**
2369  * gtk_status_icon_set_has_tooltip:
2370  * @status_icon: a #GtkStatusIcon
2371  * @has_tooltip: whether or not @status_icon has a tooltip
2372  *
2373  * Sets the has-tooltip property on @status_icon to @has_tooltip.
2374  * See #GtkStatusIcon:has-tooltip for more information.
2375  *
2376  * Since: 2.16
2377  */
2378 void
2379 gtk_status_icon_set_has_tooltip (GtkStatusIcon *status_icon,
2380                                  gboolean       has_tooltip)
2381 {
2382   GtkStatusIconPrivate *priv;
2383
2384   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2385
2386   priv = status_icon->priv;
2387
2388 #ifdef GDK_WINDOWING_X11
2389   gtk_widget_set_has_tooltip (priv->tray_icon, has_tooltip);
2390 #endif
2391 #ifdef GDK_WINDOWING_WIN32
2392   if (!has_tooltip && priv->tooltip_text)
2393     gtk_status_icon_set_tooltip_text (status_icon, NULL);
2394 #endif
2395 #ifdef GDK_WINDOWING_QUARTZ
2396   if (!has_tooltip && priv->tooltip_text)
2397     gtk_status_icon_set_tooltip_text (status_icon, NULL);
2398 #endif
2399 }
2400
2401 /**
2402  * gtk_status_icon_get_has_tooltip:
2403  * @status_icon: a #GtkStatusIcon
2404  *
2405  * Returns the current value of the has-tooltip property.
2406  * See #GtkStatusIcon:has-tooltip for more information.
2407  *
2408  * Return value: current value of has-tooltip on @status_icon.
2409  *
2410  * Since: 2.16
2411  */
2412 gboolean
2413 gtk_status_icon_get_has_tooltip (GtkStatusIcon *status_icon)
2414 {
2415   GtkStatusIconPrivate *priv;
2416   gboolean has_tooltip = FALSE;
2417
2418   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), FALSE);
2419
2420   priv = status_icon->priv;
2421
2422 #ifdef GDK_WINDOWING_X11
2423   has_tooltip = gtk_widget_get_has_tooltip (priv->tray_icon);
2424 #endif
2425 #ifdef GDK_WINDOWING_WIN32
2426   has_tooltip = (priv->tooltip_text != NULL);
2427 #endif
2428 #ifdef GDK_WINDOWING_QUARTZ
2429   has_tooltip = (priv->tooltip_text != NULL);
2430 #endif
2431
2432   return has_tooltip;
2433 }
2434
2435 /**
2436  * gtk_status_icon_set_tooltip_text:
2437  * @status_icon: a #GtkStatusIcon
2438  * @text: the contents of the tooltip for @status_icon
2439  *
2440  * Sets @text as the contents of the tooltip.
2441  *
2442  * This function will take care of setting #GtkStatusIcon:has-tooltip to
2443  * %TRUE and of the default handler for the #GtkStatusIcon::query-tooltip
2444  * signal.
2445  *
2446  * See also the #GtkStatusIcon:tooltip-text property and
2447  * gtk_tooltip_set_text().
2448  *
2449  * Since: 2.16
2450  */
2451 void
2452 gtk_status_icon_set_tooltip_text (GtkStatusIcon *status_icon,
2453                                   const gchar   *text)
2454 {
2455   GtkStatusIconPrivate *priv;
2456
2457   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2458
2459   priv = status_icon->priv;
2460
2461 #ifdef GDK_WINDOWING_X11
2462
2463   gtk_widget_set_tooltip_text (priv->tray_icon, text);
2464
2465 #endif
2466 #ifdef GDK_WINDOWING_WIN32
2467   if (text == NULL)
2468     priv->nid.uFlags &= ~NIF_TIP;
2469   else
2470     {
2471       WCHAR *wcs = g_utf8_to_utf16 (text, -1, NULL, NULL, NULL);
2472
2473       priv->nid.uFlags |= NIF_TIP;
2474       wcsncpy (priv->nid.szTip, wcs, G_N_ELEMENTS (priv->nid.szTip) - 1);
2475       priv->nid.szTip[G_N_ELEMENTS (priv->nid.szTip) - 1] = 0;
2476       g_free (wcs);
2477     }
2478   if (priv->nid.hWnd != NULL && priv->visible)
2479     if (!Shell_NotifyIconW (NIM_MODIFY, &priv->nid))
2480       g_warning (G_STRLOC ": Shell_NotifyIconW(NIM_MODIFY) failed");
2481
2482   g_free (priv->tooltip_text);
2483   priv->tooltip_text = g_strdup (text);
2484 #endif
2485 #ifdef GDK_WINDOWING_QUARTZ
2486   QUARTZ_POOL_ALLOC;
2487   [priv->status_item setToolTip:text];
2488   QUARTZ_POOL_RELEASE;
2489
2490   g_free (priv->tooltip_text);
2491   priv->tooltip_text = g_strdup (text);
2492 #endif
2493 }
2494
2495 /**
2496  * gtk_status_icon_get_tooltip_text:
2497  * @status_icon: a #GtkStatusIcon
2498  *
2499  * Gets the contents of the tooltip for @status_icon.
2500  *
2501  * Return value: the tooltip text, or %NULL. You should free the
2502  *   returned string with g_free() when done.
2503  *
2504  * Since: 2.16
2505  */
2506 gchar *
2507 gtk_status_icon_get_tooltip_text (GtkStatusIcon *status_icon)
2508 {
2509   GtkStatusIconPrivate *priv;
2510   gchar *tooltip_text = NULL;
2511
2512   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2513
2514   priv = status_icon->priv;
2515
2516 #ifdef GDK_WINDOWING_X11
2517   tooltip_text = gtk_widget_get_tooltip_text (priv->tray_icon);
2518 #endif
2519 #ifdef GDK_WINDOWING_WIN32
2520   if (priv->tooltip_text)
2521     tooltip_text = g_strdup (priv->tooltip_text);
2522 #endif
2523 #ifdef GDK_WINDOWING_QUARTZ
2524   if (priv->tooltip_text)
2525     tooltip_text = g_strdup (priv->tooltip_text);
2526 #endif
2527
2528   return tooltip_text;
2529 }
2530
2531 /**
2532  * gtk_status_icon_set_tooltip_markup:
2533  * @status_icon: a #GtkStatusIcon
2534  * @markup: (allow-none): the contents of the tooltip for @status_icon, or %NULL
2535  *
2536  * Sets @markup as the contents of the tooltip, which is marked up with
2537  *  the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
2538  *
2539  * This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
2540  * and of the default handler for the #GtkStatusIcon::query-tooltip signal.
2541  *
2542  * See also the #GtkStatusIcon:tooltip-markup property and
2543  * gtk_tooltip_set_markup().
2544  *
2545  * Since: 2.16
2546  */
2547 void
2548 gtk_status_icon_set_tooltip_markup (GtkStatusIcon *status_icon,
2549                                     const gchar   *markup)
2550 {
2551   GtkStatusIconPrivate *priv;
2552 #ifndef GDK_WINDOWING_X11
2553   gchar *text = NULL;
2554 #endif
2555
2556   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2557
2558   priv = status_icon->priv;
2559
2560 #ifdef GDK_WINDOWING_X11
2561   gtk_widget_set_tooltip_markup (priv->tray_icon, markup);
2562 #endif
2563 #ifdef GDK_WINDOWING_WIN32
2564   if (markup)
2565     pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2566   gtk_status_icon_set_tooltip_text (status_icon, text);
2567   g_free (text);
2568 #endif
2569 #ifdef GDK_WINDOWING_QUARTZ
2570   if (markup)
2571     pango_parse_markup (markup, -1, 0, NULL, &text, NULL, NULL);
2572   gtk_status_icon_set_tooltip_text (status_icon, text);
2573   g_free (text);
2574 #endif
2575 }
2576
2577 /**
2578  * gtk_status_icon_get_tooltip_markup:
2579  * @status_icon: a #GtkStatusIcon
2580  *
2581  * Gets the contents of the tooltip for @status_icon.
2582  *
2583  * Return value: the tooltip text, or %NULL. You should free the
2584  *   returned string with g_free() when done.
2585  *
2586  * Since: 2.16
2587  */
2588 gchar *
2589 gtk_status_icon_get_tooltip_markup (GtkStatusIcon *status_icon)
2590 {
2591   GtkStatusIconPrivate *priv;
2592   gchar *markup = NULL;
2593
2594   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2595
2596   priv = status_icon->priv;
2597
2598 #ifdef GDK_WINDOWING_X11
2599   markup = gtk_widget_get_tooltip_markup (priv->tray_icon);
2600 #endif
2601 #ifdef GDK_WINDOWING_WIN32
2602   if (priv->tooltip_text)
2603     markup = g_markup_escape_text (priv->tooltip_text, -1);
2604 #endif
2605 #ifdef GDK_WINDOWING_QUARTZ
2606   if (priv->tooltip_text)
2607     markup = g_markup_escape_text (priv->tooltip_text, -1);
2608 #endif
2609
2610   return markup;
2611 }
2612
2613 /**
2614  * gtk_status_icon_get_x11_window_id:
2615  * @status_icon: a #GtkStatusIcon
2616  *
2617  * This function is only useful on the X11/freedesktop.org platform.
2618  * It returns a window ID for the widget in the underlying
2619  * status icon implementation.  This is useful for the Galago
2620  * notification service, which can send a window ID in the protocol
2621  * in order for the server to position notification windows
2622  * pointing to a status icon reliably.
2623  *
2624  * This function is not intended for other use cases which are
2625  * more likely to be met by one of the non-X11 specific methods, such
2626  * as gtk_status_icon_position_menu().
2627  *
2628  * Return value: An 32 bit unsigned integer identifier for the
2629  * underlying X11 Window
2630  *
2631  * Since: 2.14
2632  */
2633 guint32
2634 gtk_status_icon_get_x11_window_id (GtkStatusIcon *status_icon)
2635 {
2636 #ifdef GDK_WINDOWING_X11
2637   gtk_widget_realize (GTK_WIDGET (status_icon->priv->tray_icon));
2638   return GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (status_icon->priv->tray_icon)));
2639 #else
2640   return 0;
2641 #endif
2642 }
2643
2644 /**
2645  * gtk_status_icon_set_title:
2646  * @status_icon: a #GtkStatusIcon
2647  * @title: the title
2648  *
2649  * Sets the title of this tray icon.
2650  * This should be a short, human-readable, localized string
2651  * describing the tray icon. It may be used by tools like screen
2652  * readers to render the tray icon.
2653  *
2654  * Since: 2.18
2655  */
2656 void
2657 gtk_status_icon_set_title (GtkStatusIcon *status_icon,
2658                            const gchar   *title)
2659 {
2660   GtkStatusIconPrivate *priv;
2661
2662   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2663
2664   priv = status_icon->priv;
2665
2666 #ifdef GDK_WINDOWING_X11
2667   gtk_window_set_title (GTK_WINDOW (priv->tray_icon), title);
2668 #endif
2669 #ifdef GDK_WINDOWING_QUARTZ
2670   g_free (priv->title);
2671   priv->title = g_strdup (title);
2672 #endif
2673 #ifdef GDK_WINDOWING_WIN32
2674   g_free (priv->title);
2675   priv->title = g_strdup (title);
2676 #endif
2677
2678   g_object_notify (G_OBJECT (status_icon), "title");
2679 }
2680
2681 /**
2682  * gtk_status_icon_get_title:
2683  * @status_icon: a #GtkStatusIcon
2684  *
2685  * Gets the title of this tray icon. See gtk_status_icon_set_title().
2686  *
2687  * Returns: the title of the status icon
2688  *
2689  * Since: 2.18
2690  */
2691 const gchar *
2692 gtk_status_icon_get_title (GtkStatusIcon *status_icon)
2693 {
2694   GtkStatusIconPrivate *priv;
2695
2696   g_return_val_if_fail (GTK_IS_STATUS_ICON (status_icon), NULL);
2697
2698   priv = status_icon->priv;
2699
2700 #ifdef GDK_WINDOWING_X11
2701   return gtk_window_get_title (GTK_WINDOW (priv->tray_icon));
2702 #endif
2703 #ifdef GDK_WINDOWING_QUARTZ
2704   return priv->title;
2705 #endif
2706 #ifdef GDK_WINDOWING_WIN32
2707   return priv->title;
2708 #endif
2709 }
2710
2711
2712 /**
2713  * gtk_status_icon_set_name:
2714  * @status_icon: a #GtkStatusIcon
2715  * @name: the name
2716  *
2717  * Sets the name of this tray icon.
2718  * This should be a string identifying this icon. It is may be
2719  * used for sorting the icons in the tray and will not be shown to
2720  * the user.
2721  *
2722  * Since: 2.20
2723  */
2724 void
2725 gtk_status_icon_set_name (GtkStatusIcon *status_icon,
2726                           const gchar   *name)
2727 {
2728   GtkStatusIconPrivate *priv;
2729
2730   g_return_if_fail (GTK_IS_STATUS_ICON (status_icon));
2731
2732   priv = status_icon->priv;
2733
2734 #ifdef GDK_WINDOWING_X11
2735   if (gtk_widget_get_realized (priv->tray_icon))
2736     {
2737       /* gtk_window_set_wmclass() only operates on non-realized windows,
2738        * so temporarily unrealize the tray here
2739        */
2740       gtk_widget_hide (priv->tray_icon);
2741       gtk_widget_unrealize (priv->tray_icon);
2742       gtk_window_set_wmclass (GTK_WINDOW (priv->tray_icon), name, name);
2743       gtk_widget_show (priv->tray_icon);
2744     }
2745   else
2746     gtk_window_set_wmclass (GTK_WINDOW (priv->tray_icon), name, name);
2747 #endif
2748 }