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