Improve docs

[platform/upstream/glib.git] / glib / gcompletion.h

diff --git a/glib/gcompletion.h b/glib/gcompletion.h
index 5af9475..900883e 100644 (file)
--- a/glib/gcompletion.h
+++ b/glib/gcompletion.h
@@ -21,13 +21,17 @@
  * 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
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
 #ifndef __G_COMPLETION_H__
 #define __G_COMPLETION_H__
 
-#include <glist.h>
+#include <glib/glist.h>
 
 G_BEGIN_DECLS
 
@@ -38,6 +42,10 @@ typedef gchar*          (*GCompletionFunc)      (gpointer);
 /* GCompletion
  */
 
+typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
+                                       const gchar *s2,
+                                       gsize        n);
+
 struct _GCompletion
 {
   GList* items;
@@ -45,20 +53,25 @@ struct _GCompletion
  
   gchar* prefix;
   GList* cache;
+  GCompletionStrncmpFunc strncmp_func;
 };
 
-GCompletion* g_completion_new          (GCompletionFunc func);
-void         g_completion_add_items    (GCompletion*    cmp,
-                                        GList*          items);
-void         g_completion_remove_items (GCompletion*    cmp,
-                                        GList*          items);
-void         g_completion_clear_items  (GCompletion*    cmp);
-GList*       g_completion_complete     (GCompletion*    cmp,
-                                        gchar*          prefix,
-                                        gchar**         new_prefix);
-void         g_completion_free         (GCompletion*    cmp);
+GCompletion* g_completion_new           (GCompletionFunc func);
+void         g_completion_add_items     (GCompletion*    cmp,
+                                         GList*          items);
+void         g_completion_remove_items  (GCompletion*    cmp,
+                                         GList*          items);
+void         g_completion_clear_items   (GCompletion*    cmp);
+GList*       g_completion_complete      (GCompletion*    cmp,
+                                         const gchar*    prefix,
+                                         gchar**         new_prefix);
+GList*       g_completion_complete_utf8 (GCompletion  *cmp,
+                                         const gchar*    prefix,
+                                         gchar**         new_prefix);
+void         g_completion_set_compare   (GCompletion *cmp,
+                                        GCompletionStrncmpFunc strncmp_func);
+void         g_completion_free          (GCompletion*    cmp);
 
 G_END_DECLS
 
 #endif /* __G_COMPLETION_H__ */
-