Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GtkTreeViewSelectallCallback

[2624:7] extends: object

Generated low-level callback wrapper for GIR callback select-all.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewSelectallCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewMeta

[3190:14] static extends: object

Generated metadata helpers for TreeView class surfaces.

Methods

  • properties ()

    Returns property metadata for TreeView.

    • @r A list.

  • signals ()

    Returns signal metadata for TreeView.

    • @r A list.

class: GtkTreeViewUnselectallCallback

[3120:7] extends: object

Generated low-level callback wrapper for GIR callback unselect-all.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewUnselectallCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewStartinteractivesearchCallback

[2836:7] extends: object

Generated low-level callback wrapper for GIR callback start-interactive-search.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewStartinteractivesearchCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewSelectcursorrowCallback

[2764:7] extends: object

Generated low-level callback wrapper for GIR callback select-cursor-row.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewSelectcursorrowCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, object, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewSelectcursorparentCallback

[2694:7] extends: object

Generated low-level callback wrapper for GIR callback select-cursor-parent.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewSelectcursorparentCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewColumnschangedCallback

[2121:7] extends: object

Generated low-level callback wrapper for GIR callback columns-changed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewColumnschangedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewRowactivatedCallback

[2408:7] extends: object

Generated low-level callback wrapper for GIR callback row-activated.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewRowactivatedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, path, column, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewMovecursorCallback

[2335:7] extends: object

Generated low-level callback wrapper for GIR callback move-cursor.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewMovecursorCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, step, direction, extend, modify, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewTestcollapserowCallback

[2906:7] extends: object

Generated low-level callback wrapper for GIR callback test-collapse-row.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewTestcollapserowCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, iter, path, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewRowcollapsedCallback

[2480:7] extends: object

Generated low-level callback wrapper for GIR callback row-collapsed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewRowcollapsedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, iter, path, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeView

[55:7] extends: object

A widget for displaying both trees and lists An example GtkTreeView Widget that displays any object that implements the [iface@Gtk.TreeModel] interface. Please refer to the tree widget conceptual overview for an overview of all the objects and data types related to the tree widget and how they work together. ## Coordinate systems in GtkTreeView API Several different coordinate systems are exposed in the GtkTreeView API. These are: - Widget coordinates: Coordinates relative to the widget (usually widget->window). - Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to. - Tree coordinates: Coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree. Several functions are available for converting between the different coordinate systems. The most common translations are between widget and bin window coordinates and between bin window and tree coordinates. For the former you can use [method@Gtk.TreeView.convert_widget_to_bin_window_coords] (and vice versa), for the latter [method@Gtk.TreeView.convert_bin_window_to_tree_coords] (and vice versa). ## GtkTreeView as GtkBuildable The GtkTreeView implementation of the GtkBuildable interface accepts [class@Gtk.TreeViewColumn] objects as <child> elements and exposes the internal [class@Gtk.TreeSelection] in UI definitions. An example of a UI definition fragment with GtkTreeView: xml <object class="GtkTreeView" id="treeview"> <property name="model">liststore1</property> <child> <object class="GtkTreeViewColumn" id="test-column"> <property name="title">Test</property> <child> <object class="GtkCellRendererText" id="test-renderer"/> <attributes> <attribute name="text">1</attribute> </attributes> </child> </object> </child> <child internal-child="selection"> <object class="GtkTreeSelection" id="selection"> <signal name="changed" handler="on_treeview_selection_changed"/> </object> </child> </object> ## CSS nodes treeview.view ├── header │ ├── button │ │ ╰── [sort-indicator] ┊ ┊ │ ╰── button │ ╰── [sort-indicator] │ ├── [rubberband] ╰── [dndtarget] GtkTreeView has a main CSS node with name treeview and style class .view. It has a subnode with name header, which is the parent for all the column header widgets' CSS nodes. Each column header consists of a button, which among other content, has a child with name sort-indicator, which carries the .ascending or .descending style classes when the column header should show a sort indicator. The CSS is expected to provide a suitable image using the -gtk-icon-source property. For rubberband selection, a subnode with name rubberband is used. For the drop target location during DND, a subnode with name dndtarget is used.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GtkTreeView (model = null)

    Creates a new GtkTreeView widget.

    • @p model is the model..

  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.

  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.

  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.

  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.

  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.

  • asWidget ()

    Wraps this handle as GtkWidget.

    • @r A GtkWidget object.

  • asAccessible ()

    Wraps this handle as GtkAccessible.

    • @r A GtkAccessible object.

  • asBuildable ()

    Wraps this handle as GtkBuildable.

    • @r A GtkBuildable object.

  • asConstraintTarget ()

    Wraps this handle as GtkConstraintTarget.

    • @r A GtkConstraintTarget object.

  • asScrollable ()

    Wraps this handle as GtkScrollable.

    • @r A GtkScrollable object.

  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.

  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.

  • setOnColumnschanged (callback Fn, UserData = null)

    The number of columns of the treeview has changed.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnCursorchanged (callback Fn, UserData = null)

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

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnExpandcollapsecursorrow (callback Fn, UserData = null)

    Sets the generated callback for the expand-collapse-cursor-row signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, bool Object, bool P0, bool P1).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnMovecursor (callback Fn, UserData = null)

    The GtkTreeView::move-cursor signal is a [keybinding signal][class@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 GtkTreeView::move-cursor does not reset the current selection.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, string Step, int Direction, bool Extend, bool Modify).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnRowactivated (callback Fn, UserData = null)

    The "row-activated" signal is emitted when the method [method@Gtk.TreeView.row_activated] is called. This signal is emitted when the user double-clicks a treeview row with the [property@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 GtkTreeSelection.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, GtkTreePath Path, GtkTreeViewColumn Column).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnRowcollapsed (callback Fn, UserData = null)

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

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, GtkTreeIter Iter, GtkTreePath Path).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnRowexpanded (callback Fn, UserData = null)

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

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, GtkTreeIter Iter, GtkTreePath Path).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnSelectall (callback Fn, UserData = null)

    Sets the generated callback for the select-all signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnSelectcursorparent (callback Fn, UserData = null)

    Sets the generated callback for the select-cursor-parent signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnSelectcursorrow (callback Fn, UserData = null)

    Sets the generated callback for the select-cursor-row signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, bool Object).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnStartinteractivesearch (callback Fn, UserData = null)

    Sets the generated callback for the start-interactive-search signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnTestcollapserow (callback Fn, UserData = null)

    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.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, GtkTreeIter Iter, GtkTreePath Path).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnTestexpandrow (callback Fn, UserData = null)

    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.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self, GtkTreeIter Iter, GtkTreePath Path).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnTogglecursorrow (callback Fn, UserData = null)

    Sets the generated callback for the toggle-cursor-row signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnUnselectall (callback Fn, UserData = null)

    Sets the generated callback for the unselect-all signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GtkTreeView Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setActivateonsingleclick (bool Value)

    The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click.

    • @p Value is the new property value.
    • @r None.

  • setEnablegridlines (string Value)

    Writes the enable-grid-lines property.

    • @p Value is the new property value.
    • @r None.

  • setEnablesearch (bool Value)

    Writes the enable-search property.

    • @p Value is the new property value.
    • @r None.

  • setEnabletreelines (bool Value)

    Writes the enable-tree-lines property.

    • @p Value is the new property value.
    • @r None.

  • setExpandercolumn (object Value)

    Writes the expander-column property.

    • @p Value is the new property value.
    • @r None.

  • setFixedheightmode (bool Value)

    Setting the ::fixed-height-mode property to %TRUE speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more information on this option.

    • @p Value is the new property value.
    • @r None.

  • setHeadersclickable (bool Value)

    Writes the headers-clickable property.

    • @p Value is the new property value.
    • @r None.

  • setHeadersvisible (bool Value)

    Writes the headers-visible property.

    • @p Value is the new property value.
    • @r None.

  • setHoverexpand (bool Value)

    Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. This mode is primarily intended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.

    • @p Value is the new property value.
    • @r None.

  • setHoverselection (bool Value)

    Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. This mode is primarily intended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.

    • @p Value is the new property value.
    • @r None.

  • setLevelindentation (int Value)

    Extra indentation for each level.

    • @p Value is the new property value.
    • @r None.

  • setModel (object Value)

    Writes the model property.

    • @p Value is the new property value.
    • @r None.

  • setReorderable (bool Value)

    Writes the reorderable property.

    • @p Value is the new property value.
    • @r None.

  • setRubberbanding (bool Value)

    Writes the rubber-banding property.

    • @p Value is the new property value.
    • @r None.

  • setSearchcolumn (int Value)

    Writes the search-column property.

    • @p Value is the new property value.
    • @r None.

  • setShowexpanders (bool Value)

    %TRUE if the view has expanders.

    • @p Value is the new property value.
    • @r None.

  • setTooltipcolumn (int Value)

    Writes the tooltip-column property.

    • @p Value is the new property value.
    • @r None.

  • append_column (object column)

    Appends @column to the list of columns. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    • @p column is The GtkTreeViewColumn to add..
    • @r The number of columns in @tree_view after appending..

  • collapse_all ()

    Recursively collapses all visible, expanded nodes in @tree_view.

    • @r None.

  • collapse_row (object path)

    Collapses a row (hides its child rows, if they exist).

    • @p path is path to a row in the @tree_view.
    • @r %TRUE if the row was collapsed..

  • columns_autosize ()

    Resizes all columns to their optimal width. Only works after the treeview has been realized.

    • @r None.

  • convert_bin_window_to_tree_coords (int bx, int by)

    Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

    • @p bx is X coordinate relative to bin_window.
    • @p by is Y coordinate relative to bin_window.
    • @p tx is return location for tree X coordinate.
    • @p ty is return location for tree Y coordinate.
    • @r None.

  • convert_bin_window_to_widget_coords (int bx, int by)

    Converts bin_window coordinates to widget relative coordinates.

    • @p bx is bin_window X coordinate.
    • @p by is bin_window Y coordinate.
    • @p wx is return location for widget X coordinate.
    • @p wy is return location for widget Y coordinate.
    • @r None.

  • convert_tree_to_bin_window_coords (int tx, int ty)

    Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

    • @p tx is tree X coordinate.
    • @p ty is tree Y coordinate.
    • @p bx is return location for X coordinate relative to bin_window.
    • @p by is return location for Y coordinate relative to bin_window.
    • @r None.

  • convert_tree_to_widget_coords (int tx, int ty)

    Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

    • @p tx is X coordinate relative to the tree.
    • @p ty is Y coordinate relative to the tree.
    • @p wx is return location for widget X coordinate.
    • @p wy is return location for widget Y coordinate.
    • @r None.

  • convert_widget_to_bin_window_coords (int wx, int wy)

    Converts widget coordinates to coordinates for the bin_window.

    • @p wx is X coordinate relative to the widget.
    • @p wy is Y coordinate relative to the widget.
    • @p bx is return location for bin_window X coordinate.
    • @p by is return location for bin_window Y coordinate.
    • @r None.

  • convert_widget_to_tree_coords (int wx, int wy)

    Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

    • @p wx is X coordinate relative to the widget.
    • @p wy is Y coordinate relative to the widget.
    • @p tx is return location for tree X coordinate.
    • @p ty is return location for tree Y coordinate.
    • @r None.

  • create_row_drag_icon (object path)

    Creates a cairo_surface_t representation of the row at @path. This image is used for a drag icon.

    • @p path is a GtkTreePath in @tree_view.
    • @r a newly-allocated surface of the drag icon..

  • enable_model_drag_dest (object formats, string actions)

    Turns @tree_view into a drop destination for automatic DND. Calling this method sets GtkTreeView:reorderable to %FALSE.

    • @p formats is the target formats that the drag will support.
    • @p actions is the bitmask of possible actions for a drag from this widget.
    • @r None.

  • enable_model_drag_source (string start_button_mask, object formats, string actions)

    Turns @tree_view into a drag source for automatic DND. Calling this method sets GtkTreeView:reorderable to %FALSE.

    • @p start_button_mask is Mask of allowed buttons to start drag.
    • @p formats is the target formats that the drag will support.
    • @p actions is the bitmask of possible actions for a drag from this widget.
    • @r None.

  • expand_all ()

    Recursively expands all nodes in the @tree_view.

    • @r None.

  • expand_row (object path, bool open_all)

    Opens the row so its children are visible.

    • @p path is path to a row.
    • @p open_all is whether to recursively expand, or just expand immediate children.
    • @r %TRUE if the row existed and had children.

  • expand_to_path (object path)

    Expands the row at @path. This will also expand all parent rows of @path as necessary.

    • @p path is path to a row..
    • @r None.

  • get_activate_on_single_click ()

    Gets the setting set by gtk_tree_view_set_activate_on_single_click().

    • @r %TRUE if row-activated will be emitted on a single click.

  • get_background_area (object path, object column)

    Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a node not found in the tree, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the

    • @x and @width fields will be filled with 0. The returned rectangle is equivalent to the @background_area passed to gtk_cell_renderer_render(). These background areas tile to cover the entire bin window. Contrast with the @cell_area, returned by gtk_tree_view_get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.
    • @p path is a GtkTreePath for the row, or %NULL to get only horizontal coordinates.
    • @p column is a GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates.
    • @p rect is rectangle to fill with cell background rect.
    • @r None.

  • get_cell_area (object path, object column)

    Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is %NULL, or points to a path not currently displayed, the @y and @height fields of the rectangle will be filled with 0. If @column is %NULL, the

    • @x and @width fields will be filled with 0. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the @cell_area passed to gtk_cell_renderer_render(). This function is only valid if
    • @tree_view is realized.
    • @p path is a GtkTreePath for the row, or %NULL to get only horizontal coordinates.
    • @p column is a GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates.
    • @p rect is rectangle to fill with cell rect.
    • @r None.

  • get_column (int n)

    Gets the GtkTreeViewColumn at the given position in the #tree_view.

    • @p n is The position of the column, counting from 0..
    • @r The GtkTreeViewColumn, or %NULL if the position is outside the range of columns..

  • get_columns ()

    Returns a GList of all the GtkTreeViewColumns currently in

    • @tree_view. The returned list must be freed with g_list_free ().
    • @r A list of GtkTreeViewColumns.

  • get_cursor ()

    Fills in @path and @focus_column with the current path and focus column. If the cursor isn’t currently set, then *@path will be %NULL. If no column currently has focus, then *@focus_column will be %NULL. The returned GtkTreePath must be freed with gtk_tree_path_free() when you are done with it.

    • @p path is A pointer to be filled with the current cursor path.
    • @p focus_column is A pointer to be filled with the current focus column.
    • @r None.

  • get_dest_row_at_pos (int drag_x, int drag_y)

    Determines the destination row for a given position. @drag_x and @drag_y are expected to be in widget coordinates. This function is only meaningful if @tree_view is realized. Therefore this function will always return %FALSE if @tree_view is not realized or does not have a model.

    • @p drag_x is the position to determine the destination row for.
    • @p drag_y is the position to determine the destination row for.
    • @p path is Return location for the path of the highlighted row.
    • @p pos is Return location for the drop position, or %NULL.
    • @r whether there is a row at the given position, %TRUE if this is indeed the case..

  • get_drag_dest_row ()

    Gets information about the row that is highlighted for feedback.

    • @p path is Return location for the path of the highlighted row.
    • @p pos is Return location for the drop position.
    • @r None.

  • get_enable_search ()

    Returns whether or not the tree allows to start interactive searching by typing in text.

    • @r whether or not to let the user search interactively.

  • get_enable_tree_lines ()

    Returns whether or not tree lines are drawn in @tree_view.

    • @r %TRUE if tree lines are drawn in @tree_view, %FALSE otherwise..

  • get_expander_column ()

    Returns the column that is the current expander column, or %NULL if none has been set. This column has the expander arrow drawn next to it.

    • @r The expander column..

  • get_fixed_height_mode ()

    Returns whether fixed height mode is turned on for @tree_view.

    • @r %TRUE if @tree_view is in fixed height mode.

  • get_grid_lines ()

    Returns which grid lines are enabled in @tree_view.

    • @r a GtkTreeViewGridLines value indicating which grid lines are enabled..

  • get_headers_clickable ()

    Returns whether all header columns are clickable.

    • @r %TRUE if all header columns are clickable, otherwise %FALSE.

  • get_headers_visible ()

    Returns %TRUE if the headers on the @tree_view are visible.

    • @r Whether the headers are visible or not..

  • get_hover_expand ()

    Returns whether hover expansion mode is turned on for @tree_view.

    • @r %TRUE if @tree_view is in hover expansion mode.

  • get_hover_selection ()

    Returns whether hover selection mode is turned on for @tree_view.

    • @r %TRUE if @tree_view is in hover selection mode.

  • get_level_indentation ()

    Returns the amount, in pixels, of extra indentation for child levels in

    • @tree_view. ``
    • @r the amount of extra indentation for child levels in @tree_view. A return value of 0 means that this feature is disabled..

  • get_model ()

    Returns the model the GtkTreeView is based on. Returns %NULL if the model is unset.

    • @r A GtkTreeModel.

  • get_n_columns ()

    Queries the number of columns in the given @tree_view.

    • @r The number of columns in the @tree_view.

  • get_path_at_pos (int x, int y)

    Finds the path at the point (@x, @y), relative to bin_window coordinates. That is, @x and @y are relative to an events coordinates. Widget-relative coordinates must be converted using gtk_tree_view_convert_widget_to_bin_window_coords(). It is primarily for things like popup menus. If @path is non-%NULL, then it will be filled with the GtkTreePath at that point. This path should be freed with gtk_tree_path_free(). If @column is non-%NULL, then it will be filled with the column at that point. @cell_x and @cell_y return the coordinates relative to the cell background (i.e. the @background_area passed to gtk_cell_renderer_render()). This function is only meaningful if

    • @tree_view is realized. Therefore this function will always return %FALSE if @tree_view is not realized or does not have a model. For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords().
    • @p x is The x position to be identified (relative to bin_window)..
    • @p y is The y position to be identified (relative to bin_window)..
    • @p path is A pointer to a GtkTreePath pointer to be filled in.
    • @p column is A pointer to a GtkTreeViewColumn pointer to be filled in.
    • @p cell_x is A pointer where the X coordinate relative to the cell can be placed.
    • @p cell_y is A pointer where the Y coordinate relative to the cell can be placed.
    • @r %TRUE if a row exists at that coordinate..

  • get_reorderable ()

    Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable().

    • @r %TRUE if the tree can be reordered..

  • get_row_separator_func ()

    Returns the current row separator function.

    • @r the current row separator function..

  • get_rubber_banding ()

    Returns whether rubber banding is turned on for @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

    • @r %TRUE if rubber banding in @tree_view is enabled..

  • get_search_column ()

    Gets the column searched on by the interactive search code.

    • @r the column the interactive search code searches in..

  • get_search_entry ()

    Returns the GtkEntry which is currently in use as interactive search entry for @tree_view. In case the built-in entry is being used, %NULL will be returned.

    • @r the entry currently in use as search entry..

  • get_search_equal_func ()

    Returns the compare function currently in use.

    • @r the currently used compare function for the search code..

  • get_selection ()

    Gets the GtkTreeSelection associated with @tree_view.

    • @r A GtkTreeSelection object..

  • get_show_expanders ()

    Returns whether or not expanders are drawn in @tree_view.

    • @r %TRUE if expanders are drawn in @tree_view, %FALSE otherwise..

  • get_tooltip_column ()

    Returns the column of @tree_view’s model which is being used for displaying tooltips on @tree_view’s rows.

    • @r the index of the tooltip column that is currently being used, or -1 if this is disabled..

  • get_tooltip_context (int x, int y, bool keyboard_tip)

    This function is supposed to be used in a ::query-tooltip signal handler for GtkTreeView. The @x, @y and @keyboard_tip values which are received in the signal handler, should be passed to this function without modification. The return value indicates whether there is a tree view row at the given coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard tooltips the row returned will be the cursor row. When %TRUE, then any of @model, @path and @iter which have been provided will be set to point to that row and the corresponding model. @x and @y will always be converted to be relative to @tree_view’s bin_window if

    • @keyboard_tooltip is %FALSE.
    • @p x is the x coordinate (relative to widget coordinates).
    • @p y is the y coordinate (relative to widget coordinates).
    • @p keyboard_tip is whether this is a keyboard tooltip or not.
    • @p model is a pointer to receive a GtkTreeModel.
    • @p path is a pointer to receive a GtkTreePath.
    • @p iter is a pointer to receive a GtkTreeIter.
    • @r whether or not the given tooltip context points to a row.

  • get_visible_range ()

    Sets @start_path and @end_path to be the first and last visible path. Note that there may be invisible paths in between. The paths should be freed with gtk_tree_path_free() after use.

    • @p start_path is Return location for start of region.
    • @p end_path is Return location for end of region.
    • @r %TRUE, if valid paths were placed in @start_path and @end_path..

  • get_visible_rect ()

    Fills @visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

    • @p visible_rect is rectangle to fill.
    • @r None.

  • insert_column (object column, int position)

    This inserts the @column into the @tree_view at @position. If @position is -1, then the column is inserted at the end. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    • @p column is The GtkTreeViewColumn to be inserted..
    • @p position is The position to insert @column in..
    • @r The number of columns in @tree_view after insertion..

  • insert_column_with_attributes (int position, string title, object cell, list varargs)

    Creates a new GtkTreeViewColumn and inserts it into the @tree_view at

    • @position. If @position is -1, then the newly created column is inserted at the end. The column is initialized with the attributes given. If
    • @tree_view has “fixed_height” mode enabled, then the new column will have its sizing property set to be GTK_TREE_VIEW_COLUMN_FIXED.
    • @p position is The position to insert the new column in.
    • @p title is The title to set the header to.
    • @p cell is The GtkCellRenderer.
    • @p ... is A %NULL-terminated list of attributes.
    • @r The number of columns in @tree_view after insertion..

  • insert_column_with_data_func (int position, string title, object cell, object dnotify)

    Convenience function that inserts a new column into the GtkTreeView with the given cell renderer and a GtkTreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). If @tree_view has “fixed_height” mode enabled, then the new column will have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

    • @p position is Position to insert, -1 for append.
    • @p title is column title.
    • @p cell is cell renderer for column.
    • @p func is function to set attributes of cell renderer.
    • @p data is data for @func.
    • @p dnotify is destroy notifier for @data.
    • @r number of columns in the tree view post-insert.

  • is_blank_at_pos (int x, int y)

    Determine whether the point (@x, @y) in @tree_view is blank, that is no cell content nor an expander arrow is drawn at the location. If so, the location can be considered as the background. You might wish to take special action on clicks on the background, such as clearing a current selection, having a custom context menu or starting rubber banding. The

    • @x and @y coordinate that are provided must be relative to bin_window coordinates. Widget-relative coordinates must be converted using gtk_tree_view_convert_widget_to_bin_window_coords(). For converting widget coordinates (eg. the ones you get from GtkWidget::query-tooltip), please see gtk_tree_view_convert_widget_to_bin_window_coords(). The
    • @path, @column, @cell_x and @cell_y arguments will be filled in likewise as for gtk_tree_view_get_path_at_pos(). Please see gtk_tree_view_get_path_at_pos() for more information.
    • @p x is The x position to be identified (relative to bin_window).
    • @p y is The y position to be identified (relative to bin_window).
    • @p path is A pointer to a GtkTreePath pointer to be filled in.
    • @p column is A pointer to a GtkTreeViewColumn pointer to be filled in.
    • @p cell_x is A pointer where the X coordinate relative to the cell can be placed.
    • @p cell_y is A pointer where the Y coordinate relative to the cell can be placed.
    • @r %TRUE if the area at the given coordinates is blank, %FALSE otherwise..

  • is_rubber_banding_active ()

    Returns whether a rubber banding operation is currently being done in

    • @tree_view. ``
    • @r %TRUE if a rubber banding operation is currently being done in
    • @tree_view.. ``

  • map_expanded_rows (data)

    Calls @func on all expanded rows.

    • @p func is A function to be called.
    • @p data is User data to be passed to the function..
    • @r None.

  • move_column_after (object column, object base_column)

    Moves @column to be after to @base_column. If @base_column is %NULL, then

    • @column is placed in the first position.
    • @p column is The GtkTreeViewColumn to be moved..
    • @p base_column is The GtkTreeViewColumn to be moved relative to.
    • @r None.

  • remove_column (object column)

    Removes @column from @tree_view.

    • @p column is The GtkTreeViewColumn to remove..
    • @r The number of columns in @tree_view after removing..

  • row_activated (object path, object column)

    Activates the cell determined by @path and @column.

    • @p path is The GtkTreePath to be activated..
    • @p column is The GtkTreeViewColumn to be activated..
    • @r None.

  • row_expanded (object path)

    Returns %TRUE if the node pointed to by @path is expanded in @tree_view.

    • @p path is A GtkTreePath to test expansion state..
    • @r %TRUE if #path is expanded..

  • scroll_to_cell (object path, object column, bool use_align, double row_align, double col_align)

    Moves the alignments of @tree_view to the position specified by @column and @path. If @column is %NULL, then no horizontal scrolling occurs. Likewise, if @path is %NULL no vertical scrolling occurs. At a minimum, one of @column or @path need to be non-%NULL. @row_align determines where the row is placed, and @col_align determines where @column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center. If

    • @use_align is %FALSE, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to its current position. If the cell is currently visible on the screen, nothing is done. This function only works if the model is set, and @path is a valid row on the model. If the model changes before the @tree_view is realized, the centered path will be modified to reflect this change.
    • @p path is The path of the row to move to.
    • @p column is The GtkTreeViewColumn to move horizontally to.
    • @p use_align is whether to use alignment arguments, or %FALSE..
    • @p row_align is The vertical alignment of the row specified by @path..
    • @p col_align is The horizontal alignment of the column specified by
    • @column.. ``
    • @r None.

  • scroll_to_point (int tree_x, int tree_y)

    Scrolls the tree view such that the top-left corner of the visible area is @tree_x, @tree_y, where @tree_x and @tree_y are specified in tree coordinates. The @tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell(). If either @tree_x or @tree_y are -1, then that direction isn’t scrolled.

    • @p tree_x is X coordinate of new top-left pixel of visible area, or -1.
    • @p tree_y is Y coordinate of new top-left pixel of visible area, or -1.
    • @r None.

  • set_activate_on_single_click (bool single)

    Cause the GtkTreeView::row-activated signal to be emitted on a single click instead of a double click.

    • @p single is %TRUE to emit row-activated on a single click.
    • @r None.

  • set_column_drag_function (object destroy)

    Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to @func are: the @tree_view, the GtkTreeViewColumn being dragged, the two GtkTreeViewColumns determining the drop spot, and @user_data. If either of the GtkTreeViewColumn arguments for the drop spot are %NULL, then they indicate an edge. If @func is set to be %NULL, then @tree_view reverts to the default behavior of allowing all columns to be dropped everywhere.

    • @p func is A function to determine which columns are reorderable.
    • @p user_data is User data to be passed to @func.
    • @p destroy is Destroy notifier for @user_data.
    • @r None.

  • set_cursor (object path, object focus_column, bool start_editing)

    Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. Additionally, if @focus_column is specified, and

    • @start_editing is %TRUE, then editing should be started in the specified cell. This function is often followed by @gtk_widget_grab_focus (@tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized. If @path is invalid for @model, the current cursor (if any) will be unset and the function will return without failing.
    • @p path is A GtkTreePath.
    • @p focus_column is A GtkTreeViewColumn.
    • @p start_editing is %TRUE if the specified cell should start being edited..
    • @r None.

  • set_cursor_on_cell (object path, object focus_column, object focus_cell, bool start_editing)

    Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If @focus_column is not %NULL, then focus is given to the column specified by it. If @focus_column and @focus_cell are not %NULL, and

    • @focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by @focus_cell. Additionally, if
    • @focus_column is specified, and @start_editing is %TRUE, then editing should be started in the specified cell. This function is often followed by @gtk_widget_grab_focus (@tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized. If @path is invalid for @model, the current cursor (if any) will be unset and the function will return without failing.
    • @p path is A GtkTreePath.
    • @p focus_column is A GtkTreeViewColumn.
    • @p focus_cell is A GtkCellRenderer.
    • @p start_editing is %TRUE if the specified cell should start being edited..
    • @r None.

  • set_drag_dest_row (object path, string pos)

    Sets the row that is highlighted for feedback. If @path is %NULL, an existing highlight is removed.

    • @p path is The path of the row to highlight.
    • @p pos is Specifies whether to drop before, after or into the row.
    • @r None.

  • set_enable_search (bool enable_search)

    If @enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find"). Note that even if this is %FALSE, the user can still initiate a search using the “start-interactive-search” key binding.

    • @p enable_search is %TRUE, if the user can search interactively.
    • @r None.

  • set_enable_tree_lines (bool enabled)

    Sets whether to draw lines interconnecting the expanders in @tree_view. This does not have any visible effects for lists.

    • @p enabled is %TRUE to enable tree line drawing, %FALSE otherwise..
    • @r None.

  • set_expander_column (object column)

    Sets the column to draw the expander arrow at. It must be in @tree_view. If @column is %NULL, then the expander arrow is always at the first visible column. If you do not want expander arrow to appear in your tree, set the expander column to a hidden column.

    • @p column is %NULL, or the column to draw the expander arrow at..
    • @r None.

  • set_fixed_height_mode (bool enable)

    Enables or disables the fixed height mode of @tree_view. Fixed height mode speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type %GTK_TREE_VIEW_COLUMN_FIXED.

    • @p enable is %TRUE to enable fixed height mode.
    • @r None.

  • set_grid_lines (string grid_lines)

    Sets which grid lines to draw in @tree_view.

    • @p grid_lines is a GtkTreeViewGridLines value indicating which grid lines to enable..
    • @r None.

  • set_headers_clickable (bool setting)

    Allow the column title buttons to be clicked.

    • @p setting is %TRUE if the columns are clickable..
    • @r None.

  • set_headers_visible (bool headers_visible)

    Sets the visibility state of the headers.

    • @p headers_visible is %TRUE if the headers are visible.
    • @r None.

  • set_hover_expand (bool expand)

    Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

    • @p expand is %TRUE to enable hover selection mode.
    • @r None.

  • set_hover_selection (bool hover)

    Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.

    • @p hover is %TRUE to enable hover selection mode.
    • @r None.

  • set_level_indentation (int indentation)

    Sets the amount of extra indentation for child levels to use in

    • @tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.
    • @p indentation is the amount, in pixels, of extra indentation in
    • @tree_view.. ``
    • @r None.

  • set_model (object model)

    Sets the model for a GtkTreeView. If the @tree_view already has a model set, it will remove it before setting the new model. If @model is %NULL, then it will unset the old model.

    • @p model is The model..
    • @r None.

  • set_reorderable (bool reorderable)

    This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface. Both GtkTreeStore and GtkListStore support these. If @reorderable is %TRUE, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model’s GtkTreeModel::row-inserted and GtkTreeModel::row-deleted signals. The reordering is implemented by setting up the tree view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose. This function does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.

    • @p reorderable is %TRUE, if the tree can be reordered..
    • @r None.

  • set_row_separator_func (object destroy)

    Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is %NULL, no separators are drawn. This is the default value.

    • @p func is a GtkTreeViewRowSeparatorFunc.
    • @p data is user data to pass to @func.
    • @p destroy is destroy notifier for @data.
    • @r None.

  • set_rubber_banding (bool enable)

    Enables or disables rubber banding in @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

    • @p enable is %TRUE to enable rubber banding.
    • @r None.

  • set_search_column (int column)

    Sets @column as the column where the interactive search code should search in for the current model. If the search column is set, users can use the “start-interactive-search” key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search. Note that @column refers to a column of the current model. The search column is reset to -1 when the model is changed.

    • @p column is the column of the model to search in, or -1 to disable searching.
    • @r None.

  • set_search_entry (object entry)

    Sets the entry which the interactive search code will use for this

    • @tree_view. This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing %NULL for @entry will make the interactive search code use the built-in popup entry again.
    • @p entry is the entry the interactive search code of @tree_view should use.
    • @r None.

  • set_search_equal_func (object search_destroy)

    Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality GtkTreeViewSearchEqualFunc returns %FALSE on matches.

    • @p search_equal_func is the compare function to use during the search.
    • @p search_user_data is user data to pass to @search_equal_func.
    • @p search_destroy is Destroy notifier for @search_user_data.
    • @r None.

  • set_show_expanders (bool enabled)

    Sets whether to draw and enable expanders and indent child rows in

    • @tree_view. When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using gtk_tree_view_set_level_indentation(). This does not have any visible effects for lists.
    • @p enabled is %TRUE to enable expander drawing, %FALSE otherwise..
    • @r None.

  • set_tooltip_cell (object tooltip, object path, object column, object cell)

    Sets the tip area of @tooltip to the area @path, @column and @cell have in common. For example if @path is %NULL and @column is set, the tip area will be set to the full area covered by @column. See also gtk_tooltip_set_tip_area(). Note that if @path is not specified and @cell is set and part of a column containing the expander, the tooltip might not show and hide at the correct position. In such cases @path must be set to the current node under the mouse cursor for this function to operate correctly. See also gtk_tree_view_set_tooltip_column() for a simpler alternative.

    • @p tooltip is a GtkTooltip.
    • @p path is a GtkTreePath.
    • @p column is a GtkTreeViewColumn.
    • @p cell is a GtkCellRenderer.
    • @r None.

  • set_tooltip_column (int column)

    If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have GtkTreeView handle these automatically for you. @column should be set to the column in @tree_view’s model containing the tooltip texts, or -1 to disable this feature. When enabled, GtkWidget:has-tooltip will be set to %TRUE and @tree_view will connect a GtkWidget::query-tooltip signal handler. Note that the signal handler sets the text with gtk_tooltip_set_markup(), so &, <, etc have to be escaped in the text.

    • @p column is an integer, which is a valid column number for @tree_view’s model.
    • @r None.

  • set_tooltip_row (object tooltip, object path)

    Sets the tip area of @tooltip to be the area covered by the row at @path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area().

    • @p tooltip is a GtkTooltip.
    • @p path is a GtkTreePath.
    • @r None.

  • unset_rows_drag_dest ()

    Undoes the effect of gtk_tree_view_enable_model_drag_dest(). Calling this method sets GtkTreeView:reorderable to %FALSE.

    • @r None.

  • unset_rows_drag_source ()

    Undoes the effect of gtk_tree_view_enable_model_drag_source(). Calling this method sets GtkTreeView:reorderable to %FALSE.

    • @r None.

  • columns ()

    Returns get_columns as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_columns() when lazy or change-notify access is required.

    • @r An Aussom list of elements.

class: GtkTreeViewTestexpandrowCallback

[2978:7] extends: object

Generated low-level callback wrapper for GIR callback test-expand-row.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewTestexpandrowCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, iter, path, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewExpandcollapsecursorrowCallback

[2262:7] extends: object

Generated low-level callback wrapper for GIR callback expand-collapse-cursor-row.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewExpandcollapsecursorrowCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, object, p0, p1, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewTogglecursorrowCallback

[3050:7] extends: object

Generated low-level callback wrapper for GIR callback toggle-cursor-row.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewTogglecursorrowCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewRowexpandedCallback

[2552:7] extends: object

Generated low-level callback wrapper for GIR callback row-expanded.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewRowexpandedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, iter, path, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GtkTreeViewCursorchangedCallback

[2191:7] extends: object

Generated low-level callback wrapper for GIR callback cursor-changed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GtkTreeViewCursorchangedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

Aussom

Write once. Embed everywhere.

Language

Tools

Community

Copyright 2026 Austin Lehman. All rights reserved.