gcompletion.h 2.85 KB
Newer Older
1 2 3 4 5 6
/* GLIB - Library of useful routines for C programming
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * 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 10
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 13 14
 * Lesser General Public License for more details.
 *
 * 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 20 21
 */

/*
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GLib Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GLib at ftp://ftp.gtk.org/pub/gtk/.
23 24
 */

25 26 27
#ifndef __G_COMPLETION_H__
#define __G_COMPLETION_H__

28
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29 30 31
#error "Only <glib.h> can be included directly."
#endif

32
#include <glib/glist.h>
33 34 35 36 37 38 39 40 41 42

G_BEGIN_DECLS

typedef struct _GCompletion     GCompletion;

typedef gchar*          (*GCompletionFunc)      (gpointer);

/* GCompletion
 */

43
typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
44 45
                                        const gchar *s2,
                                        gsize        n);
Elliot Lee's avatar
Elliot Lee committed
46

47 48 49 50 51 52 53
struct _GCompletion
{
  GList* items;
  GCompletionFunc func;
 
  gchar* prefix;
  GList* cache;
Elliot Lee's avatar
Elliot Lee committed
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 69
GList*       g_completion_complete      (GCompletion*    cmp,
                                         const gchar*    prefix,
70
                                         gchar**         new_prefix);
71
GLIB_DEPRECATED_IN_2_26
72 73
GList*       g_completion_complete_utf8 (GCompletion  *cmp,
                                         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 82 83

G_END_DECLS

#endif /* __G_COMPLETION_H__ */