gtk2/docs/reference/gtk/tmpl/gtkentrycompletion.sgml

182 lines
3.0 KiB
Plaintext
Raw Normal View History

<!-- ##### SECTION Title ##### -->
GtkEntryCompletion
<!-- ##### SECTION Short_Description ##### -->
completion functionality for GtkEntry
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkEntryCompletion is an auxiliary object to be used in conjunction with
#GtkEntry to provide the completion functionality. It implements the
#GtkCellLayout interface, to allow the user to add extra cells to the
TreeView with completion matches.
</para>
<para>
To add completion functionality to an entry, use gtk_entry_set_completion().
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkEntryCompletion ##### -->
<para>
The GtkEntryCompletion struct contains only private data.
</para>
<!-- ##### SIGNAL GtkEntryCompletion::action-activated ##### -->
<para>
</para>
@entrycompletion: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkEntryCompletion::match-selected ##### -->
<para>
</para>
@entrycompletion: the object which received the signal.
@arg1:
@arg2:
@Returns:
<!-- ##### ARG GtkEntryCompletion:minimum-key-length ##### -->
<para>
</para>
<!-- ##### ARG GtkEntryCompletion:model ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GtkEntryCompletionMatchFunc ##### -->
<para>
A function which decides whether the row indicated by @iter matches a given
@key, and should be displayed as a possible completion for @key.
</para>
@completion: the #GtkEntryCompletion
@key: the string to match
@iter: a #GtkTreeIter indicating the row to match
@user_data: user data given to gtk_entry_completion_set_match_func()
@Returns: %TRUE if @iter should be displayed as a possible completion for @key
<!-- ##### FUNCTION gtk_entry_completion_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_entry_completion_get_entry ##### -->
<para>
</para>
@completion:
@Returns:
<!-- # Unused Parameters # -->
@entry:
<!-- ##### FUNCTION gtk_entry_completion_set_model ##### -->
<para>
</para>
@completion:
@model:
<!-- ##### FUNCTION gtk_entry_completion_get_model ##### -->
<para>
</para>
@completion:
@Returns:
<!-- ##### FUNCTION gtk_entry_completion_set_match_func ##### -->
<para>
</para>
@completion:
@func:
@func_data:
@func_notify:
<!-- ##### FUNCTION gtk_entry_completion_set_minimum_key_length ##### -->
<para>
</para>
@completion:
@length:
<!-- ##### FUNCTION gtk_entry_completion_get_minimum_key_length ##### -->
<para>
</para>
@completion:
@Returns:
<!-- ##### FUNCTION gtk_entry_completion_complete ##### -->
<para>
</para>
@completion:
<!-- ##### FUNCTION gtk_entry_completion_insert_action_text ##### -->
<para>
</para>
@completion:
@index:
@text:
<!-- ##### FUNCTION gtk_entry_completion_insert_action_markup ##### -->
<para>
</para>
@completion:
@index:
@markup:
<!-- ##### FUNCTION gtk_entry_completion_delete_action ##### -->
<para>
</para>
@completion:
@index:
<!-- ##### FUNCTION gtk_entry_completion_set_text_column ##### -->
<para>
</para>
@completion:
@column: