EntryCompletion

gtk.entry_completion.EntryCompletion is an auxiliary object to provide completion functionality for gtk.entry.Entry.

It implements the gtk.cell_layout.CellLayout interface, to allow the user to add extra cells to the gtk.tree_view.TreeView with completion matches.

“Completion functionality” means that when the user modifies the text in the entry, gtk.entry_completion.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 gtk.entry_completion.EntryCompletion.setTextColumn), but this can be overridden with a custom match function (see gtk.entry_completion.EntryCompletion.setMatchFunc).

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 gtk.entry.Entry.setCompletion.

gtk.entry_completion.EntryCompletion uses a gtk.tree_model_filter.TreeModelFilter model to represent the subset of the entire model that is currently matching. While the gtk.entry_completion.EntryCompletion 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 gtk.types.CellLayoutDataFunc or signal@Gtk.CellArea::apply-attributes) will generally take the filter model as argument. As long as you are only calling gtk.tree_model.TreeModel.get, this will make no difference to you. If for some reason, you need the original model, use gtk.tree_model_filter.TreeModelFilter.getModel. Don’t forget to use gtk.tree_model_filter.TreeModelFilter.convertIterToChildIter to obtain a matching iter.

Constructors

this
this()

Creates a new gtk.entry_completion.EntryCompletion object.

Members

Functions

complete
void complete()

Requests a completion operation, or in other words a refiltering of the current list with completions, using the current key.

computePrefix
string computePrefix(string key)

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

connectCursorOnMatch
ulong connectCursorOnMatch(T callback, Flag!"After" after)

Connect to CursorOnMatch signal.

connectInsertPrefix
ulong connectInsertPrefix(T callback, Flag!"After" after)

Connect to InsertPrefix signal.

connectMatchSelected
ulong connectMatchSelected(T callback, Flag!"After" after)

Connect to MatchSelected signal.

connectNoMatches
ulong connectNoMatches(T callback, Flag!"After" after)

Connect to NoMatches signal.

getCompletionPrefix
string getCompletionPrefix()

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

getEntry
gtk.widget.Widget getEntry()

Gets the entry completion has been attached to.

getInlineCompletion
bool getInlineCompletion()

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

getInlineSelection
bool getInlineSelection()

Returns true if inline-selection mode is turned on.

getMinimumKeyLength
int getMinimumKeyLength()

Returns the minimum key length as set for completion.

getModel
gtk.tree_model.TreeModel getModel()

Returns the model the gtk.entry_completion.EntryCompletion is using as data source.

getPopupCompletion
bool getPopupCompletion()

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

getPopupSetWidth
bool getPopupSetWidth()

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

getPopupSingleMatch
bool getPopupSingleMatch()

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

getTextColumn
int getTextColumn()

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

insertPrefix
void insertPrefix()

Requests a prefix insertion.

setInlineCompletion
void setInlineCompletion(bool inlineCompletion)

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

setInlineSelection
void setInlineSelection(bool inlineSelection)

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

setMatchFunc
void setMatchFunc(gtk.types.EntryCompletionMatchFunc func)

Sets the match function for completion to be func.

setMinimumKeyLength
void setMinimumKeyLength(int length)

Requires the length of the search key for completion to be at least length.

setModel
void setModel(gtk.tree_model.TreeModel model)

Sets the model for a gtk.entry_completion.EntryCompletion.

setPopupCompletion
void setPopupCompletion(bool popupCompletion)

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

setPopupSetWidth
void setPopupSetWidth(bool popupSetWidth)

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

setPopupSingleMatch
void setPopupSingleMatch(bool popupSingleMatch)

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

setTextColumn
void setTextColumn(int column)

Convenience function for setting up the most used case of this code: a completion list with just strings.

Static functions

newWithArea
gtk.entry_completion.EntryCompletion newWithArea(gtk.cell_area.CellArea area)

Creates a new gtk.entry_completion.EntryCompletion object using the specified area.

Mixed In Members

From mixin BuildableT!()

getBuildableId
string getBuildableId()

Gets the ID of the buildable object.

From mixin CellLayoutT!()

addAttribute
void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column)

Adds an attribute mapping to the list in cell_layout.

clear
void clear()

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

clearAttributes
void clearAttributes(gtk.cell_renderer.CellRenderer cell)

Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.

getArea
gtk.cell_area.CellArea getArea()

Returns the underlying gtk.cell_area.CellArea which might be cell_layout if called on a gtk.cell_area.CellArea or might be null if no gtk.cell_area.CellArea is used by cell_layout.

getCells
gtk.cell_renderer.CellRenderer[] getCells()

Returns the cell renderers which have been added to cell_layout.

packEnd
void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand)

Adds the cell to the end of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

packStart
void packStart(gtk.cell_renderer.CellRenderer cell, bool expand)

Packs the cell into the beginning of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

reorder
void reorder(gtk.cell_renderer.CellRenderer cell, int position)

Re-inserts cell at position.

setCellDataFunc
void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func)

Sets the gtk.cell_layout.CellLayoutDataFunc to use for cell_layout.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From Buildable

getBuildableId
string getBuildableId()

Gets the ID of the buildable object.

From CellLayout

addAttribute
void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column)

Adds an attribute mapping to the list in cell_layout.

clear
void clear()

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

clearAttributes
void clearAttributes(gtk.cell_renderer.CellRenderer cell)

Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.

getArea
gtk.cell_area.CellArea getArea()

Returns the underlying gtk.cell_area.CellArea which might be cell_layout if called on a gtk.cell_area.CellArea or might be null if no gtk.cell_area.CellArea is used by cell_layout.

getCells
gtk.cell_renderer.CellRenderer[] getCells()

Returns the cell renderers which have been added to cell_layout.

packEnd
void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand)

Adds the cell to the end of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

packStart
void packStart(gtk.cell_renderer.CellRenderer cell, bool expand)

Packs the cell into the beginning of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

reorder
void reorder(gtk.cell_renderer.CellRenderer cell, int position)

Re-inserts cell at position.

setCellDataFunc
void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func)

Sets the gtk.cell_layout.CellLayoutDataFunc to use for cell_layout.