gio/ docs/reference/gio Merged gio-standalone into glib.
[platform/upstream/glib.git] / gio / gfilenamecompleter.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_FILENAME_COMPLETER_H__
24 #define __G_FILENAME_COMPLETER_H__
25
26 #include <glib-object.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_FILENAME_COMPLETER         (g_filename_completer_get_type ())
31 #define G_FILENAME_COMPLETER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILENAME_COMPLETER, GFilenameCompleter))
32 #define G_FILENAME_COMPLETER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILENAME_COMPLETER, GFilenameCompleterClass))
33 #define G_FILENAME_COMPLETER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILENAME_COMPLETER, GFilenameCompleterClass))
34 #define G_IS_FILENAME_COMPLETER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILENAME_COMPLETER))
35 #define G_IS_FILENAME_COMPLETER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILENAME_COMPLETER))
36
37 typedef struct _GFilenameCompleter GFilenameCompleter;
38 typedef struct _GFilenameCompleterClass GFilenameCompleterClass;
39
40 struct _GFilenameCompleterClass {
41   GObjectClass parent_class;
42
43   /*< public >*/
44   /* signals */
45   void (* got_completion_data)  (GFilenameCompleter *filename_completer);
46
47   /* Padding for future expansion */
48   void (*_g_reserved1) (void);
49   void (*_g_reserved2) (void);
50   void (*_g_reserved3) (void);
51 };
52
53 GType g_filename_completer_get_type (void) G_GNUC_CONST;
54
55 GFilenameCompleter *g_filename_completer_new                   (void);
56
57 char *              g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
58                                                                 const char *initial_text);
59 char **             g_filename_completer_get_completions       (GFilenameCompleter *completer,
60                                                                 const char *initial_text);
61 void                g_filename_completer_set_dirs_only         (GFilenameCompleter *completer,
62                                                                 gboolean dirs_only);
63
64 G_END_DECLS
65
66 #endif /* __G_FILENAME_COMPLETER_H__ */