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