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 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 match-selected and cursor-on-match take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as GtkCellLayoutDataFunc or 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.

Properties

`cell-area`

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

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

Readable | Writeable | Construct Only

`inline-completion`

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.

Readable | Writeable

`inline-selection`

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

Readable | Writeable

`minimum-key-length`

Readable | Writeable

`model`

Readable | Writeable

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

Readable | Writeable

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

Readable | Writeable

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.

Readable | Writeable

`text-column`

The column of the model containing the strings.

Note that the strings must be UTF-8.

Readable | Writeable

Signals

`cursor-on-match`

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

`insert-prefix`

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 ‘/’.

`match-selected`

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

`no-matches`

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

In other words when EntryCompletion is out of suggestions.

Implements

glib::ObjectExt, BuildableExt, CellLayoutExt, CellLayoutExtManual

Struct gtk4::EntryCompletion

Implementations§

impl EntryCompletion

pub fn new() -> EntryCompletion

pub fn with_area(area: &impl IsA<CellArea>) -> EntryCompletion

pub fn builder() -> EntryCompletionBuilder

pub fn complete(&self)

pub fn compute_prefix(&self, key: &str) -> Option<GString>

pub fn completion_prefix(&self) -> Option<GString>

pub fn is_inline_completion(&self) -> bool

pub fn is_inline_selection(&self) -> bool

pub fn minimum_key_length(&self) -> i32

pub fn model(&self) -> Option<TreeModel>

pub fn is_popup_completion(&self) -> bool

pub fn is_popup_set_width(&self) -> bool

pub fn is_popup_single_match(&self) -> bool

pub fn text_column(&self) -> i32

pub fn insert_prefix(&self)

pub fn set_inline_completion(&self, inline_completion: bool)

pub fn set_inline_selection(&self, inline_selection: bool)

pub fn set_match_func<P: Fn(&EntryCompletion, &str, &TreeIter) -> bool + 'static>( &self, func: P )

pub fn set_minimum_key_length(&self, length: i32)

pub fn set_model(&self, model: Option<&impl IsA<TreeModel>>)

pub fn set_popup_completion(&self, popup_completion: bool)

pub fn set_popup_set_width(&self, popup_set_width: bool)

pub fn set_popup_single_match(&self, popup_single_match: bool)

pub fn set_text_column(&self, column: i32)

pub fn cell_area(&self) -> Option<CellArea>

pub fn connect_cursor_on_match<F: Fn(&Self, &TreeModel, &TreeIter) -> Inhibit + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_insert_prefix<F: Fn(&Self, &str) -> Inhibit + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_match_selected<F: Fn(&Self, &TreeModel, &TreeIter) -> Inhibit + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_no_matches<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_inline_completion_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_inline_selection_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_minimum_key_length_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_popup_completion_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_popup_set_width_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_popup_single_match_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_column_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl EntryCompletion

pub fn entry(&self) -> Option<Entry>

Trait Implementations§

impl Clone for EntryCompletion

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl Debug for EntryCompletion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Default for EntryCompletion

fn default() -> Self

impl Display for EntryCompletion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl HasParamSpec for EntryCompletion

type ParamSpec = ParamSpecObject

type SetValue = EntryCompletion

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, EntryCompletion>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EntryCompletion

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Ord for EntryCompletion

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl ParentClassIs for EntryCompletion

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for EntryCompletion

fn eq(&self, other: &OT) -> bool