Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

cellArea: Gtk.CellArea

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

If no area is specified when creating the entry completion with gtk_entry_completion_new_with_area() a horizontally oriented #GtkCellAreaBox will be used.

gTypeInstance: TypeInstance
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.

inlineSelection: boolean

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

minimumKeyLength: number
model: Gtk.TreeModel
parentInstance: GObject.Object
popupCompletion: boolean

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

popupSetWidth: boolean

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

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

textColumn: number

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

name: string

Methods

  • addAttribute(cell: Gtk.CellRenderer, attribute: string, column: number): 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 #GtkCellRendererText get its values from column 2.

    Parameters

    • cell: Gtk.CellRenderer

      a #GtkCellRenderer

    • attribute: string

      an attribute on the renderer

    • column: number

      the column position on the model to get the attribute from

    Returns void

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

    Parameters

    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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • clear(): void
  • Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

    Returns void

  • complete(): void
  • 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

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

  • connect(sigName: "action-activated", callback: Gtk.EntryCompletion_ActionActivatedSignalCallback): number
  • connect(sigName: "cursor-on-match", callback: Gtk.EntryCompletion_CursorOnMatchSignalCallback): number
  • connect(sigName: "insert-prefix", callback: Gtk.EntryCompletion_InsertPrefixSignalCallback): number
  • connect(sigName: "match-selected", callback: Gtk.EntryCompletion_MatchSelectedSignalCallback): number
  • connect(sigName: "no-matches", callback: Gtk.EntryCompletion_NoMatchesSignalCallback): number
  • connect(sigName: "notify::cell-area", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::inline-completion", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::inline-selection", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::minimum-key-length", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::model", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::popup-completion", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::popup-set-width", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::popup-single-match", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::text-column", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    • sigName: "notify::cell-area"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::inline-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::inline-selection"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::minimum-key-length"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::model"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::popup-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::popup-set-width"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::popup-single-match"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::text-column"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Constructs a child of buildable with the name name.

    #GtkBuilder calls this function if a “constructor” has been specified in the UI definition.

    Parameters

    • builder: Gtk.Builder

      #GtkBuilder used to construct this object

    • name: string

      name of child to construct

    Returns GObject.Object

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

    Parameters

    • builder: Gtk.Builder

      a #GtkBuilder

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      the name of the tag

    • data: object

      user data created in custom_tag_start

    Returns void

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

    Parameters

    • builder: Gtk.Builder

      #GtkBuilder used to construct this object

    • child: GObject.Object

      child object or %NULL for non-child tags

    • tagname: string

      name of tag

    • data: object

      user data that will be passed in to parser functions

    Returns void

  • deleteAction(index: number): void
  • 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

  • emit(sigName: "action-activated", ...args: any[]): void
  • emit(sigName: "cursor-on-match", iter: Gtk.TreeIter, ...args: any[]): void
  • emit(sigName: "insert-prefix", ...args: any[]): void
  • emit(sigName: "match-selected", iter: Gtk.TreeIter, ...args: any[]): void
  • emit(sigName: "no-matches", ...args: any[]): void
  • emit(sigName: "notify::cell-area", ...args: any[]): void
  • emit(sigName: "notify::inline-completion", ...args: any[]): void
  • emit(sigName: "notify::inline-selection", ...args: any[]): void
  • emit(sigName: "notify::minimum-key-length", ...args: any[]): void
  • emit(sigName: "notify::model", ...args: any[]): void
  • emit(sigName: "notify::popup-completion", ...args: any[]): void
  • emit(sigName: "notify::popup-set-width", ...args: any[]): void
  • emit(sigName: "notify::popup-single-match", ...args: any[]): void
  • emit(sigName: "notify::text-column", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "action-activated"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "cursor-on-match"
    • iter: Gtk.TreeIter
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "insert-prefix"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "match-selected"
    • iter: Gtk.TreeIter
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "no-matches"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::cell-area"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::inline-completion"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::inline-selection"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::minimum-key-length"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::model"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::popup-completion"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::popup-set-width"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::popup-single-match"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::text-column"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

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

    Returns void

  • freezeNotify(): 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::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

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

  • getCompletionPrefix(): string
  • Get the original text entered by the user that triggered the completion or %NULL if there’s no completion ongoing.

    Returns string

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getInlineCompletion(): boolean
  • Returns whether the common prefix of the possible completions should be automatically inserted in the entry.

    Returns boolean

  • getInlineSelection(): boolean
  • Returns %TRUE if inline-selection mode is turned on.

    Returns boolean

  • getMinimumKeyLength(): number
  • Returns the minimum key length as set for completion.

    Returns number

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

    Returns Gtk.TreeModel

  • getName(): string
  • Gets the name of the buildable object.

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

    Returns string

  • getPopupCompletion(): boolean
  • Returns whether the completions should be presented in a popup window.

    Returns boolean

  • getPopupSetWidth(): boolean
  • Returns whether the completion popup window will be resized to the width of the entry.

    Returns boolean

  • getPopupSingleMatch(): boolean
  • Returns whether the completion popup window will appear even if there is only a single match.

    Returns boolean

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getTextColumn(): number
  • Returns the column in the model of completion to get strings from.

    Returns number

  • getv(names: string[], values: any[]): void
  • 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

  • insertActionMarkup(index: number, markup: string): 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

  • insertActionText(index: number, text: string): 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

  • insertPrefix(): void
  • isFloating(): boolean
  • notify(propertyName: string): 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

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

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "action-activated", callback: Gtk.EntryCompletion_ActionActivatedSignalCallback): EventEmitter
  • off(sigName: "cursor-on-match", callback: Gtk.EntryCompletion_CursorOnMatchSignalCallback): EventEmitter
  • off(sigName: "insert-prefix", callback: Gtk.EntryCompletion_InsertPrefixSignalCallback): EventEmitter
  • off(sigName: "match-selected", callback: Gtk.EntryCompletion_MatchSelectedSignalCallback): EventEmitter
  • off(sigName: "no-matches", callback: Gtk.EntryCompletion_NoMatchesSignalCallback): EventEmitter
  • off(sigName: "notify::cell-area", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::inline-completion", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::inline-selection", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::minimum-key-length", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::model", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::popup-completion", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::popup-set-width", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::popup-single-match", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::text-column", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cell-area"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-selection"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::minimum-key-length"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::model"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-set-width"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-single-match"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::text-column"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "action-activated", callback: Gtk.EntryCompletion_ActionActivatedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "cursor-on-match", callback: Gtk.EntryCompletion_CursorOnMatchSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "insert-prefix", callback: Gtk.EntryCompletion_InsertPrefixSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "match-selected", callback: Gtk.EntryCompletion_MatchSelectedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "no-matches", callback: Gtk.EntryCompletion_NoMatchesSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::cell-area", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::inline-completion", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::inline-selection", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::minimum-key-length", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::model", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::popup-completion", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::popup-set-width", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::popup-single-match", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::text-column", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cell-area"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-selection"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::minimum-key-length"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::model"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-set-width"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-single-match"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::text-column"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "action-activated", callback: Gtk.EntryCompletion_ActionActivatedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "cursor-on-match", callback: Gtk.EntryCompletion_CursorOnMatchSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "insert-prefix", callback: Gtk.EntryCompletion_InsertPrefixSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "match-selected", callback: Gtk.EntryCompletion_MatchSelectedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "no-matches", callback: Gtk.EntryCompletion_NoMatchesSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::cell-area", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::inline-completion", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::inline-selection", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::minimum-key-length", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::model", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::popup-completion", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::popup-set-width", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::popup-single-match", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::text-column", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cell-area"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::inline-selection"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::minimum-key-length"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::model"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-completion"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-set-width"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::popup-single-match"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::text-column"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • 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

    • cell: Gtk.CellRenderer

      a #GtkCellRenderer

    • Optional expand: boolean

      %TRUE if cell is to be given extra space allocated to cell_layout

    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

    • cell: Gtk.CellRenderer

      a #GtkCellRenderer

    • Optional expand: boolean

      %TRUE if cell is to be given extra space allocated to cell_layout

    Returns void

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

    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

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] 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

  • Re-inserts cell at position.

    Note that cell has already to be packed into cell_layout for this to function properly.

    Parameters

    • cell: Gtk.CellRenderer

      a #GtkCellRenderer to reorder

    • position: number

      new position to insert cell at

    Returns void

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setBuildableProperty(builder: Gtk.Builder, name: string, value: any): void
  • Sets the #GtkCellLayoutDataFunc to use for cell_layout.

    This function is used instead of the standard attributes mapping for setting the column value, and should set the value of cell_layout’s cell renderer(s) as appropriate.

    func may be %NULL to remove a previously set function.

    Parameters

    Returns void

  • setData(key: string, data?: object): 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setInlineCompletion(inlineCompletion: boolean): void
  • Sets whether the common prefix of the possible completions should be automatically inserted in the entry.

    Parameters

    • inlineCompletion: boolean

      %TRUE to do inline completion

    Returns void

  • setInlineSelection(inlineSelection: boolean): void
  • Sets whether it is possible to cycle through the possible completions inside the entry.

    Parameters

    • inlineSelection: boolean

      %TRUE to do inline selection

    Returns void

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

    Parameters

    Returns void

  • setMinimumKeyLength(length: number): 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 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.

    Parameters

    Returns void

  • setName(name: string): void
  • setPopupCompletion(popupCompletion: boolean): void
  • Sets whether the completions should be presented in a popup window.

    Parameters

    • popupCompletion: boolean

      %TRUE to do popup completion

    Returns void

  • setPopupSetWidth(popupSetWidth: boolean): void
  • Sets whether the completion popup window will be resized to be the same width as the entry.

    Parameters

    • popupSetWidth: boolean

      %TRUE to make the width of the popup the same as the entry

    Returns void

  • setPopupSingleMatch(popupSingleMatch: boolean): 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

    • popupSingleMatch: boolean

      %TRUE if the popup should appear even for a single match

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setTextColumn(column: number): 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 #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 #GtkEntryCompletion:text-column property directly.

    Parameters

    • column: number

      the column in the model of completion to get strings from

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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

  • unref(): 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 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 instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): 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

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

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

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) 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

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

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

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

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

    Parameters

    • area: Gtk.CellArea

      the #GtkCellArea used to layout cells

    Returns Gtk.EntryCompletion

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method