Interface

Gtk-4.0GtkTreeViewSignalSignatures

interface SignalSignatures {
    "columns-changed": () => void;
    "cursor-changed": () => void;
    destroy: () => void;
    "direction-changed": (arg0: Gtk.TextDirection) => void;
    "expand-collapse-cursor-row": (
        arg0: boolean,
        arg1: boolean,
        arg2: boolean,
    ) => boolean | void;
    hide: () => void;
    "keynav-failed": (arg0: Gtk.DirectionType) => boolean | void;
    map: () => void;
    "mnemonic-activate": (arg0: boolean) => boolean | void;
    "move-cursor": (
        arg0: Gtk.MovementStep,
        arg1: number,
        arg2: boolean,
        arg3: boolean,
    ) => boolean | void;
    "move-focus": (arg0: Gtk.DirectionType) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::accessible-role": (pspec: GObject.ParamSpec) => void;
    "notify::activate-on-single-click": (pspec: GObject.ParamSpec) => void;
    "notify::can-focus": (pspec: GObject.ParamSpec) => void;
    "notify::can-target": (pspec: GObject.ParamSpec) => void;
    "notify::css-classes": (pspec: GObject.ParamSpec) => void;
    "notify::css-name": (pspec: GObject.ParamSpec) => void;
    "notify::cursor": (pspec: GObject.ParamSpec) => void;
    "notify::enable-grid-lines": (pspec: GObject.ParamSpec) => void;
    "notify::enable-search": (pspec: GObject.ParamSpec) => void;
    "notify::enable-tree-lines": (pspec: GObject.ParamSpec) => void;
    "notify::expander-column": (pspec: GObject.ParamSpec) => void;
    "notify::fixed-height-mode": (pspec: GObject.ParamSpec) => void;
    "notify::focus-on-click": (pspec: GObject.ParamSpec) => void;
    "notify::focusable": (pspec: GObject.ParamSpec) => void;
    "notify::hadjustment": (pspec: GObject.ParamSpec) => void;
    "notify::halign": (pspec: GObject.ParamSpec) => void;
    "notify::has-default": (pspec: GObject.ParamSpec) => void;
    "notify::has-focus": (pspec: GObject.ParamSpec) => void;
    "notify::has-tooltip": (pspec: GObject.ParamSpec) => void;
    "notify::headers-clickable": (pspec: GObject.ParamSpec) => void;
    "notify::headers-visible": (pspec: GObject.ParamSpec) => void;
    "notify::height-request": (pspec: GObject.ParamSpec) => void;
    "notify::hexpand": (pspec: GObject.ParamSpec) => void;
    "notify::hexpand-set": (pspec: GObject.ParamSpec) => void;
    "notify::hover-expand": (pspec: GObject.ParamSpec) => void;
    "notify::hover-selection": (pspec: GObject.ParamSpec) => void;
    "notify::hscroll-policy": (pspec: GObject.ParamSpec) => void;
    "notify::layout-manager": (pspec: GObject.ParamSpec) => void;
    "notify::level-indentation": (pspec: GObject.ParamSpec) => void;
    "notify::limit-events": (pspec: GObject.ParamSpec) => void;
    "notify::margin-bottom": (pspec: GObject.ParamSpec) => void;
    "notify::margin-end": (pspec: GObject.ParamSpec) => void;
    "notify::margin-start": (pspec: GObject.ParamSpec) => void;
    "notify::margin-top": (pspec: GObject.ParamSpec) => void;
    "notify::model": (pspec: GObject.ParamSpec) => void;
    "notify::name": (pspec: GObject.ParamSpec) => void;
    "notify::opacity": (pspec: GObject.ParamSpec) => void;
    "notify::overflow": (pspec: GObject.ParamSpec) => void;
    "notify::parent": (pspec: GObject.ParamSpec) => void;
    "notify::receives-default": (pspec: GObject.ParamSpec) => void;
    "notify::reorderable": (pspec: GObject.ParamSpec) => void;
    "notify::root": (pspec: GObject.ParamSpec) => void;
    "notify::rubber-banding": (pspec: GObject.ParamSpec) => void;
    "notify::scale-factor": (pspec: GObject.ParamSpec) => void;
    "notify::search-column": (pspec: GObject.ParamSpec) => void;
    "notify::sensitive": (pspec: GObject.ParamSpec) => void;
    "notify::show-expanders": (pspec: GObject.ParamSpec) => void;
    "notify::tooltip-column": (pspec: GObject.ParamSpec) => void;
    "notify::tooltip-markup": (pspec: GObject.ParamSpec) => void;
    "notify::tooltip-text": (pspec: GObject.ParamSpec) => void;
    "notify::vadjustment": (pspec: GObject.ParamSpec) => void;
    "notify::valign": (pspec: GObject.ParamSpec) => void;
    "notify::vexpand": (pspec: GObject.ParamSpec) => void;
    "notify::vexpand-set": (pspec: GObject.ParamSpec) => void;
    "notify::visible": (pspec: GObject.ParamSpec) => void;
    "notify::vscroll-policy": (pspec: GObject.ParamSpec) => void;
    "notify::width-request": (pspec: GObject.ParamSpec) => void;
    "query-tooltip": (
        arg0: number,
        arg1: number,
        arg2: boolean,
        arg3: Gtk.Tooltip,
    ) => boolean | void;
    realize: () => void;
    "row-activated": (arg0: Gtk.TreePath, arg1: Gtk.TreeViewColumn) => void;
    "row-collapsed": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => void;
    "row-expanded": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => void;
    "select-all": () => boolean | void;
    "select-cursor-parent": () => boolean | void;
    "select-cursor-row": (arg0: boolean) => boolean | void;
    show: () => void;
    "start-interactive-search": () => boolean | void;
    "state-flags-changed": (arg0: Gtk.StateFlags) => void;
    "test-collapse-row": (
        arg0: Gtk.TreeIter,
        arg1: Gtk.TreePath,
    ) => boolean | void;
    "test-expand-row": (
        arg0: Gtk.TreeIter,
        arg1: Gtk.TreePath,
    ) => boolean | void;
    "toggle-cursor-row": () => boolean | void;
    unmap: () => void;
    unrealize: () => void;
    "unselect-all": () => boolean | void;
}

Hierarchy (View Summary)

Index

Properties

Properties - Inherited from Gtk.Widget.SignalSignatures

Properties

"columns-changed": () => void

The number of columns of the treeview has changed.

"cursor-changed": () => void

The position of the cursor (focused cell) has changed.

"expand-collapse-cursor-row": (
    arg0: boolean,
    arg1: boolean,
    arg2: boolean,
) => boolean | void
"move-cursor": (
    arg0: Gtk.MovementStep,
    arg1: number,
    arg2: boolean,
    arg3: boolean,
) => boolean | void

The Gtk.TreeView::move-cursor signal is a [keybinding signal]Gtk.SignalAction which gets emitted when the user presses one of the cursor keys.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically. In contrast to gtk_tree_view_set_cursor() and gtk_tree_view_set_cursor_on_cell() when moving horizontally Gtk.TreeView::move-cursor does not reset the current selection.

"notify::accessible-role": (pspec: GObject.ParamSpec) => void
"notify::activate-on-single-click": (pspec: GObject.ParamSpec) => void
"notify::can-focus": (pspec: GObject.ParamSpec) => void
"notify::can-target": (pspec: GObject.ParamSpec) => void
"notify::css-classes": (pspec: GObject.ParamSpec) => void
"notify::css-name": (pspec: GObject.ParamSpec) => void
"notify::cursor": (pspec: GObject.ParamSpec) => void
"notify::enable-grid-lines": (pspec: GObject.ParamSpec) => void
"notify::enable-search": (pspec: GObject.ParamSpec) => void
"notify::enable-tree-lines": (pspec: GObject.ParamSpec) => void
"notify::expander-column": (pspec: GObject.ParamSpec) => void
"notify::fixed-height-mode": (pspec: GObject.ParamSpec) => void
"notify::focus-on-click": (pspec: GObject.ParamSpec) => void
"notify::focusable": (pspec: GObject.ParamSpec) => void
"notify::hadjustment": (pspec: GObject.ParamSpec) => void
"notify::halign": (pspec: GObject.ParamSpec) => void
"notify::has-default": (pspec: GObject.ParamSpec) => void
"notify::has-focus": (pspec: GObject.ParamSpec) => void
"notify::has-tooltip": (pspec: GObject.ParamSpec) => void
"notify::headers-clickable": (pspec: GObject.ParamSpec) => void
"notify::headers-visible": (pspec: GObject.ParamSpec) => void
"notify::height-request": (pspec: GObject.ParamSpec) => void
"notify::hexpand": (pspec: GObject.ParamSpec) => void
"notify::hexpand-set": (pspec: GObject.ParamSpec) => void
"notify::hover-expand": (pspec: GObject.ParamSpec) => void
"notify::hover-selection": (pspec: GObject.ParamSpec) => void
"notify::hscroll-policy": (pspec: GObject.ParamSpec) => void
"notify::layout-manager": (pspec: GObject.ParamSpec) => void
"notify::level-indentation": (pspec: GObject.ParamSpec) => void
"notify::limit-events": (pspec: GObject.ParamSpec) => void
"notify::margin-bottom": (pspec: GObject.ParamSpec) => void
"notify::margin-end": (pspec: GObject.ParamSpec) => void
"notify::margin-start": (pspec: GObject.ParamSpec) => void
"notify::margin-top": (pspec: GObject.ParamSpec) => void
"notify::model": (pspec: GObject.ParamSpec) => void
"notify::name": (pspec: GObject.ParamSpec) => void
"notify::opacity": (pspec: GObject.ParamSpec) => void
"notify::overflow": (pspec: GObject.ParamSpec) => void
"notify::parent": (pspec: GObject.ParamSpec) => void
"notify::receives-default": (pspec: GObject.ParamSpec) => void
"notify::reorderable": (pspec: GObject.ParamSpec) => void
"notify::root": (pspec: GObject.ParamSpec) => void
"notify::rubber-banding": (pspec: GObject.ParamSpec) => void
"notify::scale-factor": (pspec: GObject.ParamSpec) => void
"notify::search-column": (pspec: GObject.ParamSpec) => void
"notify::sensitive": (pspec: GObject.ParamSpec) => void
"notify::show-expanders": (pspec: GObject.ParamSpec) => void
"notify::tooltip-column": (pspec: GObject.ParamSpec) => void
"notify::tooltip-markup": (pspec: GObject.ParamSpec) => void
"notify::tooltip-text": (pspec: GObject.ParamSpec) => void
"notify::vadjustment": (pspec: GObject.ParamSpec) => void
"notify::valign": (pspec: GObject.ParamSpec) => void
"notify::vexpand": (pspec: GObject.ParamSpec) => void
"notify::vexpand-set": (pspec: GObject.ParamSpec) => void
"notify::visible": (pspec: GObject.ParamSpec) => void
"notify::vscroll-policy": (pspec: GObject.ParamSpec) => void
"notify::width-request": (pspec: GObject.ParamSpec) => void
"row-activated": (arg0: Gtk.TreePath, arg1: Gtk.TreeViewColumn) => void

The "row-activated" signal is emitted when the method Gtk.TreeView.row_activated is called.

This signal is emitted when the user double-clicks a treeview row with the Gtk.TreeView.activate_on_single_click property set to false, or when the user single-clicks a row when that property set to true.

This signal is also emitted when a non-editable row is selected and one of the keys: Space, Shift+Space, Return or Enter is pressed.

For selection handling refer to the tree widget conceptual overview as well as Gtk.TreeSelection.

"row-collapsed": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => void

The given row has been collapsed (child nodes are hidden).

"row-expanded": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => void

The given row has been expanded (child nodes are shown).

"select-all": () => boolean | void
"select-cursor-parent": () => boolean | void
"select-cursor-row": (arg0: boolean) => boolean | void
"start-interactive-search": () => boolean | void
"test-collapse-row": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => boolean | void

The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.

"test-expand-row": (arg0: Gtk.TreeIter, arg1: Gtk.TreePath) => boolean | void

The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.

"toggle-cursor-row": () => boolean | void
"unselect-all": () => boolean | void

Properties - Inherited from Gtk.Widget.SignalSignatures

destroy: () => void

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

"direction-changed": (arg0: Gtk.TextDirection) => void

Emitted when the text direction of a widget changes.

hide: () => void

Emitted when widget is hidden.

"keynav-failed": (arg0: Gtk.DirectionType) => boolean | void

Emitted if keyboard navigation fails.

See Gtk.Widget.keynav_failed for details.

map: () => void

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with Gtk.Widget.visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of Gtk.Widget::unmap.

"mnemonic-activate": (arg0: boolean) => boolean | void

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.

"move-focus": (arg0: Gtk.DirectionType) => void

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
G_CALLBACK (gtk_text_view_target_list_notify),
text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.

"query-tooltip": (
    arg0: number,
    arg1: number,
    arg2: boolean,
    arg3: Gtk.Tooltip,
) => boolean | void

Emitted when the widget’s tooltip is about to be shown.

This happens when the Gtk.Widget.has_tooltip property is true and the hover timeout has expired with the cursor hovering above widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

realize: () => void

Emitted when widget is associated with a Gdk.Surface.

This means that Gtk.Widget.realize has been called or the widget has been mapped (that is, it is going to be drawn).

show: () => void

Emitted when widget is shown.

"state-flags-changed": (arg0: Gtk.StateFlags) => void

Emitted when the widget state changes.

See Gtk.Widget.get_state_flags.

unmap: () => void

Emitted when widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize: () => void

Emitted when the Gdk.Surface associated with widget is destroyed.

This means that Gtk.Widget.unrealize has been called or the widget has been unmapped (that is, it is going to be hidden).