GI.Gtk.Objects.EntryCompletion

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

It implements the 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 entryCompletionSetTextColumn), but this can be overridden with a custom match function (see entryCompletionSetMatchFunc).

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 EntryCompletion::matchSelected 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 entrySetCompletion.

GtkEntryCompletion uses a TreeModelFilter model to represent the subset of the entire model that is currently matching. While the GtkEntryCompletion signals EntryCompletion::matchSelected and EntryCompletion::cursorOnMatch take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as GtkCellLayoutDataFunc or signalgtk.CellArea[applyAttributes)] will generally take the filter model as argument. As long as you are only calling TreeModel.get(), this will make no difference to you. If for some reason, you need the original model, use treeModelFilterGetModel. Don’t forget to use treeModelFilterConvertIterToChildIter to obtain a matching iter.

Exported types

newtype EntryCompletion

Memory-managed wrapper type.

Constructors

EntryCompletion (ManagedPtr EntryCompletion)

Instances

Eq EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

Methods

(==) :: EntryCompletion -> EntryCompletion -> Bool

(/=) :: EntryCompletion -> EntryCompletion -> Bool

GObject EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

ManagedPtrNewtype EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

Methods

toManagedPtr :: EntryCompletion -> ManagedPtr EntryCompletion

TypedObject EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

Methods

glibType :: IO GType

HasParentTypes EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

IsGValue (Maybe EntryCompletion)

Convert EntryCompletion to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.EntryCompletion

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe EntryCompletion -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe EntryCompletion)

type ParentTypes EntryCompletion

Defined in GI.Gtk.Objects.EntryCompletion

type ParentTypes EntryCompletion = '[Object, Buildable, CellLayout]

class (GObject o, IsDescendantOf EntryCompletion o) => IsEntryCompletion o

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

Instances

(GObject o, IsDescendantOf EntryCompletion o) => IsEntryCompletion o

Defined in GI.Gtk.Objects.EntryCompletion

toEntryCompletion :: (MonadIO m, IsEntryCompletion o) => o -> m EntryCompletion

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

Methods

Click to display all available methods, including inherited ones

Methods

addAttribute, bindProperty, bindPropertyFull, clear, clearAttributes, complete, computePrefix, forceFloating, freezeNotify, getv, insertPrefix, isFloating, notify, notifyByPspec, packEnd, packStart, ref, refSink, reorder, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getArea, getBuildableId, getCells, getCompletionPrefix, getData, getEntry, getInlineCompletion, getInlineSelection, getMinimumKeyLength, getModel, getPopupCompletion, getPopupSetWidth, getPopupSingleMatch, getProperty, getQdata, getTextColumn.

Setters

setCellDataFunc, setData, setDataFull, setInlineCompletion, setInlineSelection, setMatchFunc, setMinimumKeyLength, setModel, setPopupCompletion, setPopupSetWidth, setPopupSingleMatch, setProperty, setTextColumn.

complete

entryCompletionComplete

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m ()

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.

computePrefix

entryCompletionComputePrefix

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: the entry completion

-> Text

key: The text to complete for

-> m (Maybe Text)

Returns: The common prefix all rows starting with key

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.

getCompletionPrefix

entryCompletionGetCompletionPrefix

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m (Maybe Text)

Returns: the prefix for the current completion

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

getEntry

entryCompletionGetEntry

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Widget

Returns: The entry completion has been attached to

Gets the entry completion has been attached to.

getInlineCompletion

entryCompletionGetInlineCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Bool

Returns: True if inline completion is turned on

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

getInlineSelection

entryCompletionGetInlineSelection

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Bool

Returns: True if inline-selection mode is on

Returns True if inline-selection mode is turned on.

getMinimumKeyLength

entryCompletionGetMinimumKeyLength

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Int32

Returns: The currently used minimum key length

Returns the minimum key length as set for completion.

getModel

entryCompletionGetModel

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m (Maybe TreeModel)

Returns: A GtkTreeModel

Returns the model the GtkEntryCompletion is using as data source.

Returns Nothing if the model is unset.

getPopupCompletion

entryCompletionGetPopupCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Bool

Returns: True if popup completion is turned on

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

getPopupSetWidth

entryCompletionGetPopupSetWidth

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Bool

Returns: True if the popup window will be resized to the width of the entry

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

getPopupSingleMatch

entryCompletionGetPopupSingleMatch

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Bool

Returns: True if the popup window will appear regardless of the number of matches

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

getTextColumn

entryCompletionGetTextColumn

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m Int32

Returns: the column containing the strings

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

insertPrefix

entryCompletionInsertPrefix

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> m ()

Requests a prefix insertion.

new

entryCompletionNew

Arguments

:: (HasCallStack, MonadIO m)

=> m EntryCompletion

Returns: A newly created GtkEntryCompletion object

Creates a new GtkEntryCompletion object.

newWithArea

entryCompletionNewWithArea

Arguments

:: (HasCallStack, MonadIO m, IsCellArea a)

=> a

area: the GtkCellArea used to layout cells

-> m EntryCompletion

Returns: A newly created 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.

setInlineCompletion

entryCompletionSetInlineCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Bool

inlineCompletion: True to do inline completion

-> m ()

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

setInlineSelection

entryCompletionSetInlineSelection

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Bool

inlineSelection: True to do inline selection

-> m ()

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

setMatchFunc

entryCompletionSetMatchFunc

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> EntryCompletionMatchFunc

func: the GtkEntryCompletionMatchFunc to use

-> m ()

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.

setMinimumKeyLength

entryCompletionSetMinimumKeyLength

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Int32

length: the minimum length of the key in order to start completing

-> m ()

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

setModel

entryCompletionSetModel

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a, IsTreeModel b)

=> a

completion: a GtkEntryCompletion

-> Maybe b

model: the GtkTreeModel

-> m ()

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.

setPopupCompletion

entryCompletionSetPopupCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Bool

popupCompletion: True to do popup completion

-> m ()

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

setPopupSetWidth

entryCompletionSetPopupSetWidth

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Bool

popupSetWidth: True to make the width of the popup the same as the entry

-> m ()

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

setPopupSingleMatch

entryCompletionSetPopupSingleMatch

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Bool

popupSingleMatch: True if the popup should appear even for a single match

-> m ()

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.

setTextColumn

entryCompletionSetTextColumn

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a)

=> a

completion: a GtkEntryCompletion

-> Int32

column: the column in the model of completion to get strings from

-> m ()

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.

Properties

cellArea

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

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

constructEntryCompletionCellArea :: (IsEntryCompletion o, MonadIO m, IsCellArea a) => a -> m (GValueConstruct o)

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

getEntryCompletionCellArea :: (MonadIO m, IsEntryCompletion o) => o -> m (Maybe CellArea)

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

get entryCompletion #cellArea

inlineCompletion

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.

constructEntryCompletionInlineCompletion :: (IsEntryCompletion o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryCompletionInlineCompletion :: (MonadIO m, IsEntryCompletion o) => o -> m Bool

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

get entryCompletion #inlineCompletion

setEntryCompletionInlineCompletion :: (MonadIO m, IsEntryCompletion o) => o -> Bool -> m ()

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

set entryCompletion [ #inlineCompletion := value ]

inlineSelection

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

constructEntryCompletionInlineSelection :: (IsEntryCompletion o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryCompletionInlineSelection :: (MonadIO m, IsEntryCompletion o) => o -> m Bool

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

get entryCompletion #inlineSelection

setEntryCompletionInlineSelection :: (MonadIO m, IsEntryCompletion o) => o -> Bool -> m ()

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

set entryCompletion [ #inlineSelection := value ]

minimumKeyLength

No description available in the introspection data.

constructEntryCompletionMinimumKeyLength :: (IsEntryCompletion o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getEntryCompletionMinimumKeyLength :: (MonadIO m, IsEntryCompletion o) => o -> m Int32

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

get entryCompletion #minimumKeyLength

setEntryCompletionMinimumKeyLength :: (MonadIO m, IsEntryCompletion o) => o -> Int32 -> m ()

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

set entryCompletion [ #minimumKeyLength := value ]

model

No description available in the introspection data.

clearEntryCompletionModel :: (MonadIO m, IsEntryCompletion o) => o -> m ()

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

clear #model

constructEntryCompletionModel :: (IsEntryCompletion o, MonadIO m, IsTreeModel a) => a -> m (GValueConstruct o)

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

getEntryCompletionModel :: (MonadIO m, IsEntryCompletion o) => o -> m (Maybe TreeModel)

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

get entryCompletion #model

setEntryCompletionModel :: (MonadIO m, IsEntryCompletion o, IsTreeModel a) => o -> a -> m ()

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

set entryCompletion [ #model := value ]

popupCompletion

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

constructEntryCompletionPopupCompletion :: (IsEntryCompletion o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryCompletionPopupCompletion :: (MonadIO m, IsEntryCompletion o) => o -> m Bool

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

get entryCompletion #popupCompletion

setEntryCompletionPopupCompletion :: (MonadIO m, IsEntryCompletion o) => o -> Bool -> m ()

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

set entryCompletion [ #popupCompletion := value ]

popupSetWidth

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

constructEntryCompletionPopupSetWidth :: (IsEntryCompletion o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryCompletionPopupSetWidth :: (MonadIO m, IsEntryCompletion o) => o -> m Bool

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

get entryCompletion #popupSetWidth

setEntryCompletionPopupSetWidth :: (MonadIO m, IsEntryCompletion o) => o -> Bool -> m ()

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

set entryCompletion [ #popupSetWidth := value ]

popupSingleMatch

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 EntryCompletion:inlineCompletion.

constructEntryCompletionPopupSingleMatch :: (IsEntryCompletion o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryCompletionPopupSingleMatch :: (MonadIO m, IsEntryCompletion o) => o -> m Bool

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

get entryCompletion #popupSingleMatch

setEntryCompletionPopupSingleMatch :: (MonadIO m, IsEntryCompletion o) => o -> Bool -> m ()

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

set entryCompletion [ #popupSingleMatch := value ]

textColumn

The column of the model containing the strings.

Note that the strings must be UTF-8.

constructEntryCompletionTextColumn :: (IsEntryCompletion o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getEntryCompletionTextColumn :: (MonadIO m, IsEntryCompletion o) => o -> m Int32

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

get entryCompletion #textColumn

setEntryCompletionTextColumn :: (MonadIO m, IsEntryCompletion o) => o -> Int32 -> m ()

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

set entryCompletion [ #textColumn := value ]

Signals

cursorOnMatch

type EntryCompletionCursorOnMatchCallback

Arguments

 = TreeModel

model: the GtkTreeModel containing the matches

-> TreeIter

iter: a GtkTreeIter positioned at the selected match

-> IO Bool

Returns: True if the signal has been handled

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.

afterEntryCompletionCursorOnMatch :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionCursorOnMatchCallback) -> m SignalHandlerId

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.

onEntryCompletionCursorOnMatch :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionCursorOnMatchCallback) -> m SignalHandlerId

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

insertPrefix

type EntryCompletionInsertPrefixCallback

Arguments

 = Text

prefix: the common prefix of all possible completions

-> IO Bool

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 GtkFileChooser inserts only the part of the prefix up to the next '/'.

afterEntryCompletionInsertPrefix :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionInsertPrefixCallback) -> m SignalHandlerId

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.

onEntryCompletionInsertPrefix :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionInsertPrefixCallback) -> m SignalHandlerId

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

matchSelected

type EntryCompletionMatchSelectedCallback

Arguments

 = TreeModel

model: the GtkTreeModel containing the matches

-> TreeIter

iter: a GtkTreeIter positioned at the selected match

-> IO Bool

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

afterEntryCompletionMatchSelected :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionMatchSelectedCallback) -> m SignalHandlerId

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.

onEntryCompletionMatchSelected :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionMatchSelectedCallback) -> m SignalHandlerId

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

noMatches

type EntryCompletionNoMatchesCallback = IO ()

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

In other words when GtkEntryCompletion is out of suggestions.

afterEntryCompletionNoMatches :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionNoMatchesCallback) -> m SignalHandlerId

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.

onEntryCompletionNoMatches :: (IsEntryCompletion a, MonadIO m) => a -> ((?self :: a) => EntryCompletionNoMatchesCallback) -> m SignalHandlerId

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