summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2004-03-15 01:32:20 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2004-03-15 01:32:20 +0000
commitf2e252a2c26c589a3fdd13bf0606a25f7ae076eb (patch)
tree8075a181d12efc68bde479b1fe55bf02b6b452e0 /docs
parent8312109e1ae92dd35810bab45abeb6ddf1b17e72 (diff)
downloadgdk-pixbuf-f2e252a2c26c589a3fdd13bf0606a25f7ae076eb.tar.gz
Add some docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog4
-rw-r--r--docs/reference/gtk/tmpl/gtkentrycompletion.sgml16
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index b2f5c52fc..5c2c4e820 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+Mon Mar 15 02:36:32 2004 Matthias Clasen <maclas@gmx.de>
+
+ * gtk/tmpl/gtkentrycompletion.sgml: Add some docs.
+
Tue Mar 9 09:34:10 2004 Owen Taylor <otaylor@redhat.com>
* === Released 2.3.6 ===
diff --git a/docs/reference/gtk/tmpl/gtkentrycompletion.sgml b/docs/reference/gtk/tmpl/gtkentrycompletion.sgml
index 7bb0cc98e..48f525e95 100644
--- a/docs/reference/gtk/tmpl/gtkentrycompletion.sgml
+++ b/docs/reference/gtk/tmpl/gtkentrycompletion.sgml
@@ -12,6 +12,22 @@ completion functionality for GtkEntry
#GtkTreeView with completion matches.
</para>
<para>
+"Completion functionality" means that when the user modifies the text
+in the entry, #GtkEntryCompletion checks which rows in the model match
+the current content of the entry, and displays a list of matches.
+By default, the matching is done by comparing the entry text
+case-insensitively against the text column of the model (see
+gtk_entry_completion_set_text_column()), but this can be overridden with
+a custom match function (see gtk_entry_completion_set_match_func()).
+</para>
+<para>
+When the user selects a completion, the content of the entry is updated.
+By default, the content of the entry is replaced by the text column of the
+model, but this can be overridden by connecting to the ::match-selected signal
+and updating the entry in the signal handler. Note that you should return
+%TRUE from the signal handler to suppress the default behaviour.
+</para>
+<para>
To add completion functionality to an entry, use gtk_entry_set_completion().
</para>
<para>