Commit 94e97753 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkStatusIcon

parent 8a2c942f
...@@ -89,6 +89,7 @@ gtkseparatormenuitem.sgml ...@@ -89,6 +89,7 @@ gtkseparatormenuitem.sgml
gtkseparatortoolitem.sgml gtkseparatortoolitem.sgml
gtksettings.sgml gtksettings.sgml
gtkstatusbar.sgml gtkstatusbar.sgml
gtkstatusicon.sgml
gtkstyle.sgml gtkstyle.sgml
gtktearoffmenuitem.sgml gtktearoffmenuitem.sgml
gtktesting.sgml gtktesting.sgml
......
<!-- ##### 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 ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkStatusIcon ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkStatusIcon::activate ##### -->
<para>
</para>
@statusicon: the object which received the signal.
<!-- ##### SIGNAL GtkStatusIcon::button-press-event ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkStatusIcon::button-release-event ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkStatusIcon::popup-menu ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkStatusIcon::query-tooltip ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@arg1:
@arg2:
@arg3:
@arg4:
@Returns:
<!-- ##### SIGNAL GtkStatusIcon::scroll-event ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkStatusIcon::size-changed ##### -->
<para>
</para>
@statusicon: the object which received the signal.
@arg1:
@Returns:
<!-- ##### ARG GtkStatusIcon:embedded ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:file ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:gicon ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:has-tooltip ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:icon-name ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:orientation ##### -->
<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:title ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:tooltip-markup ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:tooltip-text ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:visible ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_status_icon_new ##### -->
<para>
</para>
@void:
@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_new_from_gicon ##### -->
<para>
</para>
@icon:
@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_set_from_gicon ##### -->
<para>
</para>
@status_icon:
@icon:
<!-- ##### 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_gicon ##### -->
<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_text ##### -->
<para>
</para>
@status_icon:
@text:
<!-- ##### FUNCTION gtk_status_icon_get_tooltip_text ##### -->
<para>
</para>
@status_icon:
@Returns:
<!-- ##### FUNCTION gtk_status_icon_set_tooltip_markup ##### -->
<para>
</para>
@status_icon:
@markup:
<!-- ##### FUNCTION gtk_status_icon_get_tooltip_markup ##### -->
<para>
</para>
@status_icon:
@Returns:
<!-- ##### FUNCTION gtk_status_icon_set_has_tooltip ##### -->
<para>
</para>
@status_icon:
@has_tooltip:
<!-- ##### FUNCTION gtk_status_icon_get_has_tooltip ##### -->
<para>
</para>
@status_icon:
@Returns:
<!-- ##### FUNCTION gtk_status_icon_set_title ##### -->
<para>
</para>
@status_icon:
@title:
<!-- ##### FUNCTION gtk_status_icon_get_title ##### -->
<para>
</para>
@status_icon:
@Returns:
<!-- ##### FUNCTION gtk_status_icon_set_name ##### -->
<para>
</para>
@status_icon:
@name:
<!-- ##### 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_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:
<!-- ##### FUNCTION gtk_status_icon_get_x11_window_id ##### -->
<para>
</para>
@status_icon:
@Returns:
...@@ -55,6 +55,36 @@ ...@@ -55,6 +55,36 @@
#define WM_GTK_TRAY_NOTIFICATION (WM_USER+1) #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1)
#endif #endif
/**
* SECTION:gtkstatusicon
* @Short_description: Display an icon in the system tray
* @Title: GtkStatusIcon
*
* 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.
*
* 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().
*
* On X11, the implementation follows the freedesktop.org "System Tray"
* <ulink url="http://www.freedesktop.org/wiki/Specifications/systemtray-spec">specification</ulink>.
* Implementations of the "tray" side of this specification can
* be found e.g. in the GNOME 2 and KDE panel applications.
*
* 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.
*/
#define BLINK_TIMEOUT 500 #define BLINK_TIMEOUT 500
enum enum
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment