]> Pileus Git - ~andy/gtk/blob - gtk/gtktrayicon.h
Minor doc cleanup
[~andy/gtk] / gtk / gtktrayicon.h
1 /* gtktrayicon.h
2  * Copyright (C) 2002 Anders Carlsson <andersca@gnu.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifndef __GTK_TRAY_ICON_H__
19 #define __GTK_TRAY_ICON_H__
20
21 #include "gtkplug.h"
22
23 G_BEGIN_DECLS
24
25 #define GTK_TYPE_TRAY_ICON              (gtk_tray_icon_get_type ())
26 #define GTK_TRAY_ICON(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TRAY_ICON, GtkTrayIcon))
27 #define GTK_TRAY_ICON_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TRAY_ICON, GtkTrayIconClass))
28 #define GTK_IS_TRAY_ICON(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TRAY_ICON))
29 #define GTK_IS_TRAY_ICON_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TRAY_ICON))
30 #define GTK_TRAY_ICON_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TRAY_ICON, GtkTrayIconClass))
31         
32 typedef struct _GtkTrayIcon        GtkTrayIcon;
33 typedef struct _GtkTrayIconPrivate GtkTrayIconPrivate;
34 typedef struct _GtkTrayIconClass   GtkTrayIconClass;
35
36 struct _GtkTrayIcon
37 {
38   GtkPlug parent_instance;
39
40   GtkTrayIconPrivate *priv;
41 };
42
43 struct _GtkTrayIconClass
44 {
45   GtkPlugClass parent_class;
46
47   /* Padding for future expansion */
48   void (*_gtk_reserved1);
49   void (*_gtk_reserved2);
50   void (*_gtk_reserved3);
51   void (*_gtk_reserved4);
52 };
53
54 GType          gtk_tray_icon_get_type         (void) G_GNUC_CONST;
55
56 GtkTrayIcon   *_gtk_tray_icon_new_for_screen  (GdkScreen   *screen,
57                                                const gchar *name);
58
59 GtkTrayIcon   *_gtk_tray_icon_new             (const gchar *name);
60
61 guint          _gtk_tray_icon_send_message    (GtkTrayIcon *icon,
62                                                gint         timeout,
63                                                const gchar *message,
64                                                gint         len);
65 void           _gtk_tray_icon_cancel_message  (GtkTrayIcon *icon,
66                                                guint        id);
67
68 GtkOrientation _gtk_tray_icon_get_orientation (GtkTrayIcon *icon);
69 gint           _gtk_tray_icon_get_padding     (GtkTrayIcon *icon);
70 gint           _gtk_tray_icon_get_icon_size   (GtkTrayIcon *icon);
71
72 G_END_DECLS
73
74 #endif /* __GTK_TRAY_ICON_H__ */