summaryrefslogtreecommitdiff
path: root/gtk/gtkentrycompletion.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2011-01-04 17:54:47 -0500
committerMatthias Clasen <mclasen@redhat.com>2011-01-04 17:54:47 -0500
commit2690b8b924534639dbfb2afc5353905ccc6447f7 (patch)
tree73f02232a5de745a9b612d88063e0ed82c6d432a /gtk/gtkentrycompletion.h
parent82c9013e01b73e433a529b4528d931b62f5a0ced (diff)
downloadgtk+-2690b8b924534639dbfb2afc5353905ccc6447f7.tar.gz
Move GtkEntryCompletion docs inline
Based on a patch by Garrett Regier https://bugzilla.gnome.org/show_bug.cgi?id=617322
Diffstat (limited to 'gtk/gtkentrycompletion.h')
-rw-r--r--gtk/gtkentrycompletion.h23
1 files changed, 20 insertions, 3 deletions
diff --git a/gtk/gtkentrycompletion.h b/gtk/gtkentrycompletion.h
index a5ba4226c9..368b944342 100644
--- a/gtk/gtkentrycompletion.h
+++ b/gtk/gtkentrycompletion.h
@@ -43,6 +43,23 @@ typedef struct _GtkEntryCompletion GtkEntryCompletion;
typedef struct _GtkEntryCompletionClass GtkEntryCompletionClass;
typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate;
+/**
+ * GtkEntryCompletionMatchFunc:
+ * @completion: the #GtkEntryCompletion
+ * @key: the string to match, normalized and case-folded
+ * @iter: a #GtkTreeIter indicating the row to match
+ * @user_data: user data given to gtk_entry_completion_set_match_func()
+ *
+ * A function which decides whether the row indicated by @iter matches
+ * a given @key, and should be displayed as a possible completion for @key.
+ * Note that @key is normalized and case-folded (see g_utf8_normalize()
+ * and g_utf8_casefold()). If this is not appropriate, match functions
+ * have access to the unmodified key via
+ * <literal>gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry (<!-- -->)))</literal>.
+ *
+ * Returns: %TRUE if @iter should be displayed as a possible completion
+ * for @key
+ */
typedef gboolean (* GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion,
const gchar *key,
GtkTreeIter *iter,
@@ -67,10 +84,10 @@ struct _GtkEntryCompletionClass
void (* action_activated) (GtkEntryCompletion *completion,
gint index_);
gboolean (* insert_prefix) (GtkEntryCompletion *completion,
- const gchar *prefix);
+ const gchar *prefix);
gboolean (* cursor_on_match) (GtkEntryCompletion *completion,
- GtkTreeModel *model,
- GtkTreeIter *iter);
+ GtkTreeModel *model,
+ GtkTreeIter *iter);
/* Padding for future expansion */
void (*_gtk_reserved0) (void);