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, null will be returned. Note that a text column must have been set for this function to work, see gtk.entry_completion.EntryCompletion.setTextColumn for details.
Connect to ActionActivated signal.
Connect to CursorOnMatch signal.
Connect to InsertPrefix signal.
Connect to MatchSelected signal.
Connect to NoMatches signal.
Deletes the action at index_ from completion’s action list.
Get the original text entered by the user that triggered the completion or null 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 null 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.
Inserts an action in completion’s action item list at position index_ with markup markup.
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.EntryCompletion.insertActionMarkup.
Requests a prefix insertion.
Returns this, for use in with statements.
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 null, 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 [inline completion][GtkEntryCompletion--inline-completion].
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.
Get cellArea property.
Get inlineCompletion property.
Set inlineCompletion property.
Get inlineSelection property.
Set inlineSelection property.
Get popupCompletion property.
Set popupCompletion property.
Get popupSetWidth property.
Set popupSetWidth property.
Get popupSingleMatch property.
Set popupSingleMatch property.
Get textColumn property.
Set textColumn property.
Get builder for gtk.entry_completion.EntryCompletion
Creates a new #GtkEntryCompletion object using the specified area to layout cells in the underlying #GtkTreeViewColumn for the drop-down menu.
Adds a child to buildable. type is an optional string describing how the child should be added.
Constructs a child of buildable with the name name.
This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
This is called for each unknown element under <child>.
Get the internal child called childname of the buildable object.
Gets the name of the buildable object.
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.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
Sets the property name name to value on the buildable object.
Sets the name of the buildable object.
Adds an attribute mapping to the list in cell_layout.
Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.
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.
Returns the cell renderers which have been added to cell_layout.
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.
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.
Re-inserts cell at position.
Sets the #GtkCellLayoutDataFunc to use for cell_layout.
Set the GObject of a D ObjectWrap wrapper.
Get a pointer to the underlying C object.
Calls g_object_ref() on a GObject.
Calls g_object_unref() on a GObject.
Get the GType of an object.
GObject GType property.
Convenience method to return this cast to a type. For use in D with statements.
Template to get the D object from a C GObject and cast it to the given D object type.
Connect a D closure to an object signal.
Template for setting a GObject property.
Template for getting a GObject property.
Creates a binding between source_property on source and target_property on target.
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.
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.ObjectWrap.refSink.
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.
Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
Gets a property of an object.
This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
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.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
Sets a property on an object.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
This function gets back user data pointers stored via gobject.object.ObjectWrap.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:
Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
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.ObjectWrap.ref_ and gobject.object.ObjectWrap.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.
Connect to Notify signal.
Adds a child to buildable. type is an optional string describing how the child should be added.
Constructs a child of buildable with the name name.
This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
This is called for each unknown element under <child>.
Get the internal child called childname of the buildable object.
Gets the name of the buildable object.
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.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
Sets the property name name to value on the buildable object.
Sets the name of the buildable object.
Adds an attribute mapping to the list in cell_layout.
Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.
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.
Returns the cell renderers which have been added to cell_layout.
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.
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.
Re-inserts cell at position.
Sets the #GtkCellLayoutDataFunc to use for cell_layout.
#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.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 #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.Entry.setCompletion.
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.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.