EntryCompletion

#GtkEntryCompletion is an auxiliary object to be used in conjunction with #GtkEntry to provide the completion functionality. It implements the #GtkCellLayout 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 gtk_entry_completion_set_text_column()), but this can be overridden with a custom match function (see gtk_entry_completion_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 #GtkEntryCompletion::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_set_completion().

In addition to regular completion matches, which will be inserted into the entry when they are selected, #GtkEntryCompletion also allows to display “actions” in the popup window. Their appearance is similar to menuitems, to differentiate them clearly from completion strings. When an action is selected, the #GtkEntryCompletion::action-activated signal is emitted.

GtkEntryCompletion uses a #GtkTreeModelFilter model to represent the subset of the entire model that is currently matching. While the GtkEntryCompletion signals #GtkEntryCompletion::match-selected and #GtkEntryCompletion::cursor-on-match take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as #GtkCellLayoutDataFuncs or #GtkCellArea::apply-attributes) will generally take the filter model as argument. As long as you are only calling gtk_tree_model_get(), this will make no difference to you. If for some reason, you need the original model, use gtk_tree_model_filter_get_model(). Don’t forget to use gtk_tree_model_filter_convert_iter_to_child_iter() to obtain a matching iter.

class EntryCompletion : ObjectG , BuildableIF , CellLayoutIF {}

Constructors

this
this(GtkEntryCompletion* gtkEntryCompletion, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new #GtkEntryCompletion object.

this
this(CellArea area)

Creates a new #GtkEntryCompletion object using the specified @area to layout cells in the underlying #GtkTreeViewColumn for the drop-down menu.

Members

Functions

addOnActionActivated
gulong addOnActionActivated(void delegate(int, EntryCompletion) dlg, ConnectFlags connectFlags)

Gets emitted when an action is activated.

addOnCursorOnMatch
gulong addOnCursorOnMatch(bool delegate(TreeModelIF, TreeIter, EntryCompletion) dlg, ConnectFlags connectFlags)

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

addOnInsertPrefix
gulong addOnInsertPrefix(bool delegate(string, EntryCompletion) dlg, ConnectFlags connectFlags)

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

addOnMatchSelected
gulong addOnMatchSelected(bool delegate(TreeModelIF, TreeIter, EntryCompletion) dlg, ConnectFlags connectFlags)

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

addOnNoMatches
gulong addOnNoMatches(void delegate(EntryCompletion) dlg, ConnectFlags connectFlags)

Gets emitted when the filter model has zero number of rows in completion_complete method. (In other words when GtkEntryCompletion is out of suggestions)

complete
void complete()

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
string computePrefix(string key)

Computes the common prefix that is shared by all rows in @completion that start with @key. If no row matches @key, %NULL will be returned. Note that a text column must have been set for this function to work, see gtk_entry_completion_set_text_column() for details.

deleteAction
void deleteAction(int index)

Deletes the action at @index_ from @completion’s action list.

getCompletionPrefix
string getCompletionPrefix()

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

getEntry
Widget getEntry()

Gets the entry @completion has been attached to.

getEntryCompletionStruct
GtkEntryCompletion* getEntryCompletionStruct(bool transferOwnership)

Get the main Gtk struct

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
TreeModelIF getModel()

Returns the model the #GtkEntryCompletion is using as data source. Returns %NULL if the model is unset.

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.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTextColumn
int getTextColumn()

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

insertActionMarkup
void insertActionMarkup(int index, string markup)

Inserts an action in @completion’s action item list at position @index_ with markup @markup.

insertActionText
void insertActionText(int index, string text)

Inserts an action in @completion’s action item list at position @index_ with text @text. If you want the action item to have markup, use gtk_entry_completion_insert_action_markup().

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(GtkEntryCompletionMatchFunc func, void* funcData, GDestroyNotify funcNotify)

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
void setMinimumKeyLength(int length)

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
void setModel(TreeModelIF model)

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

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. You may want to set this to %FALSE if you are using [inline completion][GtkEntryCompletion--inline-completion].

setTextColumn
void setTextColumn(int column)

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.

Mixins

__anonymous
mixin BuildableT!(GtkEntryCompletion)
Undocumented in source.
__anonymous
mixin CellLayoutT!(GtkEntryCompletion)
Undocumented in source.

Static functions

getType
GType getType()

Variables

gtkEntryCompletion
GtkEntryCompletion* gtkEntryCompletion;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.
getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
Undocumented in source.
destroyNotify
void destroyNotify(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify
void toggleNotify(ObjectG obj, GObject* object, int isLastRef)
Undocumented in source. Be warned that the author may not have intended to support it.
~this
~this()
Undocumented in source.
opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef)

Gets a D Object from the objects table of associations.

setProperty
void setProperty(string propertyName, T value)
unref
deprecated void unref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
doref
deprecated ObjectG doref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(void* weakPointerLocation)

Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance:

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

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

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

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object. @value must have been initialized to the expected type of the property (or a type to which the expected type can be transformed) using g_value_init().

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, 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(ParamSpec pspec)

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

doref
ObjectG doref()

Increases the reference count of @object.

refSink
ObjectG refSink()

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

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(void* weakPointerLocation)

Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.

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.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

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(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() 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: |[<!-- language="C" --> void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrive the old string list GList *list = g_object_steal_qdata (object, quark_string_list);

thawNotify
void thawNotify()

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

unref
void unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(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 g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a #GObject.

From BuildableIF

getBuildableStruct
GtkBuildable* getBuildableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
addChild
void addChild(Builder builder, ObjectG child, string type)

Adds a child to @buildable. @type is an optional string describing how the child should be added.

constructChild
ObjectG constructChild(Builder builder, string name)

Constructs a child of @buildable with the name @name.

customFinished
void customFinished(Builder builder, ObjectG child, string tagname, void* data)

This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the @buildable.

customTagEnd
void customTagEnd(Builder builder, ObjectG child, string tagname, void** data)

This is called at the end of each custom element handled by the buildable.

customTagStart
bool customTagStart(Builder builder, ObjectG child, string tagname, GMarkupParser parser, void* data)

This is called for each unknown element under <child>.

getInternalChild
ObjectG getInternalChild(Builder builder, string childname)

Get the internal child called @childname of the @buildable object.

buildableGetName
string buildableGetName()

Gets the name of the @buildable object.

parserFinished
void parserFinished(Builder builder)

Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

setBuildableProperty
void setBuildableProperty(Builder builder, string name, Value value)

Sets the property name @name to @value on the @buildable object.

buildableSetName
void buildableSetName(string name)

Sets the name of the @buildable object.

From CellLayoutIF

getCellLayoutStruct
GtkCellLayout* getCellLayoutStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
addAttribute
void addAttribute(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(CellRenderer cell)

Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

getArea
CellArea getArea()

Returns the underlying #GtkCellArea which might be @cell_layout if called on a #GtkCellArea or might be %NULL if no #GtkCellArea is used by @cell_layout.

getCells
ListG getCells()

Returns the cell renderers which have been added to @cell_layout.

packEnd
void packEnd(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(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(CellRenderer cell, int position)

Re-inserts @cell at @position.

setCellDataFunc
void setCellDataFunc(CellRenderer cell, GtkCellLayoutDataFunc func, void* funcData, GDestroyNotify destroy)

Sets the #GtkCellLayoutDataFunc to use for @cell_layout.

Meta