GtkEntryCompletion

typedef struct _GtkEntryCompletion 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. 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 gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ())).

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_get_completion_prefix ()

const gchar *       gtk_entry_completion_get_completion_prefix
                                                        (GtkEntryCompletion *completion);

Get the original text entered by the user that triggered the completion or NULL if there's no completion ongoing.

Since 2.12

gtk_entry_completion_insert_prefix ()

void                gtk_entry_completion_insert_prefix  (GtkEntryCompletion *completion);

Requests a prefix insertion.

Since 2.6

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. If you need to set the text column, but don't want the cell renderer, use g_object_set() to set the ::text_column property directly.

Since 2.4

gtk_entry_completion_get_text_column ()

gint                gtk_entry_completion_get_text_column
                                                        (GtkEntryCompletion *completion);

Returns the column in the model of completion to get strings from.

Since 2.6

gtk_entry_completion_set_inline_completion ()

void                gtk_entry_completion_set_inline_completion
                                                        (GtkEntryCompletion *completion,
                                                         gboolean inline_completion);

Sets whether the common prefix of the possible completions should be automatically inserted in the entry.

Since 2.6

gtk_entry_completion_get_inline_completion ()

gboolean            gtk_entry_completion_get_inline_completion
                                                        (GtkEntryCompletion *completion);

Returns whether the common prefix of the possible completions should be automatically inserted in the entry.

Since 2.6

gtk_entry_completion_set_inline_selection ()

void                gtk_entry_completion_set_inline_selection
                                                        (GtkEntryCompletion *completion,
                                                         gboolean inline_selection);

Sets whether it is possible to cycle through the possible completions inside the entry.

Since 2.12

gtk_entry_completion_get_inline_selection ()

gboolean            gtk_entry_completion_get_inline_selection
                                                        (GtkEntryCompletion *completion);

Returns TRUE if inline-selection mode is turned on.

Since 2.12

gtk_entry_completion_set_popup_completion ()

void                gtk_entry_completion_set_popup_completion
                                                        (GtkEntryCompletion *completion,
                                                         gboolean popup_completion);

Sets whether the completions should be presented in a popup window.

Since 2.6

gtk_entry_completion_get_popup_completion ()

gboolean            gtk_entry_completion_get_popup_completion
                                                        (GtkEntryCompletion *completion);

Returns whether the completions should be presented in a popup window.

Since 2.6

gtk_entry_completion_set_popup_set_width ()

void                gtk_entry_completion_set_popup_set_width
                                                        (GtkEntryCompletion *completion,
                                                         gboolean popup_set_width);

Sets whether the completion popup window will be resized to be the same width as the entry.

Since 2.8

gtk_entry_completion_get_popup_set_width ()

gboolean            gtk_entry_completion_get_popup_set_width
                                                        (GtkEntryCompletion *completion);

Returns whether the completion popup window will be resized to the width of the entry.

Since 2.8

gtk_entry_completion_set_popup_single_match ()

void                gtk_entry_completion_set_popup_single_match
                                                        (GtkEntryCompletion *completion,
                                                         gboolean popup_single_match);

Sets whether the completion popup window will appear even if there is only a single match. You may want to set this to FALSE if you are using inline completion.

Since 2.8

gtk_entry_completion_get_popup_single_match ()

gboolean            gtk_entry_completion_get_popup_single_match
                                                        (GtkEntryCompletion *completion);

Returns whether the completion popup window will appear even if there is only a single match.

Since 2.8

The "inline-completion" property

  "inline-completion"        gboolean              : Read / Write

Determines whether the common prefix of the possible completions should be inserted automatically in the entry. Note that this requires text-column to be set, even if you are using a custom match function.

Default value: FALSE

Since 2.6

The "inline-selection" property

  "inline-selection"         gboolean              : Read / Write

Determines whether the possible completions on the popup will appear in the entry as you navigate through them.

Default value: FALSE

Since 2.12

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: >= 0

Default value: 1

The "model" property

  "model"                    GtkTreeModel*         : Read / Write

The model to find matches in.

The "popup-completion" property

  "popup-completion"         gboolean              : Read / Write

Determines whether the possible completions should be shown in a popup window.

Default value: TRUE

Since 2.6

The "popup-set-width" property

  "popup-set-width"          gboolean              : Read / Write

Determines whether the completions popup window will be resized to the width of the entry.

Default value: TRUE

Since 2.8

The "popup-single-match" property

  "popup-single-match"       gboolean              : Read / Write

Determines whether the completions popup window will shown for a single possible completion. You probably want to set this to FALSE if you are using inline completion.

Default value: TRUE

Since 2.8

The "text-column" property

  "text-column"              gint                  : Read / Write

The column of the model containing the strings. Note that the strings must be UTF-8.

Allowed values: >= G_MAXULONG

Default value: -1

Since 2.6

The "action-activated" signal

void                user_function                      (GtkEntryCompletion *widget,
                                                        gint                index,
                                                        gpointer            user_data)      : Run Last

Gets emitted when an action is activated.

Since 2.4

The "cursor-on-match" signal

gboolean            user_function                      (GtkEntryCompletion *widget,
                                                        GtkTreeModel       *model,
                                                        GtkTreeIter        *iter,
                                                        gpointer            user_data)      : Run Last

Gets emitted when a match from the cursor is on a match of the list.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.

Since 2.12

The "insert-prefix" signal

gboolean            user_function                      (GtkEntryCompletion *widget,
                                                        gchar              *prefix,
                                                        gpointer            user_data)      : Run Last

Gets emitted when the inline autocompletion is triggered. The default behaviour is to make the entry display the whole prefix and select the newly inserted part.

Applications may connect to this signal in order to insert only a smaller part of the prefix into the entry - e.g. the entry used in the GtkFileChooser inserts only the part of the prefix up to the next '/'.

Since 2.6

The "match-selected" signal

gboolean            user_function                      (GtkEntryCompletion *widget,
                                                        GtkTreeModel       *model,
                                                        GtkTreeIter        *iter,
                                                        gpointer            user_data)      : Run Last

Gets 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.

Since 2.4