Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.EntryCompletion

Class Gtk.EntryCompletion

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkEntryCompletion
Class :	EntryCompletion
Implements:	Gtk.Buildable, Gtk.CellLayout
Extends:	GObject.Object

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
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
gtk_entry_completion_set_text_column()), but this can be overridden
with a custom match function (see gtk_entry_completion_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 GtkEntryCompletion::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 gtk_entry_set_completion().
In addition to regular completion matches, which will be inserted into the
entry when they are selected, GtkEntryCompletion also allows to display
"actions" in the popup window. Their appearance is similar to menuitems,
to differentiate them clearly from completion strings. When an action is
selected, the GtkEntryCompletion::action-activated signal is emitted.
GtkEntryCompletion uses a GtkTreeModelFilter model to represent the
subset of the entire model that is currently matching. While the
GtkEntryCompletion signals GtkEntryCompletion::match-selected and
GtkEntryCompletion::cursor-on-match take the original model and an
iter pointing to that model as arguments, other callbacks and signals
(such as GtkCellLayoutDataFuncs or GtkCellArea::apply-attributes)
will generally take the filter model as argument. As long as you are
only calling gtk_tree_model_get(), this will make no difference to
you. If for some reason, you need the original model, use
gtk_tree_model_filter_get_model(). Don't forget to use
gtk_tree_model_filter_convert_iter_to_child_iter() to obtain a
matching iter.

Properties
Properties		Defined By
	cell_area : Gtk.CellArea The GtkCellArea used to layout cell renderers in the treeview column. The GtkCellArea used to layout cell renderers in the treeview column. If no area is specified when creating the entry completion with gtk_entry_completion_new_with_area() a horizontally oriented GtkCellAreaBox will be used.	Gtk.EntryCompletion
	inline_completion : gboolean Determines whether the common prefix of the possible completions should be inserted automatically in the entry. 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.	Gtk.EntryCompletion
	inline_selection : gboolean Determines whether the possible completions on the popup will appear in the entry as you navigate through them. Determines whether the possible completions on the popup will appear in the entry as you navigate through them.	Gtk.EntryCompletion
	minimum_key_length : gint32	Gtk.EntryCompletion
	model : Gtk.TreeModel	Gtk.EntryCompletion
	parent_instance : GObject.Object read only	Gtk.EntryCompletion
	popup_completion : gboolean Determines whether the possible completions should be shown in a popup window. Determines whether the possible completions should be shown in a popup window.	Gtk.EntryCompletion
	popup_set_width : gboolean Determines whether the completions popup window will be resized to the width of the entry. Determines whether the completions popup window will be resized to the width of the entry.	Gtk.EntryCompletion
	popup_single_match : gboolean Determines whether the completions popup window will shown for a single possible completion. 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.	Gtk.EntryCompletion
	priv : Gtk.EntryCompletionPrivate read only	Gtk.EntryCompletion
	text_column : gint32 The column of the model containing the strings. The column of the model containing the strings. Note that the strings must be UTF-8.	Gtk.EntryCompletion

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.EntryCompletion (Object *properties) Create a new Gtk.EntryCompletion Create a new Gtk.EntryCompletion Parameters: Object properties*
	new Gtk.EntryCompletion.with_area (CellArea *area) : Gtk.EntryCompletion Create a new Gtk.EntryCompletion Create a new Gtk.EntryCompletion Parameters: Gtk.CellArea area* Required (not null) the GtkCellArea used to layout cells Returns: Gtk.EntryCompletion A newly created GtkEntryCompletion object
	add_attribute (CellRenderer *cell, String attribute, gint32 column) : none Adds an attribute mapping to the list in cell_layout. Adds an attribute mapping to the list in cell_layout. The column* is the column of the model to get a value from, and the example if column 2 of the model contains strings, you could have the "text" attribute of a GtkCellRendererText get its values from column 2. Parameters: Gtk.CellRenderer cell Required (not null) a GtkCellRenderer String attribute Required (not null) an attribute on the renderer gint32 column Required (not null) the column position on the model to get the attribute from Returns: none	Gtk.CellLayout
	add_child (Builder *builder, Object child, String type) : none Adds a child to buildable. Adds a child to buildable. type* is an optional string describing how the child should be added. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder GObject.Object child Required (not null) child to add String type kind of child or NULL Returns: none	Gtk.Buildable
	clear () : none Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout. Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout. Returns: none	Gtk.CellLayout
	clear_attributes (CellRenderer *cell) : none Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). Parameters: Gtk.CellRenderer cell* Required (not null) a GtkCellRenderer to clear the attribute mapping on Returns: none	Gtk.CellLayout
	complete () : none Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key. 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. Returns: none	Gtk.EntryCompletion
	construct_child (Builder *builder, String name) : GObject.Object Constructs a child of buildable* with the name name. Constructs a child of buildable with the name name. GtkBuilder calls this function if a "constructor" has been specified in the UI definition. Parameters: Gtk.Builder builder Required (not null) GtkBuilder used to construct this object String name Required (not null) name of child to construct Returns: GObject.Object the constructed child	Gtk.Buildable
	custom_finished (Builder *builder, Object child, String tagname, void *data) : none This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder GObject.Object child child object or NULL for non-child tags String tagname Required (not null) the name of the tag void* data Required (not null) user data created in custom_tag_start Returns: none	Gtk.Buildable
	custom_tag_end (Builder *builder, Object child, String tagname, void *data) : none This is called at the end of each custom element handled by the buildable. This is called at the end of each custom element handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag void* data Required (not null) user data that will be passed in to parser functions Returns: none	Gtk.Buildable
	custom_tag_start (Builder *builder, Object child, String tagname, Object out_values) : gboolean This is called for each unknown element under <child>. This is called for each unknown element under <child>. if it doesn't. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag Object out_values GLib.MarkupParser parser void* data Returns: gboolean TRUE if a object has a custom implementation, FALSE	Gtk.Buildable
	delete_action (gint32 *index_) : none Deletes the action at index_* from completion's action list. Deletes the action at index_ from completion's action list. Parameters: gint32 index_ Required (not null) the index of the item to delete Returns: none	Gtk.EntryCompletion
	get_area () : Gtk.CellArea Returns the underlying GtkCellArea which might be cell_layout if called on a GtkCellArea or might be NULL if no GtkCellArea is used by cell_layout. Returns the underlying GtkCellArea which might be cell_layout if called on a GtkCellArea or might be NULL if no GtkCellArea is used by cell_layout. Returns: Gtk.CellArea the cell area used by cell_layout.	Gtk.CellLayout
	get_cells () : Array Returns the cell renderers which have been added to cell_layout. Returns the cell renderers which have been added to cell_layout. a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed. Returns: Array	Gtk.CellLayout
	get_completion_prefix () : String Get the original text entered by the user that triggered the completion or NULL if there's no completion ongoing. Get the original text entered by the user that triggered the completion or NULL if there's no completion ongoing. Returns: String the prefix for the current completion	Gtk.EntryCompletion
	get_entry () : Gtk.Widget Gets the entry completion has been attached to. Gets the entry completion has been attached to. Returns: Gtk.Widget The entry completion has been attached to	Gtk.EntryCompletion
	get_inline_completion () : gboolean Returns whether the common prefix of the possible completions should be automatically inserted in the entry. Returns whether the common prefix of the possible completions should be automatically inserted in the entry. Returns: gboolean TRUE if inline completion is turned on	Gtk.EntryCompletion
	get_inline_selection () : gboolean Returns TRUE if inline-selection mode is turned on. Returns TRUE if inline-selection mode is turned on. Returns: gboolean TRUE if inline-selection mode is on	Gtk.EntryCompletion
	get_internal_child (Builder *builder, String childname) : GObject.Object Get the internal child called childname* of the buildable object. Get the internal child called childname of the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String childname Required (not null) name of child Returns: GObject.Object the internal child of the buildable object	Gtk.Buildable
	get_minimum_key_length () : gint32 Returns the minimum key length as set for completion. Returns the minimum key length as set for completion. Returns: gint32 The currently used minimum key length	Gtk.EntryCompletion
	get_model () : Gtk.TreeModel Returns the model the GtkEntryCompletion is using as data source. Returns the model the GtkEntryCompletion is using as data source. Returns NULL if the model is unset. is currently being used Returns: Gtk.TreeModel A GtkTreeModel, or NULL if none	Gtk.EntryCompletion
	get_name () : String Gets the name of the buildable object. Gets the name of the buildable object. GtkBuilder sets the name based on the the GtkBuilder UI definition used to construct the buildable. Returns: String the name set with gtk_buildable_set_name()	Gtk.Buildable
	get_popup_completion () : gboolean Returns whether the completions should be presented in a popup window. Returns whether the completions should be presented in a popup window. Returns: gboolean TRUE if popup completion is turned on	Gtk.EntryCompletion
	get_popup_set_width () : gboolean Returns whether the completion popup window will be resized to the width of the entry. Returns whether the completion popup window will be resized to the width of the entry. the entry Returns: gboolean TRUE if the popup window will be resized to the width of	Gtk.EntryCompletion
	get_popup_single_match () : gboolean Returns whether the completion popup window will appear even if there is only a single match. Returns whether the completion popup window will appear even if there is only a single match. number of matches Returns: gboolean TRUE if the popup window will appear regardless of the	Gtk.EntryCompletion
	get_text_column () : gint32 Returns the column in the model of completion to get strings from. Returns the column in the model of completion to get strings from. Returns: gint32 the column containing the strings	Gtk.EntryCompletion
	insert_action_markup (gint32 *index_, String markup) : none Inserts an action in completion's action item list at position index_* with markup markup. Inserts an action in completion's action item list at position index_ with markup markup. Parameters: gint32 index_ Required (not null) the index of the item to insert String markup Required (not null) markup of the item to insert Returns: none	Gtk.EntryCompletion
	insert_action_text (gint32 *index_, String text) : none Inserts an action in completion's action item list at position index_* with text 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(). Parameters: gint32 index_ Required (not null) the index of the item to insert String text Required (not null) text of the item to insert Returns: none	Gtk.EntryCompletion
	insert_prefix () : none Requests a prefix insertion. Requests a prefix insertion. Returns: none	Gtk.EntryCompletion
	pack_end (CellRenderer *cell, gboolean expand) : none Adds the cell* to the end of cell_layout. Adds the cell to the end of cell_layout. If expand is FALSE, then the divided evenly between cells for which expand is TRUE. Note that reusing the same cell renderer is not supported. Parameters: Gtk.CellRenderer cell Required (not null) a GtkCellRenderer gboolean expand Required (not null) TRUE if cell is to be given extra space allocated to cell_layout Returns: none	Gtk.CellLayout
	pack_start (CellRenderer *cell, gboolean expand) : none Packs the cell* into the beginning of cell_layout. Packs the cell into the beginning of cell_layout. If expand is FALSE, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is TRUE. Note that reusing the same cell renderer is not supported. Parameters: Gtk.CellRenderer cell Required (not null) a GtkCellRenderer gboolean expand Required (not null) TRUE if cell is to be given extra space allocated to cell_layout Returns: none	Gtk.CellLayout
	parser_finished (Builder *builder) : none Called when the builder finishes the parsing of a GtkBuilder UI definition. Called when the builder finishes the parsing of a GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder Returns: none	Gtk.Buildable
	reorder (CellRenderer *cell, gint32 position) : none Re-inserts cell* at position. Re-inserts cell at position. Note that cell has already to be packed into cell_layout for this to function properly. Parameters: Gtk.CellRenderer cell Required (not null) a GtkCellRenderer to reorder gint32 position Required (not null) new position to insert cell at Returns: none	Gtk.CellLayout
	set_buildable_property (Builder *builder, String name, Value value) : none Sets the property name name* to value on the buildable object. Sets the property name name to value on the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String name Required (not null) name of property GObject.Value value Required (not null) value of property Returns: none	Gtk.Buildable
	set_cell_data_func (CellRenderer *cell, Function func, void *func_data, Function destroy) : none Sets the GtkCellLayoutDataFunc* to use for cell_layout. Sets the GtkCellLayoutDataFunc to use for cell_layout. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of cell_layout's cell renderer(s) as appropriate. Parameters: Gtk.CellRenderer cell Required (not null) a GtkCellRenderer Function (CellLayout *cell_layout, CellRenderer cell, TreeModel tree_model, TreeIter iter, void *data) : none the GtkCellLayoutDataFunc* to use, or NULL void* func_data Required (not null) user data for func Function (void* *data) : none Required (not null) destroy notify for func_data* Returns: none	Gtk.CellLayout
	set_inline_completion (gboolean *inline_completion) : none Sets whether the common prefix of the possible completions should be automatically inserted in the entry. Sets whether the common prefix of the possible completions should be automatically inserted in the entry. Parameters: gboolean inline_completion* Required (not null) TRUE to do inline completion Returns: none	Gtk.EntryCompletion
	set_inline_selection (gboolean *inline_selection) : none Sets whether it is possible to cycle through the possible completions inside the entry. Sets whether it is possible to cycle through the possible completions inside the entry. Parameters: gboolean inline_selection* Required (not null) TRUE to do inline selection Returns: none	Gtk.EntryCompletion
	set_match_func (Function *func, void *func_data, Function func_notify) : none Sets the match function for completion* to be func. 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. Parameters: Function (EntryCompletion *completion, String key, TreeIter iter, void *user_data) : none Required (not null) the GtkEntryCompletionMatchFunc* to use void* func_data Required (not null) user data for func Function (void* *data) : none Required (not null) destroy notify for func_data*. Returns: none	Gtk.EntryCompletion
	set_minimum_key_length (gint32 *length) : none Requires the length of the search key for completion* to be at least key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset). Requires the length of the search key for completion to be at least key takes a lot of time and will come up with meaningless results anyway (ie, a too large dataset). Parameters: gint32 length Required (not null) the minimum length of the key in order to start completing Returns: none	Gtk.EntryCompletion
	set_model (TreeModel *model) : none Sets the model for a GtkEntryCompletion. 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. Parameters: Gtk.TreeModel model the GtkTreeModel Returns: none	Gtk.EntryCompletion
	set_name (String *name) : none Sets the name of the buildable* object. Sets the name of the buildable object. Parameters: String name Required (not null) name to set Returns: none	Gtk.Buildable
	set_popup_completion (gboolean *popup_completion) : none Sets whether the completions should be presented in a popup window. Sets whether the completions should be presented in a popup window. Parameters: gboolean popup_completion* Required (not null) TRUE to do popup completion Returns: none	Gtk.EntryCompletion
	set_popup_set_width (gboolean *popup_set_width) : none Sets whether the completion popup window will be resized to be the same width as the entry. Sets whether the completion popup window will be resized to be the same width as the entry. Parameters: gboolean popup_set_width* Required (not null) TRUE to make the width of the popup the same as the entry Returns: none	Gtk.EntryCompletion
	set_popup_single_match (gboolean *popup_single_match) : none Sets whether the completion popup window will appear even if there is only a 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. Parameters: gboolean popup_single_match Required (not null) TRUE if the popup should appear even for a single match Returns: none	Gtk.EntryCompletion
	set_text_column (gint32 *column) : none completion list with just strings. 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 GtkEntryCompletion:text-column property directly. Parameters: gint32 column Required (not null) the column in the model of completion to get strings from Returns: none	Gtk.EntryCompletion

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	action_activated (EntryCompletion *self, gint32 index) : none Gets emitted when an action is activated. Gets emitted when an action is activated. Parameters: Gtk.EntryCompletion self* gint32 index Returns: {none}	Gtk.EntryCompletion
	cursor_on_match (EntryCompletion *self, TreeModel model, TreeIter iter) : gboolean Gets emitted when a match from the cursor is on a match of the list. 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. Note that model* is the model that was passed to gtk_entry_completion_set_model(). Parameters: Gtk.EntryCompletion self Gtk.TreeModel model Gtk.TreeIter iter Returns: {gboolean}	Gtk.EntryCompletion
	insert_prefix (EntryCompletion *self, String prefix) : gboolean Gets emitted when the inline autocompletion is triggered. 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 '/'. Parameters: Gtk.EntryCompletion self String prefix Returns: {gboolean}	Gtk.EntryCompletion
	match_selected (EntryCompletion *self, TreeModel model, TreeIter iter) : gboolean Gets emitted when a match from the list is selected. 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. Note that model* is the model that was passed to gtk_entry_completion_set_model(). Parameters: Gtk.EntryCompletion self Gtk.TreeModel model Gtk.TreeIter iter Returns: {gboolean}	Gtk.EntryCompletion

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.Entry Method	get_completion () : Gtk.EntryCompletion Returns the auxiliary completion object currently in use by entry.
Gtk.Entry Method	set_completion (EntryCompletion *completion) : none Sets completion* to be the auxiliary completion object to use with entry.