gicon.h revision 41d1650c9b6b0b8368c0648d2885b83e18020303 
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: Alexander Larsson <alexl@redhat.com>
21 */
22
23#ifndef __G_ICON_H__
24#define __G_ICON_H__
25
26#include <glib-object.h>
27
28G_BEGIN_DECLS
29
30#define G_TYPE_ICON            (g_icon_get_type ())
31#define G_ICON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ICON, GIcon))
32#define G_IS_ICON(obj)	       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ICON))
33#define G_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ICON, GIconIface))
34
35/**
36 * GIcon:
37 *
38 * An abstract type that specifies an icon.
39 **/
40typedef struct _GIcon         		GIcon; /* Dummy typedef */
41typedef struct _GIconIface    		GIconIface;
42
43/**
44 * GIconIface:
45 * @g_iface: The parent interface.
46 * @hash: A hash for a given #GIcon.
47 * @equal: Checks if two #GIcon<!-- -->s are equal.
48 *
49 * GIconIface is used to implement GIcon types for various
50 * different systems. See #GThemedIcon and #GLoadableIcon for
51 * examples of how to implement this interface.
52 */
53struct _GIconIface
54{
55  GTypeInterface g_iface;
56
57  /* Virtual Table */
58
59  guint               (*hash)               (GIcon                *icon);
60  gboolean            (*equal)              (GIcon                *icon1,
61					     GIcon                *icon2);
62};
63
64GType g_icon_get_type (void) G_GNUC_CONST;
65
66guint    g_icon_hash  (gconstpointer  icon);
67gboolean g_icon_equal (GIcon         *icon1,
68		       GIcon         *icon2);
69
70G_END_DECLS
71
72#endif /* __G_ICON_H__ */
73