glib/deprecated/gcompletion.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __G_COMPLETION_H__
  26 #define __G_COMPLETION_H__
  27
  28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  29 #error "Only <glib.h> can be included directly."
  30 #endif
  31
  32 #include <glib/glist.h>
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _GCompletion     GCompletion;
  37
  38 typedef gchar*          (*GCompletionFunc)      (gpointer);
  39
  40 /* GCompletion
  41  */
  42
  43 typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
  44                                         const gchar *s2,
  45                                         gsize        n);
  46
  47 struct _GCompletion
  48 {
  49   GList* items;
  50   GCompletionFunc func;
  51
  52   gchar* prefix;
  53   GList* cache;
  54   GCompletionStrncmpFunc strncmp_func;
  55 };
  56
  57 GLIB_DEPRECATED_IN_2_26
  58 GCompletion* g_completion_new           (GCompletionFunc func);
  59 GLIB_DEPRECATED_IN_2_26
  60 void         g_completion_add_items     (GCompletion*    cmp,
  61                                          GList*          items);
  62 GLIB_DEPRECATED_IN_2_26
  63 void         g_completion_remove_items  (GCompletion*    cmp,
  64                                          GList*          items);
  65 GLIB_DEPRECATED_IN_2_26
  66 void         g_completion_clear_items   (GCompletion*    cmp);
  67 GLIB_DEPRECATED_IN_2_26
  68 GList*       g_completion_complete      (GCompletion*    cmp,
  69                                          const gchar*    prefix,
  70                                          gchar**         new_prefix);
  71 GLIB_DEPRECATED_IN_2_26
  72 GList*       g_completion_complete_utf8 (GCompletion  *cmp,
  73                                          const gchar*    prefix,
  74                                          gchar**         new_prefix);
  75 GLIB_DEPRECATED_IN_2_26
  76 void         g_completion_set_compare   (GCompletion *cmp,
  77                                          GCompletionStrncmpFunc strncmp_func);
  78 GLIB_DEPRECATED_IN_2_26
  79 void         g_completion_free          (GCompletion*    cmp);
  80
  81 G_END_DECLS
  82
  83 #endif /* __G_COMPLETION_H__ */