gtk4/auto/

entry_completion.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#![allow(deprecated)]

use crate::{Buildable, CellArea, CellLayout, TreeIter, TreeModel, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`EntryCompletion`][crate::EntryCompletion] is an auxiliary object to provide completion functionality
    /// for [`Entry`][crate::Entry].
    ///
    /// It implements the [`CellLayout`][crate::CellLayout] interface, to allow the user
    /// to add extra cells to the [`TreeView`][crate::TreeView] with completion matches.
    ///
    /// “Completion functionality” means that when the user modifies the text
    /// in the entry, [`EntryCompletion`][crate::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()`][Self::set_text_column()]), but this can be overridden
    /// with a custom match function (see [`set_match_func()`][Self::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`][struct@crate::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()`][crate::prelude::EntryExt::set_completion()].
    ///
    /// [`EntryCompletion`][crate::EntryCompletion] uses a [`TreeModelFilter`][crate::TreeModelFilter] model to
    /// represent the subset of the entire model that is currently matching.
    /// While the [`EntryCompletion`][crate::EntryCompletion] signals
    /// [`match-selected`][struct@crate::EntryCompletion#match-selected] and
    /// [`cursor-on-match`][struct@crate::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
    /// [`apply-attributes`][struct@crate::CellArea#apply-attributes])]
    /// will generally take the filter model as argument. As long as you are
    /// only calling [`TreeModelExtManual::get()`][crate::prelude::TreeModelExtManual::get()], this will make no difference to
    /// you. If for some reason, you need the original model, use
    /// [`TreeModelFilterExt::model()`][crate::prelude::TreeModelFilterExt::model()]. Don’t forget to use
    /// [`TreeModelFilterExt::convert_iter_to_child_iter()`][crate::prelude::TreeModelFilterExt::convert_iter_to_child_iter()] to obtain a
    /// matching iter.
    ///
    /// ## Properties
    ///
    ///
    /// #### `cell-area`
    ///  The [`CellArea`][crate::CellArea] used to layout cell renderers in the treeview column.
    ///
    /// If no area is specified when creating the entry completion with
    /// [`EntryCompletion::with_area()`][crate::EntryCompletion::with_area()], a horizontally oriented
    /// [`CellAreaBox`][crate::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`
    ///  The minimum key length as set for completion.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `model`
    ///  The model used as data source.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `popup-completion`
    ///  Determines whether the possible completions should be
    /// shown in a popup window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `popup-set-width`
    ///  Determines whether the completions popup window will be
    /// resized to the width of the entry.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `popup-single-match`
    ///  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`][struct@crate::EntryCompletion#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()`][crate::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`][crate::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()`][crate::EntryCompletion::set_model()].
    ///
    ///
    ///
    ///
    /// #### `no-matches`
    ///  Emitted when the filter model has zero
    /// number of rows in completion_complete method.
    ///
    /// In other words when [`EntryCompletion`][crate::EntryCompletion] is out of suggestions.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`CellLayoutExt`][trait@crate::prelude::CellLayoutExt], [`CellLayoutExtManual`][trait@crate::prelude::CellLayoutExtManual]
    #[doc(alias = "GtkEntryCompletion")]
    pub struct EntryCompletion(Object<ffi::GtkEntryCompletion>) @implements Buildable, CellLayout;

    match fn {
        type_ => || ffi::gtk_entry_completion_get_type(),
    }
}

impl EntryCompletion {
    /// Creates a new [`EntryCompletion`][crate::EntryCompletion] object.
    ///
    /// # Deprecated since 4.10
    ///
    /// GtkEntryCompletion will be removed in GTK 5.
    ///
    /// # Returns
    ///
    /// A newly created [`EntryCompletion`][crate::EntryCompletion] object
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_new")]
    pub fn new() -> EntryCompletion {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_entry_completion_new()) }
    }

    /// Creates a new [`EntryCompletion`][crate::EntryCompletion] object using the
    /// specified @area.
    ///
    /// The [`CellArea`][crate::CellArea] is used to layout cells in the underlying
    /// [`TreeViewColumn`][crate::TreeViewColumn] for the drop-down menu.
    ///
    /// # Deprecated since 4.10
    ///
    /// GtkEntryCompletion will be removed in GTK 5.
    /// ## `area`
    /// the [`CellArea`][crate::CellArea] used to layout cells
    ///
    /// # Returns
    ///
    /// A newly created [`EntryCompletion`][crate::EntryCompletion] object
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_new_with_area")]
    #[doc(alias = "new_with_area")]
    pub fn with_area(area: &impl IsA<CellArea>) -> EntryCompletion {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gtk_entry_completion_new_with_area(
                area.as_ref().to_glib_none().0,
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`EntryCompletion`] objects.
    ///
    /// This method returns an instance of [`EntryCompletionBuilder`](crate::builders::EntryCompletionBuilder) which can be used to create [`EntryCompletion`] objects.
    pub fn builder() -> EntryCompletionBuilder {
        EntryCompletionBuilder::new()
    }

    /// 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.
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_complete")]
    pub fn complete(&self) {
        unsafe {
            ffi::gtk_entry_completion_complete(self.to_glib_none().0);
        }
    }

    /// 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()`][Self::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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_compute_prefix")]
    pub fn compute_prefix(&self, key: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gtk_entry_completion_compute_prefix(
                self.to_glib_none().0,
                key.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_completion_prefix")]
    #[doc(alias = "get_completion_prefix")]
    pub fn completion_prefix(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_entry_completion_get_completion_prefix(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_inline_completion")]
    #[doc(alias = "get_inline_completion")]
    #[doc(alias = "inline-completion")]
    pub fn is_inline_completion(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_entry_completion_get_inline_completion(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_inline_selection")]
    #[doc(alias = "get_inline_selection")]
    #[doc(alias = "inline-selection")]
    pub fn is_inline_selection(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_entry_completion_get_inline_selection(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_minimum_key_length")]
    #[doc(alias = "get_minimum_key_length")]
    #[doc(alias = "minimum-key-length")]
    pub fn minimum_key_length(&self) -> i32 {
        unsafe { ffi::gtk_entry_completion_get_minimum_key_length(self.to_glib_none().0) }
    }

    /// Returns the model the [`EntryCompletion`][crate::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`][crate::TreeModel]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_model")]
    #[doc(alias = "get_model")]
    pub fn model(&self) -> Option<TreeModel> {
        unsafe { from_glib_none(ffi::gtk_entry_completion_get_model(self.to_glib_none().0)) }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_popup_completion")]
    #[doc(alias = "get_popup_completion")]
    #[doc(alias = "popup-completion")]
    pub fn is_popup_completion(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_entry_completion_get_popup_completion(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_popup_set_width")]
    #[doc(alias = "get_popup_set_width")]
    #[doc(alias = "popup-set-width")]
    pub fn is_popup_set_width(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_entry_completion_get_popup_set_width(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_popup_single_match")]
    #[doc(alias = "get_popup_single_match")]
    #[doc(alias = "popup-single-match")]
    pub fn is_popup_single_match(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_entry_completion_get_popup_single_match(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_get_text_column")]
    #[doc(alias = "get_text_column")]
    #[doc(alias = "text-column")]
    pub fn text_column(&self) -> i32 {
        unsafe { ffi::gtk_entry_completion_get_text_column(self.to_glib_none().0) }
    }

    /// Requests a prefix insertion.
    ///
    /// # Deprecated since 4.10
    ///
    /// GtkEntryCompletion will be removed in GTK 5.
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_insert_prefix")]
    pub fn insert_prefix(&self) {
        unsafe {
            ffi::gtk_entry_completion_insert_prefix(self.to_glib_none().0);
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_inline_completion")]
    #[doc(alias = "inline-completion")]
    pub fn set_inline_completion(&self, inline_completion: bool) {
        unsafe {
            ffi::gtk_entry_completion_set_inline_completion(
                self.to_glib_none().0,
                inline_completion.into_glib(),
            );
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_inline_selection")]
    #[doc(alias = "inline-selection")]
    pub fn set_inline_selection(&self, inline_selection: bool) {
        unsafe {
            ffi::gtk_entry_completion_set_inline_selection(
                self.to_glib_none().0,
                inline_selection.into_glib(),
            );
        }
    }

    /// 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 [`EntryCompletion`][crate::EntryCompletion]MatchFunc to use
    /// ## `func_data`
    /// user data for @func
    /// ## `func_notify`
    /// destroy notify for @func_data.
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_match_func")]
    pub fn set_match_func<P: Fn(&EntryCompletion, &str, &TreeIter) -> bool + 'static>(
        &self,
        func: P,
    ) {
        let func_data: Box_<P> = Box_::new(func);
        unsafe extern "C" fn func_func<
            P: Fn(&EntryCompletion, &str, &TreeIter) -> bool + 'static,
        >(
            completion: *mut ffi::GtkEntryCompletion,
            key: *const std::ffi::c_char,
            iter: *mut ffi::GtkTreeIter,
            user_data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let completion = from_glib_borrow(completion);
                let key: Borrowed<glib::GString> = from_glib_borrow(key);
                let iter = from_glib_borrow(iter);
                let callback = &*(user_data as *mut P);
                (*callback)(&completion, key.as_str(), &iter).into_glib()
            }
        }
        let func = Some(func_func::<P> as _);
        unsafe extern "C" fn func_notify_func<
            P: Fn(&EntryCompletion, &str, &TreeIter) -> bool + 'static,
        >(
            data: glib::ffi::gpointer,
        ) {
            unsafe {
                let _callback = Box_::from_raw(data as *mut P);
            }
        }
        let destroy_call3 = Some(func_notify_func::<P> as _);
        let super_callback0: Box_<P> = func_data;
        unsafe {
            ffi::gtk_entry_completion_set_match_func(
                self.to_glib_none().0,
                func,
                Box_::into_raw(super_callback0) as *mut _,
                destroy_call3,
            );
        }
    }

    /// 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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_minimum_key_length")]
    #[doc(alias = "minimum-key-length")]
    pub fn set_minimum_key_length(&self, length: i32) {
        unsafe {
            ffi::gtk_entry_completion_set_minimum_key_length(self.to_glib_none().0, length);
        }
    }

    /// Sets the model for a [`EntryCompletion`][crate::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`][crate::TreeModel]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_model")]
    #[doc(alias = "model")]
    pub fn set_model(&self, model: Option<&impl IsA<TreeModel>>) {
        unsafe {
            ffi::gtk_entry_completion_set_model(
                self.to_glib_none().0,
                model.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets whether the completions should be presented in a popup window.
    ///
    /// # Deprecated since 4.10
    ///
    /// GtkEntryCompletion will be removed in GTK 5.
    /// ## `popup_completion`
    /// [`true`] to do popup completion
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_popup_completion")]
    #[doc(alias = "popup-completion")]
    pub fn set_popup_completion(&self, popup_completion: bool) {
        unsafe {
            ffi::gtk_entry_completion_set_popup_completion(
                self.to_glib_none().0,
                popup_completion.into_glib(),
            );
        }
    }

    /// 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.
    /// ## `popup_set_width`
    /// [`true`] to make the width of the popup the same as the entry
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_popup_set_width")]
    #[doc(alias = "popup-set-width")]
    pub fn set_popup_set_width(&self, popup_set_width: bool) {
        unsafe {
            ffi::gtk_entry_completion_set_popup_set_width(
                self.to_glib_none().0,
                popup_set_width.into_glib(),
            );
        }
    }

    /// 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`][struct@crate::EntryCompletion#inline-completion].
    ///
    /// # Deprecated since 4.10
    ///
    /// GtkEntryCompletion will be removed in GTK 5.
    /// ## `popup_single_match`
    /// [`true`] if the popup should appear even for a single match
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_popup_single_match")]
    #[doc(alias = "popup-single-match")]
    pub fn set_popup_single_match(&self, popup_single_match: bool) {
        unsafe {
            ffi::gtk_entry_completion_set_popup_single_match(
                self.to_glib_none().0,
                popup_single_match.into_glib(),
            );
        }
    }

    /// 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`][crate::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
    /// [`text-column`][struct@crate::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
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_entry_completion_set_text_column")]
    #[doc(alias = "text-column")]
    pub fn set_text_column(&self, column: i32) {
        unsafe {
            ffi::gtk_entry_completion_set_text_column(self.to_glib_none().0, column);
        }
    }

    /// The [`CellArea`][crate::CellArea] used to layout cell renderers in the treeview column.
    ///
    /// If no area is specified when creating the entry completion with
    /// [`with_area()`][Self::with_area()], a horizontally oriented
    /// [`CellAreaBox`][crate::CellAreaBox] will be used.
    #[doc(alias = "cell-area")]
    pub fn cell_area(&self) -> Option<CellArea> {
        ObjectExt::property(self, "cell-area")
    }

    /// 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()`][Self::set_model()].
    /// ## `model`
    /// the [`TreeModel`][crate::TreeModel] containing the matches
    /// ## `iter`
    /// a [`TreeIter`][crate::TreeIter] positioned at the selected match
    ///
    /// # Returns
    ///
    /// [`true`] if the signal has been handled
    #[doc(alias = "cursor-on-match")]
    pub fn connect_cursor_on_match<
        F: Fn(&Self, &TreeModel, &TreeIter) -> glib::Propagation + 'static,
    >(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn cursor_on_match_trampoline<
            F: Fn(&EntryCompletion, &TreeModel, &TreeIter) -> glib::Propagation + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            model: *mut ffi::GtkTreeModel,
            iter: *mut ffi::GtkTreeIter,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    &from_glib_borrow(this),
                    &from_glib_borrow(model),
                    &from_glib_borrow(iter),
                )
                .into_glib()
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"cursor-on-match".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    cursor_on_match_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// 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`][crate::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
    #[doc(alias = "insert-prefix")]
    pub fn connect_insert_prefix<F: Fn(&Self, &str) -> glib::Propagation + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn insert_prefix_trampoline<
            F: Fn(&EntryCompletion, &str) -> glib::Propagation + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            prefix: *mut std::ffi::c_char,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    &from_glib_borrow(this),
                    &glib::GString::from_glib_borrow(prefix),
                )
                .into_glib()
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"insert-prefix".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    insert_prefix_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// 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()`][Self::set_model()].
    /// ## `model`
    /// the [`TreeModel`][crate::TreeModel] containing the matches
    /// ## `iter`
    /// a [`TreeIter`][crate::TreeIter] positioned at the selected match
    ///
    /// # Returns
    ///
    /// [`true`] if the signal has been handled
    #[doc(alias = "match-selected")]
    pub fn connect_match_selected<
        F: Fn(&Self, &TreeModel, &TreeIter) -> glib::Propagation + 'static,
    >(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn match_selected_trampoline<
            F: Fn(&EntryCompletion, &TreeModel, &TreeIter) -> glib::Propagation + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            model: *mut ffi::GtkTreeModel,
            iter: *mut ffi::GtkTreeIter,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    &from_glib_borrow(this),
                    &from_glib_borrow(model),
                    &from_glib_borrow(iter),
                )
                .into_glib()
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"match-selected".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    match_selected_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the filter model has zero
    /// number of rows in completion_complete method.
    ///
    /// In other words when [`EntryCompletion`][crate::EntryCompletion] is out of suggestions.
    #[doc(alias = "no-matches")]
    pub fn connect_no_matches<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn no_matches_trampoline<F: Fn(&EntryCompletion) + 'static>(
            this: *mut ffi::GtkEntryCompletion,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"no-matches".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    no_matches_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "inline-completion")]
    pub fn connect_inline_completion_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_inline_completion_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::inline-completion".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_inline_completion_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "inline-selection")]
    pub fn connect_inline_selection_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_inline_selection_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::inline-selection".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_inline_selection_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "minimum-key-length")]
    pub fn connect_minimum_key_length_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_minimum_key_length_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::minimum-key-length".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_minimum_key_length_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "model")]
    pub fn connect_model_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_model_trampoline<F: Fn(&EntryCompletion) + 'static>(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::model".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_model_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "popup-completion")]
    pub fn connect_popup_completion_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_popup_completion_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::popup-completion".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_popup_completion_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "popup-set-width")]
    pub fn connect_popup_set_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_popup_set_width_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::popup-set-width".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_popup_set_width_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "popup-single-match")]
    pub fn connect_popup_single_match_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_popup_single_match_trampoline<
            F: Fn(&EntryCompletion) + 'static,
        >(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::popup-single-match".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_popup_single_match_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "text-column")]
    pub fn connect_text_column_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_text_column_trampoline<F: Fn(&EntryCompletion) + 'static>(
            this: *mut ffi::GtkEntryCompletion,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::text-column".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_text_column_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for EntryCompletion {
    fn default() -> Self {
        Self::new()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`EntryCompletion`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct EntryCompletionBuilder {
    builder: glib::object::ObjectBuilder<'static, EntryCompletion>,
}

impl EntryCompletionBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The [`CellArea`][crate::CellArea] used to layout cell renderers in the treeview column.
    ///
    /// If no area is specified when creating the entry completion with
    /// [`EntryCompletion::with_area()`][crate::EntryCompletion::with_area()], a horizontally oriented
    /// [`CellAreaBox`][crate::CellAreaBox] will be used.
    pub fn cell_area(self, cell_area: &impl IsA<CellArea>) -> Self {
        Self {
            builder: self
                .builder
                .property("cell-area", cell_area.clone().upcast()),
        }
    }

    /// 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.
    pub fn inline_completion(self, inline_completion: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("inline-completion", inline_completion),
        }
    }

    /// Determines whether the possible completions on the popup
    /// will appear in the entry as you navigate through them.
    pub fn inline_selection(self, inline_selection: bool) -> Self {
        Self {
            builder: self.builder.property("inline-selection", inline_selection),
        }
    }

    /// The minimum key length as set for completion.
    pub fn minimum_key_length(self, minimum_key_length: i32) -> Self {
        Self {
            builder: self
                .builder
                .property("minimum-key-length", minimum_key_length),
        }
    }

    /// The model used as data source.
    pub fn model(self, model: &impl IsA<TreeModel>) -> Self {
        Self {
            builder: self.builder.property("model", model.clone().upcast()),
        }
    }

    /// Determines whether the possible completions should be
    /// shown in a popup window.
    pub fn popup_completion(self, popup_completion: bool) -> Self {
        Self {
            builder: self.builder.property("popup-completion", popup_completion),
        }
    }

    /// Determines whether the completions popup window will be
    /// resized to the width of the entry.
    pub fn popup_set_width(self, popup_set_width: bool) -> Self {
        Self {
            builder: self.builder.property("popup-set-width", popup_set_width),
        }
    }

    /// 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`][struct@crate::EntryCompletion#inline-completion].
    pub fn popup_single_match(self, popup_single_match: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("popup-single-match", popup_single_match),
        }
    }

    /// The column of the model containing the strings.
    ///
    /// Note that the strings must be UTF-8.
    pub fn text_column(self, text_column: i32) -> Self {
        Self {
            builder: self.builder.property("text-column", text_column),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`EntryCompletion`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> EntryCompletion {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}