Struct gtk4::EntryCompletion

source ·
#[repr(transparent)]
pub struct EntryCompletion { /* private fields */ }
Expand description

EntryCompletion is an auxiliary object to provide completion functionality for Entry.

It implements the CellLayout interface, to allow the user to add extra cells to the TreeView with completion matches.

“Completion functionality” means that when the user modifies the text in the entry, EntryCompletion 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 set_text_column()), but this can be overridden with a custom match function (see 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::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 EntryExt::set_completion().

EntryCompletion uses a TreeModelFilter model to represent the subset of the entire model that is currently matching. While the EntryCompletion signals signal::EntryCompletion::match-selected and signal::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::CellArea::apply-attributes)] will generally take the filter model as argument. As long as you are only calling TreeModelExtManual::get(), this will make no difference to you. If for some reason, you need the original model, use TreeModelFilterExt::model(). Don’t forget to use TreeModelFilterExt::convert_iter_to_child_iter() to obtain a matching iter.

Implements

glib::ObjectExt, BuildableExt, CellLayoutExt, CellLayoutExtManual

Implementations§

Creates a new EntryCompletion object.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

A newly created EntryCompletion object

Creates a new EntryCompletion object using the specified @area.

The CellArea is used to layout cells in the underlying TreeViewColumn for the drop-down menu.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

area

the CellArea used to layout cells

Returns

A newly created EntryCompletion object

Creates a new builder-pattern struct instance to construct EntryCompletion objects.

This method returns an instance of EntryCompletionBuilder which can be used to create EntryCompletion objects.

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.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Computes the common prefix that is shared by all rows in @self that start with @key.

If no row matches @key, None will be returned. Note that a text column must have been set for this function to work, see set_text_column() for details.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

key

The text to complete for

Returns

The common prefix all rows starting with @key

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

the prefix for the current completion

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

true if inline completion is turned on

Returns true if inline-selection mode is turned on.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

true if inline-selection mode is on

Returns the minimum key length as set for @self.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

The currently used minimum key length

Returns the model the EntryCompletion is using as data source.

Returns None if the model is unset.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

A TreeModel

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

true if popup completion is turned on

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

true if the popup window will be resized to the width of the entry

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

true if the popup window will appear regardless of the number of matches

Returns the column in the model of @self to get strings from.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

the column containing the strings

Requests a prefix insertion.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

inline_completion

true to do inline completion

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

inline_selection

true to do inline selection

Sets the match function for @self to be @func.

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

func

the EntryCompletionMatchFunc to use

func_data

user data for @func

func_notify

destroy notify for @func_data.

Requires the length of the search key for @self 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).

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

length

the minimum length of the key in order to start completing

Sets the model for a EntryCompletion.

If @self already has a model set, it will remove it before setting the new model. If model is None, then it will unset the model.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

model

the TreeModel

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true to do popup completion

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

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true to make the width of the popup the same as the entry

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 property::EntryCompletion::inline-completion.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

true if the popup should appear even for a single match

Convenience function for setting up the most used case of this code: a completion list with just strings.

This function will set up @self to have a list displaying all (and just) strings in the completion list, and to get those strings from @column in the model of @self.

This functions creates and adds a CellRendererText 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 property::EntryCompletion::text-column property directly.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

column

the column in the model of @self to get strings from

The CellArea used to layout cell renderers in the treeview column.

If no area is specified when creating the entry completion with with_area(), a horizontally oriented CellAreaBox will be used.

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 set_model().

model

the TreeModel containing the matches

iter

a TreeIter positioned at the selected match

Returns

true if the signal has been handled

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 FileChooser inserts only the part of the prefix up to the next ‘/’.

prefix

the common prefix of all possible completions

Returns

true if the signal has been handled

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 set_model().

model

the TreeModel containing the matches

iter

a TreeIter positioned at the selected match

Returns

true if the signal has been handled

Emitted when the filter model has zero number of rows in completion_complete method.

In other words when EntryCompletion is out of suggestions.

Gets the entry @self has been attached to.

Deprecated since 4.10

GtkEntryCompletion will be removed in GTK 5.

Returns

The entry @self has been attached to

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Returns the type identifier of Self.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns true if the object is an instance of (can be cast to) T.
Returns the type of the object.
Returns the ObjectClass of the object. Read more
Returns the class of the object.
Returns the class of the object in the given type T. Read more
Returns the interface T of the object. Read more
Sets the property property_name of the object to value value. Read more
Sets the property property_name of the object to value value. Read more
Sets multiple properties of the object at once. Read more
Sets multiple properties of the object at once. Read more
Gets the property property_name of the object and cast it to the type V. Read more
Gets the property property_name of the object. Read more
Check if the object has a property property_name of the given type_. Read more
Get the type of the property property_name of this object. Read more
Get the ParamSpec of the property property_name of this object.
Return all ParamSpec of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect a closure to the signal signal_name on this object. Read more
Connect a closure to the signal signal_id on this object. Read more
Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures. Read more
Emit signal by signal id. Read more
Same as Self::emit but takes Value for the arguments.
Emit signal by its name. Read more
Emit signal by its name. Read more
Emit signal by its name with details. Read more
Emit signal by its name with details. Read more
Emit signal by signal id with details. Read more
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
Downgrade this object to a weak reference.
Add a callback to be notified when the Object is disposed.
Add a callback to be notified when the Object is disposed. Read more
Bind property source_property on this object to the target_property on the target object. Read more
Returns the strong reference count of this object.
Runs the dispose mechanism of the object. Read more
Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.