Bumps documentation to 93% symbol coverage, touching most
[platform/upstream/glib.git] / gio / gfileicon.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: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #ifndef __G_FILE_ICON_H__
24 #define __G_FILE_ICON_H__
25
26 #include <gio/gloadableicon.h>
27 #include <gio/gfile.h>
28
29 G_BEGIN_DECLS
30
31 #define G_TYPE_FILE_ICON         (g_file_icon_get_type ())
32 #define G_FILE_ICON(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_ICON, GFileIcon))
33 #define G_FILE_ICON_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_ICON, GFileIconClass))
34 #define G_IS_FILE_ICON(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_ICON))
35 #define G_IS_FILE_ICON_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_ICON))
36 #define G_FILE_ICON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_ICON, GFileIconClass))
37
38 /**
39  * GFileIcon:
40  * 
41  * Gets an icon for a #GFile. Implements #GLoadabeIcon.
42  **/
43 typedef struct _GFileIcon        GFileIcon;
44 typedef struct _GFileIconClass   GFileIconClass;
45
46 GType g_file_icon_get_type (void) G_GNUC_CONST;
47   
48 GIcon *g_file_icon_new (GFile *file);
49
50 GFile *g_file_icon_get_file (GFileIcon *icon);
51
52 G_END_DECLS
53
54 #endif /* __G_FILE_ICON_H__ */