diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 8ff6499eb9..66e05b9a58 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -89,6 +89,7 @@ gtkseparatormenuitem.sgml gtkseparatortoolitem.sgml gtksettings.sgml gtkstatusbar.sgml +gtkstatusicon.sgml gtkstyle.sgml gtktearoffmenuitem.sgml gtktesting.sgml diff --git a/docs/reference/gtk/tmpl/gtkstatusicon.sgml b/docs/reference/gtk/tmpl/gtkstatusicon.sgml deleted file mode 100644 index 1cf5bc1ca2..0000000000 --- a/docs/reference/gtk/tmpl/gtkstatusicon.sgml +++ /dev/null @@ -1,504 +0,0 @@ - -GtkStatusIcon - - -Display an icon in the system tray - - - -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" -specification. Implementations of the "tray" side of this specification can -be found e.g. in the GNOME and KDE panel applications. - - - -Note that a GtkStatusIcon is not 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. - - - - - - - - - - - - - - - - - - - - - - - - -@statusicon: the object which received the signal. - - - - - - -@statusicon: the object which received the signal. -@event: -@Returns: - - - - - - -@statusicon: the object which received the signal. -@event: -@Returns: - - - - - - -@statusicon: the object which received the signal. -@arg1: -@arg2: - - - - - - -@statusicon: the object which received the signal. -@arg1: -@arg2: -@arg3: -@arg4: -@Returns: - - - - - - -@statusicon: the object which received the signal. -@event: -@Returns: - - - - - - -@statusicon: the object which received the signal. -@arg1: -@Returns: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@void: -@Returns: - - - - - - - -@pixbuf: -@Returns: - - - - - - - -@filename: -@Returns: - - - - - - - -@stock_id: -@Returns: - - - - - - - -@icon_name: -@Returns: - - - - - - - -@icon: -@Returns: - - - - - - - -@status_icon: -@pixbuf: - - - - - - - -@status_icon: -@filename: - - - - - - - -@status_icon: -@stock_id: - - - - - - - -@status_icon: -@icon_name: - - - - - - - -@status_icon: -@icon: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@screen: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@text: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@markup: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@has_tooltip: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@title: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@name: - - - - - - - -@status_icon: -@visible: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@status_icon: -@Returns: - - - - - - - -@menu: -@x: -@y: -@push_in: -@user_data: - - - - - - - -@status_icon: -@screen: -@area: -@orientation: -@Returns: - - - - - - - -@status_icon: -@Returns: - - diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c index cd7e9f44b5..170c780e05 100644 --- a/gtk/gtkstatusicon.c +++ b/gtk/gtkstatusicon.c @@ -55,6 +55,36 @@ #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1) #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" + * specification. + * 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 not 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 enum