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

   1 /* gtkstatusicon.h:
   2  *
   3  * Copyright (C) 2003 Sun Microsystems, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Authors:
  19  *      Mark McLoughlin <mark@skynet.ie>
  20  */
  21
  22 #ifndef __GTK_STATUS_ICON_H__
  23 #define __GTK_STATUS_ICON_H__
  24
  25 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  26 #error "Only <gtk/gtk.h> can be included directly."
  27 #endif
  28
  29 #include <gtk/gtkimage.h>
  30 #include <gtk/gtkmenu.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GTK_TYPE_STATUS_ICON         (gtk_status_icon_get_type ())
  35 #define GTK_STATUS_ICON(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_STATUS_ICON, GtkStatusIcon))
  36 #define GTK_STATUS_ICON_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_STATUS_ICON, GtkStatusIconClass))
  37 #define GTK_IS_STATUS_ICON(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_STATUS_ICON))
  38 #define GTK_IS_STATUS_ICON_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_STATUS_ICON))
  39 #define GTK_STATUS_ICON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_STATUS_ICON, GtkStatusIconClass))
  40
  41 typedef struct _GtkStatusIcon        GtkStatusIcon;
  42 typedef struct _GtkStatusIconClass   GtkStatusIconClass;
  43 typedef struct _GtkStatusIconPrivate GtkStatusIconPrivate;
  44
  45 struct _GtkStatusIcon
  46 {
  47   GObject               parent_instance;
  48
  49   GtkStatusIconPrivate *priv;
  50 };
  51
  52 struct _GtkStatusIconClass
  53 {
  54   GObjectClass parent_class;
  55
  56   void     (* activate)             (GtkStatusIcon  *status_icon);
  57   void     (* popup_menu)           (GtkStatusIcon  *status_icon,
  58                                      guint           button,
  59                                      guint32         activate_time);
  60   gboolean (* size_changed)         (GtkStatusIcon  *status_icon,
  61                                      gint            size);
  62   gboolean (* button_press_event)   (GtkStatusIcon  *status_icon,
  63                                      GdkEventButton *event);
  64   gboolean (* button_release_event) (GtkStatusIcon  *status_icon,
  65                                      GdkEventButton *event);
  66   gboolean (* scroll_event)         (GtkStatusIcon  *status_icon,
  67                                      GdkEventScroll *event);
  68   gboolean (* query_tooltip)        (GtkStatusIcon  *status_icon,
  69                                      gint            x,
  70                                      gint            y,
  71                                      gboolean        keyboard_mode,
  72                                      GtkTooltip     *tooltip);
  73
  74   void (*__gtk_reserved1);
  75   void (*__gtk_reserved2);
  76   void (*__gtk_reserved3);
  77   void (*__gtk_reserved4);
  78 };
  79
  80 GType                 gtk_status_icon_get_type           (void) G_GNUC_CONST;
  81
  82 GtkStatusIcon        *gtk_status_icon_new                (void);
  83 GtkStatusIcon        *gtk_status_icon_new_from_pixbuf    (GdkPixbuf          *pixbuf);
  84 GtkStatusIcon        *gtk_status_icon_new_from_file      (const gchar        *filename);
  85 GtkStatusIcon        *gtk_status_icon_new_from_stock     (const gchar        *stock_id);
  86 GtkStatusIcon        *gtk_status_icon_new_from_icon_name (const gchar        *icon_name);
  87 GtkStatusIcon        *gtk_status_icon_new_from_gicon     (GIcon              *icon);
  88
  89 void                  gtk_status_icon_set_from_pixbuf    (GtkStatusIcon      *status_icon,
  90                                                           GdkPixbuf          *pixbuf);
  91 void                  gtk_status_icon_set_from_file      (GtkStatusIcon      *status_icon,
  92                                                           const gchar        *filename);
  93 void                  gtk_status_icon_set_from_stock     (GtkStatusIcon      *status_icon,
  94                                                           const gchar        *stock_id);
  95 void                  gtk_status_icon_set_from_icon_name (GtkStatusIcon      *status_icon,
  96                                                           const gchar        *icon_name);
  97 void                  gtk_status_icon_set_from_gicon     (GtkStatusIcon      *status_icon,
  98                                                           GIcon              *icon);
  99
 100 GtkImageType          gtk_status_icon_get_storage_type   (GtkStatusIcon      *status_icon);
 101
 102 GdkPixbuf            *gtk_status_icon_get_pixbuf         (GtkStatusIcon      *status_icon);
 103 const gchar *         gtk_status_icon_get_stock          (GtkStatusIcon      *status_icon);
 104 const gchar *         gtk_status_icon_get_icon_name      (GtkStatusIcon      *status_icon);
 105 GIcon                *gtk_status_icon_get_gicon          (GtkStatusIcon      *status_icon);
 106
 107 gint                  gtk_status_icon_get_size           (GtkStatusIcon      *status_icon);
 108
 109 void                  gtk_status_icon_set_screen         (GtkStatusIcon      *status_icon,
 110                                                           GdkScreen          *screen);
 111 GdkScreen            *gtk_status_icon_get_screen         (GtkStatusIcon      *status_icon);
 112
 113 void                  gtk_status_icon_set_has_tooltip    (GtkStatusIcon      *status_icon,
 114                                                           gboolean            has_tooltip);
 115 void                  gtk_status_icon_set_tooltip_text   (GtkStatusIcon      *status_icon,
 116                                                           const gchar        *text);
 117 void                  gtk_status_icon_set_tooltip_markup (GtkStatusIcon      *status_icon,
 118                                                           const gchar        *markup);
 119 void                  gtk_status_icon_set_title          (GtkStatusIcon      *status_icon,
 120                                                           const gchar        *title);
 121 const gchar *         gtk_status_icon_get_title          (GtkStatusIcon      *status_icon);
 122 void                  gtk_status_icon_set_name           (GtkStatusIcon      *status_icon,
 123                                                           const gchar        *name);
 124 void                  gtk_status_icon_set_visible        (GtkStatusIcon      *status_icon,
 125                                                           gboolean            visible);
 126 gboolean              gtk_status_icon_get_visible        (GtkStatusIcon      *status_icon);
 127
 128 gboolean              gtk_status_icon_is_embedded        (GtkStatusIcon      *status_icon);
 129
 130 void                  gtk_status_icon_position_menu      (GtkMenu            *menu,
 131                                                           gint               *x,
 132                                                           gint               *y,
 133                                                           gboolean           *push_in,
 134                                                           gpointer            user_data);
 135 gboolean              gtk_status_icon_get_geometry       (GtkStatusIcon      *status_icon,
 136                                                           GdkScreen         **screen,
 137                                                           GdkRectangle       *area,
 138                                                           GtkOrientation     *orientation);
 139 gboolean              gtk_status_icon_get_has_tooltip    (GtkStatusIcon      *status_icon);
 140 gchar                *gtk_status_icon_get_tooltip_text   (GtkStatusIcon      *status_icon);
 141 gchar                *gtk_status_icon_get_tooltip_markup (GtkStatusIcon      *status_icon);
 142
 143 guint32               gtk_status_icon_get_x11_window_id  (GtkStatusIcon      *status_icon);
 144
 145 G_END_DECLS
 146
 147 #endif /* __GTK_STATUS_ICON_H__ */