Class (GI Class)

Gtk-3.0GtkEntryCompletion

Gtk.EntryCompletion is an auxiliary object to be used in conjunction with Gtk.Entry to provide the completion functionality. It implements the Gtk.CellLayout interface, to allow the user to add extra cells to the Gtk.TreeView with completion matches.

“Completion functionality” means that when the user modifies the text in the entry, Gtk.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_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 Gtk.EntryCompletion.SignalSignatures.match_selected | 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_set_completion().

In addition to regular completion matches, which will be inserted into the entry when they are selected, Gtk.EntryCompletion 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 Gtk.EntryCompletion.SignalSignatures.action_activated | Gtk.EntryCompletion::action-activated signal is emitted.

GtkEntryCompletion uses a Gtk.TreeModelFilter model to represent the subset of the entire model that is currently matching. While the GtkEntryCompletion signals Gtk.EntryCompletion.SignalSignatures.match_selected | Gtk.EntryCompletion::match-selected and Gtk.EntryCompletion.SignalSignatures.cursor_on_match | Gtk.EntryCompletion::cursor-on-match take the original model and an iter pointing to that model as arguments, other callbacks and signals (such as GtkCellLayoutDataFuncs or Gtk.CellArea.SignalSignatures.apply_attributes | Gtk.CellArea::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.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

_init add_attribute add_child bind_property bind_property_full block_signal_handler clear clear_attributes complete compute_prefix connect connect_after construct_child custom_finished custom_tag_end custom_tag_start delete_action disconnect emit force_floating freeze_notify get_area get_cells get_completion_prefix get_data get_entry get_inline_completion get_inline_selection get_internal_child get_minimum_key_length get_model get_name get_popup_completion get_popup_set_width get_popup_single_match get_property get_qdata get_text_column getv insert_action_markup insert_action_text insert_prefix is_floating notify notify_by_pspec pack_end pack_start parser_finished ref ref_sink reorder run_dispose set set_buildable_property set_cell_data_func set_data set_inline_completion set_inline_selection set_match_func set_minimum_key_length set_model set_name set_popup_completion set_popup_set_width set_popup_single_match set_property set_text_column steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_action_activated vfunc_add_attribute vfunc_add_child vfunc_clear vfunc_clear_attributes vfunc_construct_child vfunc_constructed vfunc_cursor_on_match vfunc_custom_finished vfunc_custom_tag_end vfunc_custom_tag_start vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_area vfunc_get_cells vfunc_get_internal_child vfunc_get_name vfunc_get_property vfunc_insert_prefix vfunc_match_selected vfunc_no_matches vfunc_notify vfunc_pack_end vfunc_pack_start vfunc_parser_finished vfunc_reorder vfunc_set_buildable_property vfunc_set_cell_data_func vfunc_set_name vfunc_set_property watch_closure new new_with_area

Methods - Inherited from GObject

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

  • get inline_completion(): boolean

    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.

    Returns boolean

    2.6

  • set inline_completion(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get inline_selection(): boolean

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

    Returns boolean

    2.12

  • set inline_selection(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get inlineCompletion(): boolean

    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.

    Returns boolean

    2.6

  • set inlineCompletion(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get inlineSelection(): boolean

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

    Returns boolean

    2.12

  • set inlineSelection(val: boolean): void

    Parameters

    • val: boolean

    Returns void

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

    Returns boolean

    2.6

  • Parameters

    • val: boolean

    Returns void

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

    Returns boolean

    2.8

  • Parameters

    • val: boolean

    Returns void

  • 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 [inline completion][GtkEntryCompletion--inline-completion].

    Returns boolean

    2.8

  • Parameters

    • val: boolean

    Returns void

  • get popupCompletion(): boolean

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

    Returns boolean

    2.6

  • set popupCompletion(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get popupSetWidth(): boolean

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

    Returns boolean

    2.8

  • set popupSetWidth(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get popupSingleMatch(): boolean

    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 [inline completion][GtkEntryCompletion--inline-completion].

    Returns boolean

    2.8

  • set popupSingleMatch(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get text_column(): number

    The column of the model containing the strings. Note that the strings must be UTF-8.

    Returns number

    2.6

  • set text_column(val: number): void

    Parameters

    • val: number

    Returns void

  • get textColumn(): number

    The column of the model containing the strings. Note that the strings must be UTF-8.

    Returns number

    2.6

  • set textColumn(val: number): void

    Parameters

    • val: number

    Returns void

Methods

  • Adds an attribute mapping to the list in cell_layout.

    The column is the column of the model to get a value from, and the attribute is the parameter on cell to be set from the value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a Gtk.CellRendererText get its values from column 2.

    Parameters

    • cell: Gtk.CellRenderer
    • attribute: string

      an attribute on the renderer

    • column: number

      the column position on the model to get the attribute from

    Returns void

  • 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:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • 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 the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

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

    Returns void

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

    Parameters

    • key: string

      The text to complete for

    Returns string

    The common prefix all rows starting with key or null if no row matches key.

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

    Note that index_ is a relative position and the position of an action may have changed since it was inserted.

    Parameters

    • index_: number

      the index of the item to delete

    Returns void

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • 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.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

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

    Returns string

    the prefix for the current completion

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

get_entry

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

    Returns boolean

    true if inline completion is turned on

  • Returns true if inline-selection mode is turned on.

    Returns boolean

    true if inline-selection mode is on

  • Returns the minimum key length as set for completion.

    Returns number

    The currently used minimum key length

  • Gets the name of the buildable object.

    Gtk.Builder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the buildable.

    Returns string

    the name set with gtk_buildable_set_name()

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

    Returns boolean

    true if popup completion is turned on

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

    Returns boolean

    true if the 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 boolean

    true if the popup window will appear regardless of the number of matches

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

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

    Returns number

    the column containing the strings

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

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

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

    Parameters

    • index_: number

      the index of the item to insert

    • markup: string

      markup of the item to insert

    Returns void

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

    Note that index_ is a relative position in the list of actions and the position of an action can change when deleting a different action.

    Parameters

    • index_: number

      the index of the item to insert

    • text: string

      text of the item to insert

    Returns void

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

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

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

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

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

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

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

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the floating reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

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

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

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

    Parameters

    • inline_completion: boolean

      true to do inline completion

    Returns void

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

    Parameters

    • inline_selection: boolean

      true to do inline selection

    Returns void

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

    Parameters

    • length: number

      the minimum length of the key in order to start completing

    Returns void

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

    Parameters

    • popup_completion: boolean

      true to do popup completion

    Returns void

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

    Parameters

    • popup_set_width: boolean

      true to make the width of the popup the same as the entry

    Returns void

  • 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].

    Parameters

    • popup_single_match: boolean

      true if the popup should appear even for a single match

    Returns void

  • 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 Gtk.CellRendererText 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 Gtk.EntryCompletion.text_column property directly.

    Parameters

    • column: number

      the column in the model of completion to get strings from

    Returns void

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

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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:

    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");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

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

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

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

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • Adds an attribute mapping to the list in cell_layout.

    The column is the column of the model to get a value from, and the attribute is the parameter on cell to be set from the value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a Gtk.CellRendererText get its values from column 2.

    Parameters

    • cell: Gtk.CellRenderer
    • attribute: string

      an attribute on the renderer

    • column: number

      the column position on the model to get the attribute from

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

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

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

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

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

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

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

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

    Parameters

    Returns void

Methods - Inherited from GObject

  • 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 GObject.ParamSpec, 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.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures