gtk4/org.gtkkn.bindings.gtk/EntryCompletion

EntryCompletion

open class EntryCompletion( val gtkEntryCompletionPointer: <Error class: unknown class><<Error class: unknown class>>) : Buildable, CellLayout(source)

⚠️ Deprecated ⚠️

This is deprecated since version 4.10.

---

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

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

“Completion functionality” means that when the user modifies the text in the entry, GtkEntryCompletion checks which rows in the model match the current content of the entry, and displays a list of matches. By default, the matching is done by comparing the entry text case-insensitively against the text column of the model (see method@Gtk.EntryCompletion.set_text_column), but this can be overridden with a custom match function (see method@Gtk.EntryCompletion.set_match_func).

When the user selects a completion, the content of the entry is updated. By default, the content of the entry is replaced by the text column of the model, but this can be overridden by connecting to the signal@Gtk.EntryCompletion::match-selected signal and updating the entry in the signal handler. Note that you should return true from the signal handler to suppress the default behaviour.

To add completion functionality to an entry, use method@Gtk.Entry.set_completion.

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

Skipped during bindings generation

method cell-area: Property has no getter nor setter

Constructors

EntryCompletion

constructor()

This is deprecated since version 4.10.

constructor(area: CellArea)

This is deprecated since version 4.10.

constructor(gtkEntryCompletionPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellLayoutPointer

open override val gtkCellLayoutPointer: <Error class: unknown class><<Error class: unknown class>>

gtkEntryCompletionPointer

val gtkEntryCompletionPointer: <Error class: unknown class><<Error class: unknown class>>

inlineCompletion

open var inlineCompletion: Boolean

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

inlineSelection

open var inlineSelection: Boolean

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

minimumKeyLength

open var minimumKeyLength: <Error class: unknown class>

The minimum key length as set for completion.

model

open var model: TreeModel?

The model used as data source.

popupCompletion

open var popupCompletion: Boolean

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

popupSetWidth

open var popupSetWidth: Boolean

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

popupSingleMatch

open var popupSingleMatch: Boolean

Determines whether the completions popup window will shown for a single possible completion.

textColumn

open var textColumn: <Error class: unknown class>

The column of the model containing the strings.

Functions

addAttribute

open fun addAttribute(cell: CellRenderer, attribute: String, column: <Error class: unknown class>)

This is deprecated since version 4.10.

---

clear

open fun clear()

This is deprecated since version 4.10.

---

clearAttributes

open fun clearAttributes(cell: CellRenderer)

This is deprecated since version 4.10.

---

complete

open fun complete()

This is deprecated since version 4.10.

computePrefix

open fun computePrefix(key: String): String?

This is deprecated since version 4.10.

emitNoMatches

fun emitNoMatches()

Emits the "no-matches" signal. See onNoMatches.

getArea

open fun getArea(): CellArea?

This is deprecated since version 4.10.

---

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCells

open fun getCells(): <Error class: unknown class>

This is deprecated since version 4.10.

---

getCompletionPrefix

open fun getCompletionPrefix(): String?

This is deprecated since version 4.10.

getEntry

open fun getEntry(): Widget

This is deprecated since version 4.10.

insertPrefix

open fun insertPrefix()

This is deprecated since version 4.10.

onCursorOnMatch

fun onCursorOnMatch( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (model: TreeModel, iter: TreeIter) -> Boolean): <Error class: unknown class>

Emitted when a match from the cursor is on a match of the list.

onInsertPrefix

fun onInsertPrefix( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (prefix: String) -> Boolean): <Error class: unknown class>

Emitted when the inline autocompletion is triggered.

onMatchSelected

fun onMatchSelected( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (model: TreeModel, iter: TreeIter) -> Boolean): <Error class: unknown class>

Emitted when a match from the list is selected.

onNoMatches