GtkStatusIcon

typedef struct _GtkStatusIcon GtkStatusIcon;

gtk_status_icon_new ()

GtkStatusIcon*      gtk_status_icon_new                 (void);

Creates an empty status icon object.

Since 2.10

gtk_status_icon_new_from_pixbuf ()

GtkStatusIcon*      gtk_status_icon_new_from_pixbuf     (GdkPixbuf *pixbuf);

Creates a status icon displaying pixbuf.

The image will be scaled down to fit in the available space in the notification area, if necessary.

Since 2.10

gtk_status_icon_new_from_file ()

GtkStatusIcon*      gtk_status_icon_new_from_file       (const gchar *filename);

Creates a status icon displaying the file filename.

The image will be scaled down to fit in the available space in the notification area, if necessary.

Since 2.10

gtk_status_icon_new_from_stock ()

GtkStatusIcon*      gtk_status_icon_new_from_stock      (const gchar *stock_id);

Creates a status icon displaying a stock icon. Sample stock icon names are GTK_STOCK_OPEN, GTK_STOCK_QUIT. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add().

Since 2.10

gtk_status_icon_new_from_icon_name ()

GtkStatusIcon*      gtk_status_icon_new_from_icon_name  (const gchar *icon_name);

Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately.

Since 2.10

gtk_status_icon_new_from_gicon ()

GtkStatusIcon*      gtk_status_icon_new_from_gicon      (GIcon *icon);

Creates a status icon displaying a GIcon. If the icon is a themed icon, it will be updated when the theme changes.

Since 2.14

gtk_status_icon_set_from_pixbuf ()

void                gtk_status_icon_set_from_pixbuf     (GtkStatusIcon *status_icon,
                                                         GdkPixbuf *pixbuf);

Makes status_icon display pixbuf. See gtk_status_icon_new_from_pixbuf() for details.

Since 2.10

gtk_status_icon_set_from_file ()

void                gtk_status_icon_set_from_file       (GtkStatusIcon *status_icon,
                                                         const gchar *filename);

Makes status_icon display the file filename. See gtk_status_icon_new_from_file() for details.

Since 2.10

gtk_status_icon_set_from_stock ()

void                gtk_status_icon_set_from_stock      (GtkStatusIcon *status_icon,
                                                         const gchar *stock_id);

Makes status_icon display the stock icon with the id stock_id. See gtk_status_icon_new_from_stock() for details.

Since 2.10

gtk_status_icon_set_from_icon_name ()

void                gtk_status_icon_set_from_icon_name  (GtkStatusIcon *status_icon,
                                                         const gchar *icon_name);

Makes status_icon display the icon named icon_name from the current icon theme. See gtk_status_icon_new_from_icon_name() for details.

Since 2.10

gtk_status_icon_set_from_gicon ()

void                gtk_status_icon_set_from_gicon      (GtkStatusIcon *status_icon,
                                                         GIcon *icon);

Makes status_icon display the GIcon. See gtk_status_icon_new_from_gicon() for details.

Since 2.14

gtk_status_icon_get_storage_type ()

GtkImageType        gtk_status_icon_get_storage_type    (GtkStatusIcon *status_icon);

Gets the type of representation being used by the GtkStatusIcon to store image data. If the GtkStatusIcon has no image data, the return value will be GTK_IMAGE_EMPTY.

Since 2.10

gtk_status_icon_get_pixbuf ()

GdkPixbuf*          gtk_status_icon_get_pixbuf          (GtkStatusIcon *status_icon);

Gets the GdkPixbuf being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returned pixbuf.

Since 2.10

gtk_status_icon_get_stock ()

const gchar*        gtk_status_icon_get_stock           (GtkStatusIcon *status_icon);

Gets the id of the stock icon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()). The returned string is owned by the GtkStatusIcon and should not be freed or modified.

Since 2.10

gtk_status_icon_get_icon_name ()

const gchar*        gtk_status_icon_get_icon_name       (GtkStatusIcon *status_icon);

Gets the name of the icon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()). The returned string is owned by the GtkStatusIcon and should not be freed or modified.

Since 2.10

gtk_status_icon_get_gicon ()

GIcon*              gtk_status_icon_get_gicon           (GtkStatusIcon *status_icon);

Retrieves the GIcon being displayed by the GtkStatusIcon. The storage type of the status icon must be GTK_IMAGE_EMPTY or GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the returned GIcon.

If this function fails, icon is left unchanged;

Since 2.14

gtk_status_icon_get_size ()

gint                gtk_status_icon_get_size            (GtkStatusIcon *status_icon);

Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the size-changed signal can be used to react to size changes.

Note that the returned size is only meaningful while the status icon is embedded (see gtk_status_icon_is_embedded()).

Since 2.10

gtk_status_icon_set_screen ()

void                gtk_status_icon_set_screen          (GtkStatusIcon *status_icon,
                                                         GdkScreen *screen);

Sets the GdkScreen where status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen.

Since 2.12

gtk_status_icon_get_screen ()

GdkScreen*          gtk_status_icon_get_screen          (GtkStatusIcon *status_icon);

Returns the GdkScreen associated with status_icon.

Since 2.12

gtk_status_icon_set_tooltip ()

void                gtk_status_icon_set_tooltip         (GtkStatusIcon *status_icon,
                                                         const gchar *tooltip_text);

Sets the tooltip of the status icon.

Since 2.10

gtk_status_icon_set_visible ()

void                gtk_status_icon_set_visible         (GtkStatusIcon *status_icon,
                                                         gboolean visible);

Shows or hides a status icon.

Since 2.10

gtk_status_icon_get_visible ()

gboolean            gtk_status_icon_get_visible         (GtkStatusIcon *status_icon);

Returns whether the status icon is visible or not. Note that being visible does not guarantee that the user can actually see the icon, see also gtk_status_icon_is_embedded().

Since 2.10

gtk_status_icon_set_blinking ()

void                gtk_status_icon_set_blinking        (GtkStatusIcon *status_icon,
                                                         gboolean blinking);

Makes the status icon start or stop blinking. Note that blinking user interface elements may be problematic for some users, and thus may be turned off, in which case this setting has no effect.

Since 2.10

gtk_status_icon_get_blinking ()

gboolean            gtk_status_icon_get_blinking        (GtkStatusIcon *status_icon);

Returns whether the icon is blinking, see gtk_status_icon_set_blinking().

Since 2.10

gtk_status_icon_is_embedded ()

gboolean            gtk_status_icon_is_embedded         (GtkStatusIcon *status_icon);

Returns whether the status icon is embedded in a notification area.

Since 2.10

gtk_status_icon_position_menu ()

void                gtk_status_icon_position_menu       (GtkMenu *menu,
                                                         gint *x,
                                                         gint *y,
                                                         gboolean *push_in,
                                                         gpointer user_data);

Menu positioning function to use with gtk_menu_popup() to position menu aligned to the status icon user_data.

Since 2.10

gtk_status_icon_get_geometry ()

gboolean            gtk_status_icon_get_geometry        (GtkStatusIcon *status_icon,
                                                         GdkScreen **screen,
                                                         GdkRectangle *area,
                                                         GtkOrientation *orientation);

Obtains information about the location of the status icon on screen. This information can be used to e.g. position popups like notification bubbles.

See gtk_status_icon_position_menu() for a more convenient alternative for positioning menus.

Note that some platforms do not allow GTK+ to provide this information, and even on platforms that do allow it, the information is not reliable unless the status icon is embedded in a notification area, see gtk_status_icon_is_embedded().

Since 2.10

gtk_status_icon_get_x11_window_id ()

guint32             gtk_status_icon_get_x11_window_id   (GtkStatusIcon *status_icon);

This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago notification service, which can send a window ID in the protocol in order for the server to position notification windows pointing to a status icon reliably.

This function is not intended for other use cases which are more likely to be met by one of the non-X11 specific methods, such as gtk_status_icon_position_menu().

Since 2.14

The "blinking" property

  "blinking"                 gboolean              : Read / Write

Whether or not the status icon is blinking.

Default value: FALSE

The "embedded" property

  "embedded"                 gboolean              : Read

TRUE if the statusicon is embedded in a notification area.

Default value: FALSE

Since 2.12

The "file" property

  "file"                     gchar*                : Write

Filename to load and display.

Default value: NULL

The "gicon" property

  "gicon"                    GIcon*                : Read / Write

The GIcon displayed in the GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes.

Since 2.14

The "icon-name" property

  "icon-name"                gchar*                : Read / Write

The name of the icon from the icon theme.

Default value: NULL

The "orientation" property

  "orientation"              GtkOrientation        : Read

The orientation of the tray in which the statusicon is embedded.

Default value: GTK_ORIENTATION_HORIZONTAL

Since 2.12

The "pixbuf" property

  "pixbuf"                   GdkPixbuf*            : Read / Write

A GdkPixbuf to display.

The "screen" property

  "screen"                   GdkScreen*            : Read / Write

The screen where this status icon will be displayed.

The "size" property

  "size"                     gint                  : Read

The size of the icon.

Allowed values: >= 0

Default value: 0

The "stock" property

  "stock"                    gchar*                : Read / Write

Stock ID for a stock image to display.

Default value: NULL

The "storage-type" property

  "storage-type"             GtkImageType          : Read

The representation being used for image data.

Default value: GTK_IMAGE_EMPTY

The "visible" property

  "visible"                  gboolean              : Read / Write

Whether or not the status icon is visible.

Default value: TRUE

The "activate" signal

void                user_function                      (GtkStatusIcon *status_icon,
                                                        gpointer       user_data)        : Run First / Action

Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent.

Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings.

Since 2.10

The "popup-menu" signal

void                user_function                      (GtkStatusIcon *status_icon,
                                                        guint          button,
                                                        guint          activate_time,
                                                        gpointer       user_data)          : Run First / Action

Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent.

The button and activate_time parameters should be passed as the last to arguments to gtk_menu_popup().

Unlike most G_SIGNAL_ACTION signals, this signal is meant to be used by applications and should be wrapped by language bindings.

Since 2.10

The "size-changed" signal

gboolean            user_function                      (GtkStatusIcon *status_icon,
                                                        gint           size,
                                                        gpointer       user_data)        : Run Last

Gets emitted when the size available for the image changes, e.g. because the notification area got resized.

Since 2.10