forked from AuroraMiddleware/gtk
cbd7e2aab9
Thu Dec 14 15:48:14 2006 Tim Janik <timj@imendio.com>
* gtk/gtk-sections.txt: added new docs.
342 lines
5.1 KiB
Plaintext
342 lines
5.1 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkStatusIcon
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Display an icon in the system tray
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
The "system tray" or notification area is normally used for transient icons
|
|
that indicate some special state. For example, a system tray icon might
|
|
appear to tell the user that they have new mail, or have an incoming instant
|
|
message, or something along those lines. The basic idea is that creating an
|
|
icon in the notification area is less annoying than popping up a dialog.
|
|
</para>
|
|
|
|
<para>
|
|
A #GtkStatusIcon object can be used to display an icon in a "system tray".
|
|
The icon can have a tooltip, and the user can interact with it by
|
|
activating it or popping up a context menu. Critical information should
|
|
not solely be displayed in a #GtkStatusIcon, since it may not be
|
|
visible (e.g. when the user doesn't have a notification area on his panel).
|
|
This can be checked with gtk_status_icon_is_embedded().
|
|
</para>
|
|
|
|
<para>
|
|
On X11, the implementation follows the freedesktop.org "System Tray"
|
|
<ulink url="http://www.freedesktop.org/wiki/Standards/systemtray-spec">specification</ulink>. Implementations of the "tray" side of this specification can
|
|
be found e.g. in the GNOME and KDE panel applications.
|
|
</para>
|
|
|
|
<para>
|
|
Note that a GtkStatusIcon is <emphasis>not</emphasis> a widget, but just
|
|
a #GObject. Making it a widget would be impractical, since the system tray
|
|
on Win32 doesn't allow to embed arbitrary widgets.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### STRUCT GtkStatusIcon ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SIGNAL GtkStatusIcon::activate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@statusicon: the object which received the signal.
|
|
|
|
<!-- ##### SIGNAL GtkStatusIcon::popup-menu ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@statusicon: the object which received the signal.
|
|
@arg1:
|
|
@arg2:
|
|
|
|
<!-- ##### SIGNAL GtkStatusIcon::size-changed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@statusicon: the object which received the signal.
|
|
@arg1:
|
|
@Returns:
|
|
|
|
<!-- ##### ARG GtkStatusIcon:blinking ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:icon-name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:screen ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:storage-type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkStatusIcon:visible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_new_from_pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pixbuf:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_new_from_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@filename:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_new_from_stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@stock_id:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_new_from_icon_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_from_pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@pixbuf:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_from_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@filename:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_from_stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@stock_id:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_from_icon_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@icon_name:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_storage_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_icon_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_screen ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@screen:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_screen ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_tooltip ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@tooltip_text:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_visible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@visible:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_visible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_set_blinking ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@blinking:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_blinking ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_is_embedded ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_position_menu ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@menu:
|
|
@x:
|
|
@y:
|
|
@push_in:
|
|
@user_data:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_status_icon_get_geometry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@status_icon:
|
|
@screen:
|
|
@area:
|
|
@orientation:
|
|
@Returns:
|
|
|
|
|