cleanup
[platform/upstream/glib.git] / gio / gemblemedicon.h
1 /* Gio - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2006-2007 Red Hat, 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
16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: Matthias Clasen <mclasen@redhat.com>
19  *         Clemens N. Buss <cebuzz@gmail.com>
20  */
21
22 #ifndef __G_EMBLEMED_ICON_H__
23 #define __G_EMBLEMED_ICON_H__
24
25 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26 #error "Only <gio/gio.h> can be included directly."
27 #endif
28
29 #include <gio/gicon.h>
30 #include <gio/gemblem.h>
31
32 G_BEGIN_DECLS
33
34 #define G_TYPE_EMBLEMED_ICON         (g_emblemed_icon_get_type ())
35 #define G_EMBLEMED_ICON(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_EMBLEMED_ICON, GEmblemedIcon))
36 #define G_EMBLEMED_ICON_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_EMBLEMED_ICON, GEmblemedIconClass))
37 #define G_IS_EMBLEMED_ICON(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_EMBLEMED_ICON))
38 #define G_IS_EMBLEMED_ICON_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_EMBLEMED_ICON))
39 #define G_EMBLEMED_ICON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_EMBLEMED_ICON, GEmblemedIconClass))
40
41 /**
42  * GEmblemedIcon:
43  *
44  * An implementation of #GIcon for icons with emblems.
45  **/
46 typedef struct _GEmblemedIcon        GEmblemedIcon;
47 typedef struct _GEmblemedIconClass   GEmblemedIconClass;
48 typedef struct _GEmblemedIconPrivate GEmblemedIconPrivate;
49
50 struct _GEmblemedIcon
51 {
52   GObject parent_instance;
53
54   /*< private >*/
55   GEmblemedIconPrivate *priv;
56 };
57
58 struct _GEmblemedIconClass
59 {
60   GObjectClass parent_class;
61 };
62
63 GLIB_AVAILABLE_IN_ALL
64 GType  g_emblemed_icon_get_type    (void) G_GNUC_CONST;
65
66 GLIB_AVAILABLE_IN_ALL
67 GIcon *g_emblemed_icon_new         (GIcon         *icon,
68                                     GEmblem       *emblem);
69 GLIB_AVAILABLE_IN_ALL
70 GIcon *g_emblemed_icon_get_icon    (GEmblemedIcon *emblemed);
71 GLIB_AVAILABLE_IN_ALL
72 GList *g_emblemed_icon_get_emblems (GEmblemedIcon *emblemed);
73 GLIB_AVAILABLE_IN_ALL
74 void   g_emblemed_icon_add_emblem  (GEmblemedIcon *emblemed,
75                                     GEmblem       *emblem);
76 GLIB_AVAILABLE_IN_ALL
77 void   g_emblemed_icon_clear_emblems  (GEmblemedIcon *emblemed);
78
79 G_END_DECLS
80
81 #endif /* __G_EMBLEMED_ICON_H__ */