struct GtkEntryCompletion

struct GtkEntryCompletion;

The GtkEntryCompletion struct contains only private data.

GtkEntryCompletionMatchFunc ()

gboolean    (*GtkEntryCompletionMatchFunc)  (GtkEntryCompletion *completion,
                                             const gchar *key,
                                             GtkTreeIter *iter,
                                             gpointer user_data);

A function which decides whether the row indicated by iter matches a given key, and should be displayed as a possible completion for key.

gtk_entry_completion_new ()

GtkEntryCompletion* gtk_entry_completion_new
                                            (void);

Creates a new GtkEntryCompletion object.

Since 2.4

gtk_entry_completion_get_entry ()

GtkWidget*  gtk_entry_completion_get_entry  (GtkEntryCompletion *completion);

Gets the entry completion has been attached to.

Since 2.4

gtk_entry_completion_set_model ()

void        gtk_entry_completion_set_model  (GtkEntryCompletion *completion,
                                             GtkTreeModel *model);

Sets the model for a GtkEntryCompletion. If completion already has a model set, it will remove it before setting the new model. If model is NULL, then it will unset the model.

Since 2.4

gtk_entry_completion_get_model ()

GtkTreeModel* gtk_entry_completion_get_model
                                            (GtkEntryCompletion *completion);

Returns the model the GtkEntryCompletion is using as data source. Returns NULL if the model is unset.

Since 2.4

gtk_entry_completion_set_match_func ()

void        gtk_entry_completion_set_match_func
                                            (GtkEntryCompletion *completion,
                                             GtkEntryCompletionMatchFunc func,
                                             gpointer func_data,
                                             GDestroyNotify func_notify);

Sets the match function for completion to be func. The match function is used to determine if a row should or should not be in the completion list.

Since 2.4.

gtk_entry_completion_set_minimum_key_length ()

void        gtk_entry_completion_set_minimum_key_length
                                            (GtkEntryCompletion *completion,
                                             gint length);

Requires the length of the search key for completion to be at least length. This is useful for long lists, where completing using a small key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset).

Since 2.4

gtk_entry_completion_get_minimum_key_length ()

gint        gtk_entry_completion_get_minimum_key_length
                                            (GtkEntryCompletion *completion);

Returns the minimum key length as set for completion.

Since 2.4

gtk_entry_completion_complete ()

void        gtk_entry_completion_complete   (GtkEntryCompletion *completion);

Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. The completion list view will be updated accordingly.

Since 2.4

gtk_entry_completion_insert_action_text ()

void        gtk_entry_completion_insert_action_text
                                            (GtkEntryCompletion *completion,
                                             gint index_,
                                             const gchar *text);

Inserts an action in completion's action item list at position index_ with text text. If you want the action item to have markup, use gtk_entry_completion_insert_action_markup().

Since 2.4

gtk_entry_completion_insert_action_markup ()

void        gtk_entry_completion_insert_action_markup
                                            (GtkEntryCompletion *completion,
                                             gint index_,
                                             const gchar *markup);

Inserts an action in completion's action item list at position index_ with markup markup.

Since 2.4

gtk_entry_completion_delete_action ()

void        gtk_entry_completion_delete_action
                                            (GtkEntryCompletion *completion,
                                             gint index_);

Deletes the action at index_ from completion's action list.

Since 2.4

gtk_entry_completion_set_text_column ()

void        gtk_entry_completion_set_text_column
                                            (GtkEntryCompletion *completion,
                                             gint column);

Convenience function for setting up the most used case of this code: a completion list with just strings. This function will set up completion to have a list displaying all (and just) strings in the completion list, and to get those strings from column in the model of completion.

This functions creates and adds a GtkCellRendererText for the selected column.

Since 2.4

The "minimum-key-length" property

  "minimum-key-length"   gint                  : Read / Write

Minimum length of the search key in order to look up matches.

Allowed values: >= -1

Default value: 1

The "model" property

  "model"                GtkTreeModel          : Read / Write

The model to find matches in.

The "action-activated" signal

void        user_function                  (GtkEntryCompletion *widget,
                                            gint index,
                                            gpointer user_data);

The ::action-activated signal is emitted when an action is activated.

The "match-selected" signal

gboolean    user_function                  (GtkEntryCompletion *widget,
                                            GtkTreeModel *model,
                                            GtkTreeIter *iter,
                                            gpointer user_data);

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.