Memory-managed wrapper type.

Type class for types which can be safely cast to EntryCompletion, for instance with toEntryCompletion.

Cast to EntryCompletion, for types for which this is known to be safe. For general casts, use castTo.

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.

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

If no row matches key, Nothing will be returned. Note that a text column must have been set for this function to work, see entryCompletionSetTextColumn for details.

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

Gets the entry completion has been attached to.

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

Returns True if inline-selection mode is turned on.

Returns the minimum key length as set for completion.

Returns the model the GtkEntryCompletion is using as data source.

Returns Nothing if the model is unset.

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

Returns whether the completion 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.

Returns the column in the model of completion to get strings from.

Requests a prefix insertion.

Creates a new GtkEntryCompletion object.

Creates a new GtkEntryCompletion object using the specified area.

The GtkCellArea is used to layout cells in the underlying GtkTreeViewColumn for the drop-down menu.

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

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

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.

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

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 Nothing, then it will unset the model.

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

Sets whether the completion popup window will be resized to be the same width 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 EntryCompletion:inlineCompletion.

Convenience function for setting up the most used case of this code: a 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 EntryCompletion:textColumn property directly.

Construct a GValueConstruct with valid value for the “cell-area” property. This is rarely needed directly, but it is used by new.

Get the value of the “cell-area” property. When overloading is enabled, this is equivalent to

get entryCompletion #cellArea

Construct a GValueConstruct with valid value for the “inline-completion” property. This is rarely needed directly, but it is used by new.

Get the value of the “inline-completion” property. When overloading is enabled, this is equivalent to

get entryCompletion #inlineCompletion

Set the value of the “inline-completion” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #inlineCompletion := value ]

Construct a GValueConstruct with valid value for the “inline-selection” property. This is rarely needed directly, but it is used by new.

Get the value of the “inline-selection” property. When overloading is enabled, this is equivalent to

get entryCompletion #inlineSelection

Set the value of the “inline-selection” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #inlineSelection := value ]

Construct a GValueConstruct with valid value for the “minimum-key-length” property. This is rarely needed directly, but it is used by new.

Get the value of the “minimum-key-length” property. When overloading is enabled, this is equivalent to

get entryCompletion #minimumKeyLength

Set the value of the “minimum-key-length” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #minimumKeyLength := value ]

Set the value of the “model” property to Nothing. When overloading is enabled, this is equivalent to

clear #model

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get entryCompletion #model

Set the value of the “model” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #model := value ]

Construct a GValueConstruct with valid value for the “popup-completion” property. This is rarely needed directly, but it is used by new.

Get the value of the “popup-completion” property. When overloading is enabled, this is equivalent to

get entryCompletion #popupCompletion

Set the value of the “popup-completion” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #popupCompletion := value ]

Construct a GValueConstruct with valid value for the “popup-set-width” property. This is rarely needed directly, but it is used by new.

Get the value of the “popup-set-width” property. When overloading is enabled, this is equivalent to

get entryCompletion #popupSetWidth

Set the value of the “popup-set-width” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #popupSetWidth := value ]

Construct a GValueConstruct with valid value for the “popup-single-match” property. This is rarely needed directly, but it is used by new.

Get the value of the “popup-single-match” property. When overloading is enabled, this is equivalent to

get entryCompletion #popupSingleMatch

Set the value of the “popup-single-match” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #popupSingleMatch := value ]

Construct a GValueConstruct with valid value for the “text-column” property. This is rarely needed directly, but it is used by new.

Get the value of the “text-column” property. When overloading is enabled, this is equivalent to

get entryCompletion #textColumn

Set the value of the “text-column” property. When overloading is enabled, this is equivalent to

set entryCompletion [ #textColumn := value ]

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 entryCompletionSetModel.

Connect a signal handler for the cursorOnMatch signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryCompletion #cursorOnMatch callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the cursorOnMatch signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryCompletion #cursorOnMatch callback

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 '/'.

Connect a signal handler for the insertPrefix signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryCompletion #insertPrefix callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the insertPrefix signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryCompletion #insertPrefix callback

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 entryCompletionSetModel.

Connect a signal handler for the matchSelected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryCompletion #matchSelected callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the matchSelected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryCompletion #matchSelected callback

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

In other words when GtkEntryCompletion is out of suggestions.

Connect a signal handler for the noMatches signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryCompletion #noMatches callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the noMatches signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryCompletion #noMatches callback