Commit f2e252a2 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

Add some docs.

parent 8312109e
Mon Mar 15 02:36:07 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtkentrycompletion.c (gtk_entry_completion_class_init): Add
some signal docs.
Sun Mar 14 15:38:39 2004 Jonathan Blandford <jrb@gnome.org>
* gtk/gtkentrycompletion.c (gtk_entry_completion_visible_func):
......
Mon Mar 15 02:36:07 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtkentrycompletion.c (gtk_entry_completion_class_init): Add
some signal docs.
Sun Mar 14 15:38:39 2004 Jonathan Blandford <jrb@gnome.org>
* gtk/gtkentrycompletion.c (gtk_entry_completion_visible_func):
......
Mon Mar 15 02:36:07 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtkentrycompletion.c (gtk_entry_completion_class_init): Add
some signal docs.
Sun Mar 14 15:38:39 2004 Jonathan Blandford <jrb@gnome.org>
* gtk/gtkentrycompletion.c (gtk_entry_completion_visible_func):
......
Mon Mar 15 02:36:07 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtkentrycompletion.c (gtk_entry_completion_class_init): Add
some signal docs.
Sun Mar 14 15:38:39 2004 Jonathan Blandford <jrb@gnome.org>
* gtk/gtkentrycompletion.c (gtk_entry_completion_visible_func):
......
Mon Mar 15 02:36:07 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtkentrycompletion.c (gtk_entry_completion_class_init): Add
some signal docs.
Sun Mar 14 15:38:39 2004 Jonathan Blandford <jrb@gnome.org>
* gtk/gtkentrycompletion.c (gtk_entry_completion_visible_func):
......
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 ===
......
......@@ -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>
......
......@@ -174,6 +174,19 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
object_class->get_property = gtk_entry_completion_get_property;
object_class->finalize = gtk_entry_completion_finalize;
/**
* GtkEntryCompletion::match-selected:
* @widget: the object which received the signal
* @model: the #GtkTreeModel containing the matches
* @iter: a #GtkTreeIter positioned at the selected match
*
* The ::match-selected signal is emitted when a match from the list
* is selected. The default behaviour is to replace the contents of the
* entry with the contents of the text column in the row pointed to by
* @iter.
*
* Return value: %TRUE if the signal has been handled
*/
entry_completion_signals[MATCH_SELECTED] =
g_signal_new ("match_selected",
G_TYPE_FROM_CLASS (klass),
......@@ -184,6 +197,15 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
G_TYPE_BOOLEAN, 2,
GTK_TYPE_TREE_MODEL,
GTK_TYPE_TREE_ITER);
/**
* GtkEntryCompletion::action-activated:
* @widget: the object which received the signal
* @index: the index of the activated action
*
* The ::action-activated signal is emitted when an action
* is activated.
*/
entry_completion_signals[ACTION_ACTIVATED] =
g_signal_new ("action_activated",
G_TYPE_FROM_CLASS (klass),
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment