glib/deprecated/gcompletion.h

0001 /* GLIB - Library of useful routines for C programming
0002  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
0003  *
0004  * SPDX-License-Identifier: LGPL-2.1-or-later
0005  *
0006  * This library is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU Lesser General Public
0008  * License as published by the Free Software Foundation; either
0009  * version 2.1 of the License, or (at your option) any later version.
0010  *
0011  * This library is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0014  * Lesser General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU Lesser General Public
0017  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
0018  */
0019
0020 /*
0021  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
0022  * file for a list of people on the GLib Team.  See the ChangeLog
0023  * files for a list of changes.  These files are distributed with
0024  * GLib at ftp://ftp.gtk.org/pub/gtk/.
0025  */
0026
0027 #ifndef __G_COMPLETION_H__
0028 #define __G_COMPLETION_H__
0029
0030 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
0031 #error "Only <glib.h> can be included directly."
0032 #endif
0033
0034 #include <glib/glist.h>
0035
0036 G_BEGIN_DECLS
0037
0038 typedef struct _GCompletion     GCompletion;
0039
0040 typedef gchar*          (*GCompletionFunc)      (gpointer item);
0041
0042 /* GCompletion
0043  */
0044
0045 typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
0046                                         const gchar *s2,
0047                                         gsize        n);
0048
0049 struct _GCompletion
0050 {
0051   GList* items;
0052   GCompletionFunc func;
0053
0054   gchar* prefix;
0055   GList* cache;
0056   GCompletionStrncmpFunc strncmp_func;
0057 };
0058
0059 GLIB_DEPRECATED_IN_2_26
0060 GCompletion* g_completion_new           (GCompletionFunc func);
0061 GLIB_DEPRECATED_IN_2_26
0062 void         g_completion_add_items     (GCompletion*    cmp,
0063                                          GList*          items);
0064 GLIB_DEPRECATED_IN_2_26
0065 void         g_completion_remove_items  (GCompletion*    cmp,
0066                                          GList*          items);
0067 GLIB_DEPRECATED_IN_2_26
0068 void         g_completion_clear_items   (GCompletion*    cmp);
0069 GLIB_DEPRECATED_IN_2_26
0070 GList*       g_completion_complete      (GCompletion*    cmp,
0071                                          const gchar*    prefix,
0072                                          gchar**         new_prefix);
0073 GLIB_DEPRECATED_IN_2_26
0074 GList*       g_completion_complete_utf8 (GCompletion  *cmp,
0075                                          const gchar*    prefix,
0076                                          gchar**         new_prefix);
0077 GLIB_DEPRECATED_IN_2_26
0078 void         g_completion_set_compare   (GCompletion *cmp,
0079                                          GCompletionStrncmpFunc strncmp_func);
0080 GLIB_DEPRECATED_IN_2_26
0081 void         g_completion_free          (GCompletion*    cmp);
0082
0083 G_END_DECLS
0084
0085 #endif /* __G_COMPLETION_H__ */