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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Matthias Clasen <mclasen@redhat.com>
  21  *         Clemens N. Buss <cebuzz@gmail.com>
  22  */
  23
  24 #ifndef __G_EMBLEMED_ICON_H__
  25 #define __G_EMBLEMED_ICON_H__
  26
  27 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  28 #error "Only <gio/gio.h> can be included directly."
  29 #endif
  30
  31 #include <gio/gicon.h>
  32 #include <gio/gemblem.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define G_TYPE_EMBLEMED_ICON         (g_emblemed_icon_get_type ())
  37 #define G_EMBLEMED_ICON(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_EMBLEMED_ICON, GEmblemedIcon))
  38 #define G_EMBLEMED_ICON_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_EMBLEMED_ICON, GEmblemedIconClass))
  39 #define G_IS_EMBLEMED_ICON(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_EMBLEMED_ICON))
  40 #define G_IS_EMBLEMED_ICON_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_EMBLEMED_ICON))
  41 #define G_EMBLEMED_ICON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_EMBLEMED_ICON, GEmblemedIconClass))
  42
  43 /**
  44  * GEmblemedIcon:
  45  *
  46  * An implementation of #GIcon for icons with emblems.
  47  **/
  48 typedef struct _GEmblemedIcon        GEmblemedIcon;
  49 typedef struct _GEmblemedIconClass   GEmblemedIconClass;
  50 typedef struct _GEmblemedIconPrivate GEmblemedIconPrivate;
  51
  52 struct _GEmblemedIcon
  53 {
  54   GObject parent_instance;
  55
  56   /*< private >*/
  57   GEmblemedIconPrivate *priv;
  58 };
  59
  60 struct _GEmblemedIconClass
  61 {
  62   GObjectClass parent_class;
  63 };
  64
  65 GLIB_AVAILABLE_IN_ALL
  66 GType  g_emblemed_icon_get_type    (void) G_GNUC_CONST;
  67
  68 GLIB_AVAILABLE_IN_ALL
  69 GIcon *g_emblemed_icon_new         (GIcon         *icon,
  70                                     GEmblem       *emblem);
  71 GLIB_AVAILABLE_IN_ALL
  72 GIcon *g_emblemed_icon_get_icon    (GEmblemedIcon *emblemed);
  73 GLIB_AVAILABLE_IN_ALL
  74 GList *g_emblemed_icon_get_emblems (GEmblemedIcon *emblemed);
  75 GLIB_AVAILABLE_IN_ALL
  76 void   g_emblemed_icon_add_emblem  (GEmblemedIcon *emblemed,
  77                                     GEmblem       *emblem);
  78 GLIB_AVAILABLE_IN_ALL
  79 void   g_emblemed_icon_clear_emblems  (GEmblemedIcon *emblemed);
  80
  81 G_END_DECLS
  82
  83 #endif /* __G_EMBLEMED_ICON_H__ */