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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_FILENAME_COMPLETER_H__
  22 #define __G_FILENAME_COMPLETER_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_FILENAME_COMPLETER         (g_filename_completer_get_type ())
  33 #define G_FILENAME_COMPLETER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILENAME_COMPLETER, GFilenameCompleter))
  34 #define G_FILENAME_COMPLETER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILENAME_COMPLETER, GFilenameCompleterClass))
  35 #define G_FILENAME_COMPLETER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILENAME_COMPLETER, GFilenameCompleterClass))
  36 #define G_IS_FILENAME_COMPLETER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILENAME_COMPLETER))
  37 #define G_IS_FILENAME_COMPLETER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILENAME_COMPLETER))
  38
  39 /**
  40  * GFilenameCompleter:
  41  *
  42  * Completes filenames based on files that exist within the file system.
  43  **/
  44 typedef struct _GFilenameCompleterClass GFilenameCompleterClass;
  45
  46 struct _GFilenameCompleterClass
  47 {
  48   GObjectClass parent_class;
  49
  50   /*< public >*/
  51   /* signals */
  52   void (* got_completion_data) (GFilenameCompleter *filename_completer);
  53
  54   /*< private >*/
  55   /* Padding for future expansion */
  56   void (*_g_reserved1) (void);
  57   void (*_g_reserved2) (void);
  58   void (*_g_reserved3) (void);
  59 };
  60
  61 GLIB_AVAILABLE_IN_ALL
  62 GType               g_filename_completer_get_type              (void) G_GNUC_CONST;
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 GFilenameCompleter *g_filename_completer_new                   (void);
  66
  67 GLIB_AVAILABLE_IN_ALL
  68 char *              g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
  69                                                                 const char *initial_text);
  70 GLIB_AVAILABLE_IN_ALL
  71 char **             g_filename_completer_get_completions       (GFilenameCompleter *completer,
  72                                                                 const char *initial_text);
  73 GLIB_AVAILABLE_IN_ALL
  74 void                g_filename_completer_set_dirs_only         (GFilenameCompleter *completer,
  75                                                                 gboolean dirs_only);
  76
  77 G_END_DECLS
  78
  79 #endif /* __G_FILENAME_COMPLETER_H__ */