Gtk.EntryCompletion¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gtk.Buildable (1), Gtk.CellLayout (9)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_with_area` (area)
	`complete` ()
	`compute_prefix` (key)
	`get_completion_prefix` ()
	`get_entry` ()
	`get_inline_completion` ()
	`get_inline_selection` ()
	`get_minimum_key_length` ()
	`get_model` ()
	`get_popup_completion` ()
	`get_popup_set_width` ()
	`get_popup_single_match` ()
	`get_text_column` ()
	`insert_prefix` ()
	`set_inline_completion` (inline_completion)
	`set_inline_selection` (inline_selection)
	`set_match_func` (func, *func_data)
	`set_minimum_key_length` (length)
	`set_model` (model)
	`set_popup_completion` (popup_completion)
	`set_popup_set_width` (popup_set_width)
	`set_popup_single_match` (popup_single_match)
	`set_text_column` (column)

Virtual Methods¶

Inherited:: GObject.Object (7), Gtk.Buildable (9), Gtk.CellLayout (9)

Properties¶

Name	Type	Flags
`cell-area`	`Gtk.CellArea`	r/w/co
`inline-completion`	`bool`	r/w/en
`inline-selection`	`bool`	r/w/en
`minimum-key-length`	`int`	r/w/en
`model`	`Gtk.TreeModel`	r/w
`popup-completion`	`bool`	r/w/en
`popup-set-width`	`bool`	r/w/en
`popup-single-match`	`bool`	r/w/en
`text-column`	`int`	r/w

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`cursor-on-match`	Emitted when a match from the cursor is on a match of the list.
`insert-prefix`	Emitted when the inline autocompletion is triggered.
`match-selected`	Emitted when a match from the list is selected.
`no-matches`	Emitted when the filter model has zero number of rows in completion_complete method.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gtk.EntryCompletion(**kwargs)¶

Bases:: GObject.Object, Gtk.Buildable, Gtk.CellLayout
Abstract:: No

GtkEntryCompletion is an auxiliary object to provide completion functionality for GtkEntry.

It implements the [iface`Gtk`.CellLayout] interface, to allow the user to add extra cells to the GtkTreeView with completion matches.

“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 [method`Gtk`.EntryCompletion.set_text_column]), but this can be overridden with a custom match function (see [method`Gtk`.EntryCompletion.set_match_func]).

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 [signal`Gtk`.EntryCompletion::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.

To add completion functionality to an entry, use [method`Gtk`.Entry.set_completion].

GtkEntryCompletion uses a [class`Gtk`.TreeModelFilter] model to represent the subset of the entire model that is currently matching. While the GtkEntryCompletion signals [signal`Gtk`.EntryCompletion::match-selected] and [signal`Gtk`.EntryCompletion::cursor-on-match] take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as GtkCellLayoutDataFunc or [signal`Gtk`.CellArea::apply-attributes)] will generally take the filter model as argument. As long as you are only calling [method`Gtk`.TreeModel.get], this will make no difference to you. If for some reason, you need the original model, use [method`Gtk`.TreeModelFilter.get_model]. Don’t forget to use [method`Gtk`.TreeModelFilter.convert_iter_to_child_iter] to obtain a matching iter.

Deprecated since version 4.10.

classmethod new()[source]¶

Returns:: A newly created GtkEntryCompletion object
Return type:: Gtk.EntryCompletion

Creates a new GtkEntryCompletion object.