Gtk.Tree_View

Description

A widget for displaying both trees and lists

<picture> <source srcset="list-and-tree-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkTreeView" src="list-and-tree.png"> </picture> Widget that displays any object that implements the [ifaceGtk.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 [methodGtk.TreeView.convert_widget_to_bin_window_coords] (and vice versa), for the latter [methodGtk.TreeView.convert_bin_window_to_tree_coords] (and vice versa).

## GtkTreeView as GtkBuildable

The GtkTreeView implementation of the GtkBuildable interface accepts [classGtk.TreeViewColumn] objects as <child> elements and exposes the internal [classGtk.TreeSelection] in UI definitions.

An example of a UI definition fragment with GtkTreeView:

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.

"+"

function "+"
  (Widget : access Gtk_Tree_View_Record'Class)
return Gtk.Accessible.Gtk_Accessible

Parameters

Widget

Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_View_Record'Class)
return Gtk.Buildable.Gtk_Buildable

Parameters

Widget

Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_View_Record'Class)
return Gtk.Constraint_Target.Gtk_Constraint_Target

Parameters

Widget

Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_View_Record'Class)
return Gtk.Scrollable.Gtk_Scrollable

Parameters

Widget

Return Value

"-"

function "-"
  (Interf : Gtk.Accessible.Gtk_Accessible)
return Gtk_Tree_View

Parameters

Interf

Return Value

"-"

function "-"
  (Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Tree_View

Parameters

Interf

Return Value

"-"

function "-"
  (Interf : Gtk.Constraint_Target.Gtk_Constraint_Target)
return Gtk_Tree_View

Parameters

Interf

Return Value

"-"

function "-"
  (Interf : Gtk.Scrollable.Gtk_Scrollable)
return Gtk_Tree_View

Parameters

Interf

Return Value

Activate_On_Single_Click_Property

Activate_On_Single_Click_Property : constant Glib.Properties.Property_Boolean;

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

Announce

procedure Announce
   (Self     : not null access Gtk_Tree_View_Record;
    Message  : UTF8_String;
    Priority : Gtk.Accessible.Gtk_Accessible_Announcement_Priority)

Parameters

Self
Message
Priority

Append_Column

function Append_Column
   (Self   : not null access Gtk_Tree_View_Record;
    Column : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)
    return Glib.Gint

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. Deprecated since 4.10, 1

Parameters

Self
Column: The GtkTreeViewColumn to add.

Return Value

The number of columns in Tree_View after appending.

Cb_GObject_Boolean

type Cb_GObject_Boolean is not null access function
  (Self : access Glib.Object.GObject_Record'Class)
return Boolean;

Parameters

Self

Return Value

Cb_GObject_Boolean_Boolean

type Cb_GObject_Boolean_Boolean is not null access function
  (Self   : access Glib.Object.GObject_Record'Class;
   Object : Boolean) return Boolean;

Parameters

Self
Object

Return Value

Cb_GObject_Boolean_Boolean_Boolean_Boolean

type Cb_GObject_Boolean_Boolean_Boolean_Boolean is not null access function
  (Self   : access Glib.Object.GObject_Record'Class;
   Object : Boolean;
   P0     : Boolean;
   P1     : Boolean) return Boolean;

Parameters

Self
Object
P0
P1

Return Value

Cb_GObject_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean

type Cb_GObject_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean is not null access function
  (Self      : access Glib.Object.GObject_Record'Class;
   Step      : Gtk.Enums.Gtk_Movement_Step;
   Direction : Glib.Gint;
   Extend    : Boolean;
   Modify    : Boolean) return Boolean;

Parameters

Self
Step
Direction
Extend
Modify

Return Value

Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean

type Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean is not null access function
  (Self : access Glib.Object.GObject_Record'Class;
   Iter : Gtk.Tree_Model.Gtk_Tree_Iter;
   Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean;

Parameters

Self
Iter
Path

Return Value

Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Void

type Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Void is not null access procedure
  (Self : access Glib.Object.GObject_Record'Class;
   Iter : Gtk.Tree_Model.Gtk_Tree_Iter;
   Path : Gtk.Tree_Model.Gtk_Tree_Path);

Parameters

Self
Iter
Path

Cb_GObject_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void

type Cb_GObject_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void is not null access procedure
  (Self   : access Glib.Object.GObject_Record'Class;
   Path   : Gtk.Tree_Model.Gtk_Tree_Path;
   Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class);

Parameters

Self
Path
Column

Cb_GObject_Void

type Cb_GObject_Void is not null access procedure
  (Self : access Glib.Object.GObject_Record'Class);

Parameters

Self

Cb_Gtk_Tree_View_Boolean

type Cb_Gtk_Tree_View_Boolean is not null access function
  (Self : access Gtk_Tree_View_Record'Class) return Boolean;

Parameters

Self

Return Value

Cb_Gtk_Tree_View_Boolean_Boolean

type Cb_Gtk_Tree_View_Boolean_Boolean is not null access function
  (Self   : access Gtk_Tree_View_Record'Class;
   Object : Boolean) return Boolean;

Parameters

Self
Object

Return Value

Cb_Gtk_Tree_View_Boolean_Boolean_Boolean_Boolean

type Cb_Gtk_Tree_View_Boolean_Boolean_Boolean_Boolean is not null access function
  (Self   : access Gtk_Tree_View_Record'Class;
   Object : Boolean;
   P0     : Boolean;
   P1     : Boolean) return Boolean;

Parameters

Self
Object
P0
P1

Return Value

Cb_Gtk_Tree_View_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean

type Cb_Gtk_Tree_View_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean is not null access function
  (Self      : access Gtk_Tree_View_Record'Class;
   Step      : Gtk.Enums.Gtk_Movement_Step;
   Direction : Glib.Gint;
   Extend    : Boolean;
   Modify    : Boolean) return Boolean;

Parameters

Self
Step
Direction
Extend
Modify

Return Value

Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean

type Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean is not null access function
  (Self : access Gtk_Tree_View_Record'Class;
   Iter : Gtk.Tree_Model.Gtk_Tree_Iter;
   Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean;

Parameters

Self
Iter
Path

Return Value

Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Void

type Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Void is not null access procedure
  (Self : access Gtk_Tree_View_Record'Class;
   Iter : Gtk.Tree_Model.Gtk_Tree_Iter;
   Path : Gtk.Tree_Model.Gtk_Tree_Path);

Parameters

Self
Iter
Path

Cb_Gtk_Tree_View_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void

type Cb_Gtk_Tree_View_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void is not null access procedure
  (Self   : access Gtk_Tree_View_Record'Class;
   Path   : Gtk.Tree_Model.Gtk_Tree_Path;
   Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class);

Parameters

Self
Path
Column

Cb_Gtk_Tree_View_Void

type Cb_Gtk_Tree_View_Void is not null access procedure (Self : access Gtk_Tree_View_Record'Class);

Parameters

Self

Collapse_All

procedure Collapse_All (Self : not null access Gtk_Tree_View_Record)

Recursively collapses all visible, expanded nodes in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Collapse_Row

function Collapse_Row
   (Self : not null access Gtk_Tree_View_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean

Collapses a row (hides its child rows, if they exist). Deprecated since 4.10, 1

Parameters

Self
Path: path to a row in the Tree_View

Return Value

True if the row was collapsed.

Columns_Autosize

procedure Columns_Autosize (Self : not null access Gtk_Tree_View_Record)

Resizes all columns to their optimal width. Only works after the treeview has been realized. Deprecated since 4.10, 1

Parameters

Self

Convert_Bin_Window_To_Tree_Coords

procedure Convert_Bin_Window_To_Tree_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Bx   : Glib.Gint;
    By   : Glib.Gint;
    Tx   : out Glib.Gint;
    Ty   : out Glib.Gint)

Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree). Deprecated since 4.10, 1

Parameters

Self
Bx: X coordinate relative to bin_window
By: Y coordinate relative to bin_window
Tx: return location for tree X coordinate
Ty: return location for tree Y coordinate

Convert_Bin_Window_To_Widget_Coords

procedure Convert_Bin_Window_To_Widget_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Bx   : Glib.Gint;
    By   : Glib.Gint;
    Wx   : out Glib.Gint;
    Wy   : out Glib.Gint)

Converts bin_window coordinates to widget relative coordinates. Deprecated since 4.10, 1

Parameters

Self
Bx: bin_window X coordinate
By: bin_window Y coordinate
Wx: return location for widget X coordinate
Wy: return location for widget Y coordinate

Convert_Tree_To_Bin_Window_Coords

procedure Convert_Tree_To_Bin_Window_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Tx   : Glib.Gint;
    Ty   : Glib.Gint;
    Bx   : out Glib.Gint;
    By   : out Glib.Gint)

Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates. Deprecated since 4.10, 1

Parameters

Self
Tx: tree X coordinate
Ty: tree Y coordinate
Bx: return location for X coordinate relative to bin_window
By: return location for Y coordinate relative to bin_window

Convert_Tree_To_Widget_Coords

procedure Convert_Tree_To_Widget_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Tx   : Glib.Gint;
    Ty   : Glib.Gint;
    Wx   : out Glib.Gint;
    Wy   : out Glib.Gint)

Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates. Deprecated since 4.10, 1

Parameters

Self
Tx: X coordinate relative to the tree
Ty: Y coordinate relative to the tree
Wx: return location for widget X coordinate
Wy: return location for widget Y coordinate

Convert_Widget_To_Bin_Window_Coords

procedure Convert_Widget_To_Bin_Window_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Wx   : Glib.Gint;
    Wy   : Glib.Gint;
    Bx   : out Glib.Gint;
    By   : out Glib.Gint)

Converts widget coordinates to coordinates for the bin_window. Deprecated since 4.10, 1

Parameters

Self
Wx: X coordinate relative to the widget
Wy: Y coordinate relative to the widget
Bx: return location for bin_window X coordinate
By: return location for bin_window Y coordinate

Convert_Widget_To_Tree_Coords

procedure Convert_Widget_To_Tree_Coords
   (Self : not null access Gtk_Tree_View_Record;
    Wx   : Glib.Gint;
    Wy   : Glib.Gint;
    Tx   : out Glib.Gint;
    Ty   : out Glib.Gint)

Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree). Deprecated since 4.10, 1

Parameters

Self
Wx: X coordinate relative to the widget
Wy: Y coordinate relative to the widget
Tx: return location for tree X coordinate
Ty: return location for tree Y coordinate

Create_Row_Drag_Icon

function Create_Row_Drag_Icon
   (Self : not null access Gtk_Tree_View_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path)
    return Gdk.Paintable.Gdk_Paintable

Creates a cairo_surface_t representation of the row at Path. This image is used for a drag icon. Deprecated since 4.10, 1

Parameters

Self
Path: a GtkTreePath in Tree_View

Return Value

a newly-allocated surface of the drag icon.

Enable_Grid_Lines_Property

Enable_Grid_Lines_Property : constant Gtk.Enums.Property_Gtk_Tree_View_Grid_Lines;

Enable_Model_Drag_Dest

procedure Enable_Model_Drag_Dest
   (Self    : not null access Gtk_Tree_View_Record;
    Formats : Gdk.Content_Formats.Gdk_Content_Formats;
    Actions : Gdk.Drag.Drag_Action)

Turns Tree_View into a drop destination for automatic DND. Calling this method sets GtkTreeView:reorderable to False. Deprecated since 4.10, 1

Parameters

Self
Formats: the target formats that the drag will support
Actions: the bitmask of possible actions for a drag from this widget

Enable_Model_Drag_Source

procedure Enable_Model_Drag_Source
   (Self              : not null access Gtk_Tree_View_Record;
    Start_Button_Mask : Gdk.Enums.Gdk_Modifier_Type;
    Formats           : Gdk.Content_Formats.Gdk_Content_Formats;
    Actions           : Gdk.Drag.Drag_Action)

Turns Tree_View into a drag source for automatic DND. Calling this method sets GtkTreeView:reorderable to False. Deprecated since 4.10, 1

Parameters

Self
Start_Button_Mask: Mask of allowed buttons to start drag
Formats: the target formats that the drag will support
Actions: the bitmask of possible actions for a drag from this widget

Enable_Search_Property

Enable_Search_Property : constant Glib.Properties.Property_Boolean;

Enable_Tree_Lines_Property

Enable_Tree_Lines_Property : constant Glib.Properties.Property_Boolean;

Expand_All

procedure Expand_All (Self : not null access Gtk_Tree_View_Record)

Recursively expands all nodes in the Tree_View. Deprecated since 4.10, 1

Parameters

Self

Expand_Row

function Expand_Row
   (Self     : not null access Gtk_Tree_View_Record;
    Path     : Gtk.Tree_Model.Gtk_Tree_Path;
    Open_All : Boolean) return Boolean

Opens the row so its children are visible. Deprecated since 4.10, 1

Parameters

Self
Path: path to a row
Open_All: whether to recursively expand, or just expand immediate children

Return Value

True if the row existed and had children

Expand_To_Path

procedure Expand_To_Path
   (Self : not null access Gtk_Tree_View_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path)

Expands the row at Path. This will also expand all parent rows of Path as necessary. Deprecated since 4.10, 1

Parameters

Self
Path: path to a row.

Expander_Column_Property

Expander_Column_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Tree_View_Column.Gtk_Tree_View_Column

Fixed_Height_Mode_Property

Fixed_Height_Mode_Property : constant Glib.Properties.Property_Boolean;

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.

Get_Accessible_Id

function Get_Accessible_Id
   (Self : not null access Gtk_Tree_View_Record) return UTF8_String

Parameters

Self

Return Value

Get_Accessible_Parent

function Get_Accessible_Parent
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Accessible.Gtk_Accessible

Parameters

Self

Return Value

Get_Accessible_Role

function Get_Accessible_Role
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Accessible.Gtk_Accessible_Role

Parameters

Self

Return Value

Get_Activate_On_Single_Click

function Get_Activate_On_Single_Click
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Gets the setting set by Gtk.Tree_View.Set_Activate_On_Single_Click. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if row-activated will be emitted on a single click

Get_At_Context

function Get_At_Context
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Atcontext.Gtk_Atcontext

Parameters

Self

Return Value

Get_Background_Area

procedure Get_Background_Area
   (Self   : not null access Gtk_Tree_View_Record;
    Path   : Gtk.Tree_Model.Gtk_Tree_Path;
    Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Rect   : out Gdk.Rectangle.Gdk_Rectangle)

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. Deprecated since 4.10, 1

Parameters

Self
Path: a GtkTreePath for the row, or null to get only horizontal coordinates
Column: a GtkTreeViewColumn for the column, or null to get only vertical coordinates
Rect: rectangle to fill with cell background rect

Get_Border

function Get_Border
   (Self   : not null access Gtk_Tree_View_Record;
    Border : out Gtk.Scrollable.Gtk_Border) return Boolean

Parameters

Self
Border

Return Value

Get_Bounds

function Get_Bounds
   (Self   : not null access Gtk_Tree_View_Record;
    X      : out Glib.Gint;
    Y      : out Glib.Gint;
    Width  : out Glib.Gint;
    Height : out Glib.Gint) return Boolean

Parameters

Self
X
Y
Width
Height

Return Value

Get_Cell_Area

procedure Get_Cell_Area
   (Self   : not null access Gtk_Tree_View_Record;
    Path   : Gtk.Tree_Model.Gtk_Tree_Path;
    Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Rect   : out Gdk.Rectangle.Gdk_Rectangle)

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. Deprecated since 4.10, 1

Parameters

Self
Path: a GtkTreePath for the row, or null to get only horizontal coordinates
Column: a GtkTreeViewColumn for the column, or null to get only vertical coordinates
Rect: rectangle to fill with cell rect

Get_Column

function Get_Column
   (Self : not null access Gtk_Tree_View_Record;
    N    : Glib.Gint) return Gtk.Tree_View_Column.Gtk_Tree_View_Column

Gets the GtkTreeViewColumn at the given position in the tree_view. Deprecated since 4.10, 1

Parameters

Self
N: The position of the column, counting from 0.

Return Value

The GtkTreeViewColumn, or null if the position is outside the range of columns. Has transfer-ownership='none'.

Get_Columns

function Get_Columns
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Tree_View_Column.Column_List.Glist

Returns a GList of all the GtkTreeViewColumns currently in Tree_View. The returned list must be freed with g_list_free (). Deprecated since 4.10, 1

Parameters

Self

Return Value

A list of GtkTreeViewColumns

Get_Cursor

procedure Get_Cursor
   (Self         : not null access Gtk_Tree_View_Record;
    Path         : out Gtk.Tree_Model.Gtk_Tree_Path;
    Focus_Column : out Gtk.Tree_View_Column.Gtk_Tree_View_Column)

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_Model.Path_Free when you are done with it. Deprecated since 4.10, 1

Parameters

Self
Path: A pointer to be filled with the current cursor path. Has transfer-ownership='full'.
Focus_Column: A pointer to be filled with the current focus column

Get_Dest_Row_At_Pos

function Get_Dest_Row_At_Pos
   (Self   : not null access Gtk_Tree_View_Record;
    Drag_X : Glib.Gint;
    Drag_Y : Glib.Gint;
    Path   : access Gtk.Tree_Model.Gtk_Tree_Path := null;
    Pos    : access Gtk_Tree_View_Drop_Position := null) return Boolean

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. Deprecated since 4.10, 1

Parameters

Self
Drag_X: the position to determine the destination row for
Drag_Y: the position to determine the destination row for
Path: Return location for the path of the highlighted row. Has transfer-ownership='full'.
Pos: Return location for the drop position, or null

Return Value

whether there is a row at the given position, True if this is indeed the case.

Get_Drag_Dest_Row

procedure Get_Drag_Dest_Row
   (Self : not null access Gtk_Tree_View_Record;
    Path : out Gtk.Tree_Model.Gtk_Tree_Path;
    Pos  : out Gtk_Tree_View_Drop_Position)

Gets information about the row that is highlighted for feedback. Deprecated since 4.10, 1

Parameters

Self
Path: Return location for the path of the highlighted row. Has transfer-ownership='full'.
Pos: Return location for the drop position

Get_Enable_Search

function Get_Enable_Search
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether or not the tree allows to start interactive searching by typing in text. Deprecated since 4.10, 1

Parameters

Self

Return Value

whether or not to let the user search interactively

Get_Enable_Tree_Lines

function Get_Enable_Tree_Lines
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether or not tree lines are drawn in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if tree lines are drawn in Tree_View, False otherwise.

Get_Expander_Column

function Get_Expander_Column
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Tree_View_Column.Gtk_Tree_View_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. Deprecated since 4.10, 1

Parameters

Self

Return Value

The expander column. Has transfer-ownership='none'.

Get_First_Accessible_Child

function Get_First_Accessible_Child
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Accessible.Gtk_Accessible

Parameters

Self

Return Value

Get_Fixed_Height_Mode

function Get_Fixed_Height_Mode
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether fixed height mode is turned on for Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if Tree_View is in fixed height mode

Get_Grid_Lines

function Get_Grid_Lines
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Enums.Gtk_Tree_View_Grid_Lines

Returns which grid lines are enabled in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

a GtkTreeViewGridLines value indicating which grid lines are enabled.

Get_Hadjustment

function Get_Hadjustment
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Adjustment.Gtk_Adjustment

Parameters

Self

Return Value

Get_Headers_Clickable

function Get_Headers_Clickable
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether all header columns are clickable. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if all header columns are clickable, otherwise False

Get_Headers_Visible

function Get_Headers_Visible
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns True if the headers on the Tree_View are visible. Deprecated since 4.10, 1

Parameters

Self

Return Value

Whether the headers are visible or not.

Get_Hover_Expand

function Get_Hover_Expand
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether hover expansion mode is turned on for Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if Tree_View is in hover expansion mode

Get_Hover_Selection

function Get_Hover_Selection
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether hover selection mode is turned on for Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if Tree_View is in hover selection mode

Get_Hscroll_Policy

function Get_Hscroll_Policy
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Enums.Gtk_Scrollable_Policy

Parameters

Self

Return Value

Get_Level_Indentation

function Get_Level_Indentation
   (Self : not null access Gtk_Tree_View_Record) return Glib.Gint

Returns the amount, in pixels, of extra indentation for child levels in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

the amount of extra indentation for child levels in Tree_View. A return value of 0 means that this feature is disabled.

Get_Model

function Get_Model
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Tree_Model.Gtk_Tree_Model

Returns the model the GtkTreeView is based on. Returns null if the model is unset. Deprecated since 4.10, 1

Parameters

Self

Return Value

A GtkTreeModel

Get_N_Columns

function Get_N_Columns
   (Self : not null access Gtk_Tree_View_Record) return Guint

Queries the number of columns in the given Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

The number of columns in the Tree_View

Get_Next_Accessible_Sibling

function Get_Next_Accessible_Sibling
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Accessible.Gtk_Accessible

Parameters

Self

Return Value

Get_Path_At_Pos

procedure Get_Path_At_Pos
   (Self      : not null access Gtk_Tree_View_Record;
    X         : Glib.Gint;
    Y         : Glib.Gint;
    Path      : out Gtk.Tree_Model.Gtk_Tree_Path;
    Column    : out Gtk.Tree_View_Column.Gtk_Tree_View_Column;
    Cell_X    : out Glib.Gint;
    Cell_Y    : out Glib.Gint;
    Row_Found : out Boolean)

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_Model.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. Deprecated since 4.10, 1

Parameters

Self
X: The x position to be identified (relative to bin_window).
Y: The y position to be identified (relative to bin_window).
Path: A pointer to a GtkTreePath pointer to be filled in. Has transfer-ownership='full'.
Column: A pointer to a GtkTreeViewColumn pointer to be filled in
Cell_X: A pointer where the X coordinate relative to the cell can be placed
Cell_Y: A pointer where the Y coordinate relative to the cell can be placed
Row_Found: True if a row exists at that coordinate.

Get_Platform_State

function Get_Platform_State
   (Self  : not null access Gtk_Tree_View_Record;
    State : Gtk.Accessible.Gtk_Accessible_Platform_State) return Boolean

Parameters

Self
State

Return Value

Get_Reorderable

function Get_Reorderable
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Retrieves whether the user can reorder the tree via drag-and-drop. See Gtk.Tree_View.Set_Reorderable. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if the tree can be reordered.

Get_Row_Separator_Func

procedure Get_Row_Separator_Func
   (Self : not null access Gtk_Tree_View_Record)

Returns the current row separator function. Deprecated since 4.10, 1 @return the current row separator function.

Parameters

Self

Get_Rubber_Banding

function Get_Rubber_Banding
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether rubber banding is turned on for Tree_View. If the selection mode is Gtk.Enums.Selection_Multiple, rubber banding will allow the user to select multiple rows by dragging the mouse. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if rubber banding in Tree_View is enabled.

Get_Search_Column

function Get_Search_Column
   (Self : not null access Gtk_Tree_View_Record) return Glib.Gint

Gets the column searched on by the interactive search code. Deprecated since 4.10, 1

Parameters

Self

Return Value

the column the interactive search code searches in.

Get_Search_Entry

function Get_Search_Entry
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Editable.Gtk_Editable

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. Deprecated since 4.10, 1

Parameters

Self

Return Value

the entry currently in use as search entry.

Get_Search_Equal_Func

procedure Get_Search_Equal_Func
   (Self : not null access Gtk_Tree_View_Record)

Returns the compare function currently in use. Deprecated since 4.10, 1 @return the currently used compare function for the search code.

Parameters

Self

Get_Selection

function Get_Selection
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Tree_Selection.Gtk_Tree_Selection

Gets the GtkTreeSelection associated with Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

A GtkTreeSelection object. Has transfer-ownership='none'.

Get_Show_Expanders

function Get_Show_Expanders
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether or not expanders are drawn in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if expanders are drawn in Tree_View, False otherwise.

Get_Tooltip_Column

function Get_Tooltip_Column
   (Self : not null access Gtk_Tree_View_Record) return Glib.Gint

Returns the column of Tree_View's model which is being used for displaying tooltips on Tree_View's rows. Deprecated since 4.10, 1

Parameters

Self

Return Value

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

Get_Tooltip_Context

procedure Get_Tooltip_Context
   (Self         : not null access Gtk_Tree_View_Record;
    X            : Glib.Gint;
    Y            : Glib.Gint;
    Keyboard_Tip : Boolean;
    Model        : out Gtk.Tree_Model.Gtk_Tree_Model;
    Path         : out Gtk.Tree_Model.Gtk_Tree_Path;
    Iter         : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Success      : out Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
X: the x coordinate (relative to widget coordinates)
Y: the y coordinate (relative to widget coordinates)
Keyboard_Tip: whether this is a keyboard tooltip or not
Model: a pointer to receive a GtkTreeModel
Path: a pointer to receive a GtkTreePath. Has transfer-ownership='full'.
Iter: a pointer to receive a GtkTreeIter
Success: whether or not the given tooltip context points to a row

Get_Type

function Get_Type return Glib.GType

Return Value

Get_Vadjustment

function Get_Vadjustment
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Adjustment.Gtk_Adjustment

Parameters

Self

Return Value

Get_Visible_Range

procedure Get_Visible_Range
   (Self       : not null access Gtk_Tree_View_Record;
    Start_Path : out Gtk.Tree_Model.Gtk_Tree_Path;
    End_Path   : out Gtk.Tree_Model.Gtk_Tree_Path;
    Success    : out Boolean)

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_Model.Path_Free after use. Deprecated since 4.10, 1

Parameters

Self
Start_Path: Return location for start of region. Has transfer-ownership='full'.
End_Path: Return location for end of region. Has transfer-ownership='full'.
Success: True, if valid paths were placed in Start_Path and End_Path.

Get_Visible_Rect

procedure Get_Visible_Rect
   (Self         : not null access Gtk_Tree_View_Record;
    Visible_Rect : out Gdk.Rectangle.Gdk_Rectangle)

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. Deprecated since 4.10, 1

Parameters

Self
Visible_Rect: rectangle to fill

Get_Vscroll_Policy

function Get_Vscroll_Policy
   (Self : not null access Gtk_Tree_View_Record)
    return Gtk.Enums.Gtk_Scrollable_Policy

Parameters

Self

Return Value

Gtk_New

procedure Gtk_New (Self : out Gtk_Tree_View)

Creates a new GtkTreeView widget. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self

Gtk_New

procedure Gtk_New
  (Tree_View : out Gtk_Tree_View;
   Model     : access Gtk.Tree_Model.Gtk_Root_Tree_Model_Record'Class)

A convenience function so that one can directly pass a model, without converting to a Gtk_Tree_Model via the "+" operator.

Parameters

Tree_View
Model

Gtk_New

procedure Gtk_New
   (Self  : out Gtk_Tree_View;
    Model : Gtk.Tree_Model.Gtk_Tree_Model)

Creates a new GtkTreeView widget with the model initialized to Model. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Model: the model.

Gtk_Tree_Cell_Data_Func

type Gtk_Tree_Cell_Data_Func is access procedure
  (Tree_Column : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
   Cell        : not null access Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record'Class;
   Tree_Model  : Gtk.Tree_Model.Gtk_Tree_Model;
   Iter        : Gtk.Tree_Model.Gtk_Tree_Iter);

A function to set the properties of a cell instead of just using the straight mapping between the cell and the model. This function is useful for customizing the cell renderer. For example, a function might get an* integer from the Tree_Model, and render it to the "text" attribute of "cell" by converting it to its written equivalent. See also: gtk_tree_view_column_set_cell_data_func

Parameters

Tree_Column: A GtkTreeViewColumn
Cell: The GtkCellRenderer that is being rendered by Tree_Column
Tree_Model: The GtkTreeModel being rendered
Iter: A GtkTreeIter of the current row rendered

Gtk_Tree_View

type Gtk_Tree_View is access all Gtk_Tree_View_Record'Class;

Gtk_Tree_View_Column_Drop_Func

type Gtk_Tree_View_Column_Drop_Func is access function
  (Tree_View   : not null access Gtk_Tree_View_Record'Class;
   Column      : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
   Prev_Column : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
   Next_Column : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)
return Boolean;

Function type for determining whether Column can be dropped in a particular spot (as determined by Prev_Column and Next_Column). In left to right locales, Prev_Column is on the left of the potential drop spot, and Next_Column is on the right. In right to left mode, this is reversed. This function should return True if the spot is a valid drop spot. Please note that returning True does not actually indicate that the column drop was made, but is meant only to indicate a possible drop spot to the user.

Parameters

Tree_View: A GtkTreeView
Column: The GtkTreeViewColumn being dragged
Prev_Column: A GtkTreeViewColumn on one side of Column
Next_Column: A GtkTreeViewColumn on the other side of Column

Return Value

True, if Column can be dropped in this spot

Gtk_Tree_View_Drop_Position

type Gtk_Tree_View_Drop_Position is (
   Drop_Before,
   Drop_After,
   Drop_Into_Or_Before,
   Drop_Into_Or_After);

An enum for determining where a dropped row goes.

Enumeration Literal

Drop_Before
Drop_After
Drop_Into_Or_Before
Drop_Into_Or_After

Gtk_Tree_View_Drop_Position_Properties

package Gtk_Tree_View_Drop_Position_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Tree_View_Drop_Position);

Gtk_Tree_View_Mapping_Func

type Gtk_Tree_View_Mapping_Func is access procedure
  (Tree_View : not null access Gtk_Tree_View_Record'Class;
   Path      : Gtk.Tree_Model.Gtk_Tree_Path);

Function used for Gtk.Tree_View.Map_Expanded_Rows.

Parameters

Tree_View: A GtkTreeView
Path: The path that's expanded

Gtk_Tree_View_New

function Gtk_Tree_View_New return Gtk_Tree_View

Creates a new GtkTreeView widget.

Return Value

Gtk_Tree_View_New_With_Model

function Gtk_Tree_View_New_With_Model
   (Model : Gtk.Tree_Model.Gtk_Tree_Model) return Gtk_Tree_View

Creates a new GtkTreeView widget with the model initialized to Model.

Parameters

Model: the model.

Return Value

Gtk_Tree_View_Record

type Gtk_Tree_View_Record is new Gtk_Widget_Record with null record;

Gtk_Tree_View_Row_Separator_Func

type Gtk_Tree_View_Row_Separator_Func is access function
  (Model : Gtk.Tree_Model.Gtk_Tree_Model;
   Iter  : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean;

Function type for determining whether the row pointed to by Iter should be rendered as a separator. A common way to implement this is to have a boolean column in the model, whose values the GtkTreeViewRowSeparatorFunc returns.

Parameters

Model: the GtkTreeModel
Iter: a GtkTreeIter pointing at a row in Model

Return Value

True if the row is a separator

Gtk_Tree_View_Search_Equal_Func

type Gtk_Tree_View_Search_Equal_Func is access function
  (Model  : Gtk.Tree_Model.Gtk_Tree_Model;
   Column : Glib.Gint;
   Key    : UTF8_String;
   Iter   : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean;

A function used for checking whether a row in Model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp returning 0 for equal strings.

Parameters

Model: the GtkTreeModel being searched
Column: the search column set by Gtk.Tree_View.Set_Search_Column
Key: the key string to compare with
Iter: a GtkTreeIter pointing the row of Model that should be compared with Key.

Return Value

False if the row matches, True otherwise.

Headers_Clickable_Property

Headers_Clickable_Property : constant Glib.Properties.Property_Boolean;

Headers_Visible_Property

Headers_Visible_Property : constant Glib.Properties.Property_Boolean;

Hover_Expand_Property

Hover_Expand_Property : constant Glib.Properties.Property_Boolean;

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.

Hover_Selection_Property

Hover_Selection_Property : constant Glib.Properties.Property_Boolean;

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.Enums.Selection_Single and Gtk.Enums.Selection_Browse.

This mode is primarily intended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.

Implements_Gtk_Accessible

package Implements_Gtk_Accessible is new Glib.Types.Implements
  (Gtk.Accessible.Gtk_Accessible, Gtk_Tree_View_Record, Gtk_Tree_View);

Implements_Gtk_Buildable

package Implements_Gtk_Buildable is new Glib.Types.Implements
  (Gtk.Buildable.Gtk_Buildable, Gtk_Tree_View_Record, Gtk_Tree_View);

Implements_Gtk_Constraint_Target

package Implements_Gtk_Constraint_Target is new Glib.Types.Implements
  (Gtk.Constraint_Target.Gtk_Constraint_Target, Gtk_Tree_View_Record, Gtk_Tree_View);

Implements_Gtk_Scrollable

package Implements_Gtk_Scrollable is new Glib.Types.Implements
  (Gtk.Scrollable.Gtk_Scrollable, Gtk_Tree_View_Record, Gtk_Tree_View);

Initialize

procedure Initialize (Self : not null access Gtk_Tree_View_Record'Class)

Creates a new GtkTreeView widget. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self

Initialize

procedure Initialize
   (Self  : not null access Gtk_Tree_View_Record'Class;
    Model : Gtk.Tree_Model.Gtk_Tree_Model)

Creates a new GtkTreeView widget with the model initialized to Model. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self
Model: the model.

Insert_Column

function Insert_Column
   (Self     : not null access Gtk_Tree_View_Record;
    Column   : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Position : Glib.Gint := -1) return Glib.Gint

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. Deprecated since 4.10, 1

Parameters

Self
Column: The GtkTreeViewColumn to be inserted.
Position: The position to insert Column in.

Return Value

The number of columns in Tree_View after insertion.

Insert_Column_With_Data_Func

function Insert_Column_With_Data_Func
   (Self     : not null access Gtk_Tree_View_Record;
    Position : Glib.Gint;
    Title    : UTF8_String;
    Cell     : not null access Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record'Class;
    Func     : Gtk_Tree_Cell_Data_Func;
    Dnotify  : Glib.G_Destroy_Notify_Address) return Glib.Gint

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. Deprecated since 4.10, 1

Parameters

Self
Position: Position to insert, -1 for append
Title: column title
Cell: cell renderer for column
Func: function to set attributes of cell renderer
Dnotify: destroy notifier for Data

Return Value

number of columns in the tree view post-insert

Is_Blank_At_Pos

function Is_Blank_At_Pos
   (Self   : not null access Gtk_Tree_View_Record;
    X      : Glib.Gint;
    Y      : Glib.Gint;
    Path   : access Gtk.Tree_Model.Gtk_Tree_Path := null;
    Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column := null;
    Cell_X : access Glib.Gint := null;
    Cell_Y : access Glib.Gint := null) return Boolean

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. Deprecated since 4.10, 1

Parameters

Self
X: The x position to be identified (relative to bin_window)
Y: The y position to be identified (relative to bin_window)
Path: A pointer to a GtkTreePath pointer to be filled in. Has transfer-ownership='full'.
Column: A pointer to a GtkTreeViewColumn pointer to be filled in
Cell_X: A pointer where the X coordinate relative to the cell can be placed
Cell_Y: A pointer where the Y coordinate relative to the cell can be placed

Return Value

True if the area at the given coordinates is blank, False otherwise.

Is_Rubber_Banding_Active

function Is_Rubber_Banding_Active
   (Self : not null access Gtk_Tree_View_Record) return Boolean

Returns whether a rubber banding operation is currently being done in Tree_View. Deprecated since 4.10, 1

Parameters

Self

Return Value

True if a rubber banding operation is currently being done in Tree_View.

Level_Indentation_Property

Level_Indentation_Property : constant Glib.Properties.Property_Int;

Extra indentation for each level.

Map_Expanded_Rows

procedure Map_Expanded_Rows
   (Self : not null access Gtk_Tree_View_Record;
    Func : Gtk_Tree_View_Mapping_Func)

Calls Func on all expanded rows. Deprecated since 4.10, 1

Parameters

Self
Func: A function to be called

Model_Property

Model_Property : constant Glib.Properties.Property_Interface;

Type: Gtk.Tree_Model.Gtk_Tree_Model

Move_Column_After

procedure Move_Column_After
   (Self        : not null access Gtk_Tree_View_Record;
    Column      : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Base_Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)

Moves Column to be after to Base_Column. If Base_Column is null, then Column is placed in the first position. Deprecated since 4.10, 1

Parameters

Self
Column: The GtkTreeViewColumn to be moved.
Base_Column: The GtkTreeViewColumn to be moved relative to

On_Columns_Changed

procedure On_Columns_Changed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The number of columns of the treeview has changed.

Parameters

Self
Call
Slot
After

On_Columns_Changed

procedure On_Columns_Changed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Void;
    After : Boolean := False)

The number of columns of the treeview has changed.

Parameters

Self
Call
After

On_Cursor_Changed

procedure On_Cursor_Changed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

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

Parameters

Self
Call
Slot
After

On_Cursor_Changed

procedure On_Cursor_Changed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Void;
    After : Boolean := False)

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

Parameters

Self
Call
After

On_Expand_Collapse_Cursor_Row

procedure On_Expand_Collapse_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean_Boolean_Boolean_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Callback parameters:

Parameters

Self
Call
Slot
After

On_Expand_Collapse_Cursor_Row

procedure On_Expand_Collapse_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean_Boolean_Boolean_Boolean;
    After : Boolean := False)

Callback parameters:

Parameters

Self
Call
After

On_Move_Cursor

procedure On_Move_Cursor
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The GtkTreeView::move-cursor signal is a [keybinding signal][classGtk.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.

Callback parameters: -- @param Step the granularity of the move, as a GtkMovementStep. -- Gtk.Enums.Movement_Logical_Positions, -- Gtk.Enums.Movement_Visual_Positions, Gtk.Enums.Movement_Display_Lines, -- Gtk.Enums.Movement_Pages and Gtk.Enums.Movement_Buffer_Ends are -- supported. Gtk.Enums.Movement_Logical_Positions and -- Gtk.Enums.Movement_Visual_Positions are treated identically. -- @param Direction the direction to move: +1 to move forwards; -1 to move -- backwards. The resulting movement is undefined for all other values. -- @param Extend whether to extend the selection -- @param Modify whether to modify the selection

Parameters

Self
Call
Slot
After

On_Move_Cursor

procedure On_Move_Cursor
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Movement_Step_Gint_Boolean_Boolean_Boolean;
    After : Boolean := False)

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

Parameters

Self
Call
After

On_Row_Activated

procedure On_Row_Activated
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The "row-activated" signal is emitted when the method [methodGtk.TreeView.row_activated] is called.

This signal is emitted when the user double-clicks a treeview row with the [propertyGtk.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: <kbd>Space</kbd>, <kbd>Shift</kbd>+<kbd>Space</kbd>, <kbd>Return</kbd> or <kbd>Enter</kbd> is pressed.

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

Callback parameters: -- @param Path the GtkTreePath for the activated row -- @param Column the GtkTreeViewColumn in which the activation occurred

Parameters

Self
Call
Slot
After

On_Row_Activated

procedure On_Row_Activated
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Tree_Path_Gtk_Tree_View_Column_Or_Null_Void;
    After : Boolean := False)

The "row-activated" signal is emitted when the method [methodGtk.TreeView.row_activated] is called.

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

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

Callback parameters: -- @param Path the GtkTreePath for the activated row -- @param Column the GtkTreeViewColumn in which the activation occurred

Parameters

Self
Call
After

On_Row_Collapsed

procedure On_Row_Collapsed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

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

Callback parameters: -- @param Iter the tree iter of the collapsed row -- @param Path a tree path that points to the row

Parameters

Self
Call
Slot
After

On_Row_Collapsed

procedure On_Row_Collapsed
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Void;
    After : Boolean := False)

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

Callback parameters: -- @param Iter the tree iter of the collapsed row -- @param Path a tree path that points to the row

Parameters

Self
Call
After

On_Row_Expanded

procedure On_Row_Expanded
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

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

Callback parameters: -- @param Iter the tree iter of the expanded row -- @param Path a tree path that points to the row

Parameters

Self
Call
Slot
After

On_Row_Expanded

procedure On_Row_Expanded
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Void;
    After : Boolean := False)

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

Callback parameters: -- @param Iter the tree iter of the expanded row -- @param Path a tree path that points to the row

Parameters

Self
Call
After

On_Select_All

procedure On_Select_All
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Select_All

procedure On_Select_All
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

On_Select_Cursor_Parent

procedure On_Select_Cursor_Parent
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Select_Cursor_Parent

procedure On_Select_Cursor_Parent
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

On_Select_Cursor_Row

procedure On_Select_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Select_Cursor_Row

procedure On_Select_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

On_Start_Interactive_Search

procedure On_Start_Interactive_Search
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Start_Interactive_Search

procedure On_Start_Interactive_Search
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

On_Test_Collapse_Row

procedure On_Test_Collapse_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

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.

Callback parameters: -- @param Iter the tree iter of the row to collapse -- @param Path a tree path that points to the row

Parameters

Self
Call
Slot
After

On_Test_Collapse_Row

procedure On_Test_Collapse_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean;
    After : Boolean := False)

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.

Callback parameters: -- @param Iter the tree iter of the row to collapse -- @param Path a tree path that points to the row

Parameters

Self
Call
After

On_Test_Expand_Row

procedure On_Test_Expand_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

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.

Callback parameters: -- @param Iter the tree iter of the row to expand -- @param Path a tree path that points to the row

Parameters

Self
Call
Slot
After

On_Test_Expand_Row

procedure On_Test_Expand_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Gtk_Tree_Iter_Gtk_Tree_Path_Boolean;
    After : Boolean := False)

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.

Callback parameters: -- @param Iter the tree iter of the row to expand -- @param Path a tree path that points to the row

Parameters

Self
Call
After

On_Toggle_Cursor_Row

procedure On_Toggle_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Toggle_Cursor_Row

procedure On_Toggle_Cursor_Row
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

On_Unselect_All

procedure On_Unselect_All
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Parameters

Self
Call
Slot
After

On_Unselect_All

procedure On_Unselect_All
   (Self  : not null access Gtk_Tree_View_Record;
    Call  : Cb_Gtk_Tree_View_Boolean;
    After : Boolean := False)

Parameters

Self
Call
After

Property_Gtk_Tree_View_Drop_Position

type Property_Gtk_Tree_View_Drop_Position is new Gtk_Tree_View_Drop_Position_Properties.Property;

Remove_Column

function Remove_Column
   (Self   : not null access Gtk_Tree_View_Record;
    Column : not null access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)
    return Glib.Gint

Removes Column from Tree_View. Deprecated since 4.10, 1

Parameters

Self
Column: The GtkTreeViewColumn to remove.

Return Value

The number of columns in Tree_View after removing.

Reorderable_Property

Reorderable_Property : constant Glib.Properties.Property_Boolean;

Reset_Property

procedure Reset_Property
   (Self     : not null access Gtk_Tree_View_Record;
    Property : Gtk.Accessible.Gtk_Accessible_Property)

Parameters

Self
Property

Reset_Relation

procedure Reset_Relation
   (Self     : not null access Gtk_Tree_View_Record;
    Relation : Gtk.Accessible.Gtk_Accessible_Relation)

Parameters

Self
Relation

Reset_State

procedure Reset_State
   (Self  : not null access Gtk_Tree_View_Record;
    State : Gtk.Accessible.Gtk_Accessible_State)

Parameters

Self
State

Row_Activated

procedure Row_Activated
   (Self   : not null access Gtk_Tree_View_Record;
    Path   : Gtk.Tree_Model.Gtk_Tree_Path;
    Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)

Activates the cell determined by Path and Column. Deprecated since 4.10, 1

Parameters

Self
Path: The GtkTreePath to be activated.
Column: The GtkTreeViewColumn to be activated.

Row_Expanded

function Row_Expanded
   (Self : not null access Gtk_Tree_View_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean

Returns True if the node pointed to by Path is expanded in Tree_View. Deprecated since 4.10, 1

Parameters

Self
Path: A GtkTreePath to test expansion state.

Return Value

True if path is expanded.

Rubber_Banding_Property

Rubber_Banding_Property : constant Glib.Properties.Property_Boolean;

Scroll_To_Cell

procedure Scroll_To_Cell
   (Self      : not null access Gtk_Tree_View_Record;
    Path      : Gtk.Tree_Model.Gtk_Tree_Path;
    Column    : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Use_Align : Boolean;
    Row_Align : Interfaces.C.C_float;
    Col_Align : Interfaces.C.C_float)

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. Deprecated since 4.10, 1

Parameters

Self
Path: The path of the row to move to
Column: The GtkTreeViewColumn to move horizontally to
Use_Align: whether to use alignment arguments, or False.
Row_Align: The vertical alignment of the row specified by Path.
Col_Align: The horizontal alignment of the column specified by Column.

Scroll_To_Point

procedure Scroll_To_Point
   (Self   : not null access Gtk_Tree_View_Record;
    Tree_X : Glib.Gint;
    Tree_Y : Glib.Gint)

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. Deprecated since 4.10, 1

Parameters

Self
Tree_X: X coordinate of new top-left pixel of visible area, or -1
Tree_Y: Y coordinate of new top-left pixel of visible area, or -1

Search_Column_Property

Search_Column_Property : constant Glib.Properties.Property_Int;

Set_Accessible_Parent

procedure Set_Accessible_Parent
   (Self         : not null access Gtk_Tree_View_Record;
    Parent       : Gtk.Accessible.Gtk_Accessible;
    Next_Sibling : Gtk.Accessible.Gtk_Accessible)

Parameters

Self
Parent
Next_Sibling

Set_Activate_On_Single_Click

procedure Set_Activate_On_Single_Click
   (Self   : not null access Gtk_Tree_View_Record;
    Single : Boolean)

Cause the GtkTreeView::row-activated signal to be emitted on a single click instead of a double click. Deprecated since 4.10, 1

Parameters

Self
Single: True to emit row-activated on a single click

Set_Column_Drag_Function

procedure Set_Column_Drag_Function
   (Self : not null access Gtk_Tree_View_Record;
    Func : Gtk_Tree_View_Column_Drop_Func)

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. Deprecated since 4.10, 1

Parameters

Self
Func: A function to determine which columns are reorderable

Set_Cursor

procedure Set_Cursor
   (Self          : not null access Gtk_Tree_View_Record;
    Path          : Gtk.Tree_Model.Gtk_Tree_Path;
    Focus_Column  : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Start_Editing : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Path: A GtkTreePath
Focus_Column: A GtkTreeViewColumn
Start_Editing: True if the specified cell should start being edited.

Set_Cursor_On_Cell

procedure Set_Cursor_On_Cell
   (Self          : not null access Gtk_Tree_View_Record;
    Path          : Gtk.Tree_Model.Gtk_Tree_Path;
    Focus_Column  : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Focus_Cell    : access Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record'Class;
    Start_Editing : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Path: A GtkTreePath
Focus_Column: A GtkTreeViewColumn
Focus_Cell: A GtkCellRenderer
Start_Editing: True if the specified cell should start being edited.

Set_Drag_Dest_Row

procedure Set_Drag_Dest_Row
   (Self : not null access Gtk_Tree_View_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path;
    Pos  : Gtk_Tree_View_Drop_Position)

Sets the row that is highlighted for feedback. If Path is null, an existing highlight is removed. Deprecated since 4.10, 1

Parameters

Self
Path: The path of the row to highlight
Pos: Specifies whether to drop before, after or into the row

Set_Enable_Search

procedure Set_Enable_Search
   (Self          : not null access Gtk_Tree_View_Record;
    Enable_Search : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Enable_Search: True, if the user can search interactively

Set_Enable_Tree_Lines

procedure Set_Enable_Tree_Lines
   (Self    : not null access Gtk_Tree_View_Record;
    Enabled : Boolean)

Sets whether to draw lines interconnecting the expanders in Tree_View. This does not have any visible effects for lists. Deprecated since 4.10, 1

Parameters

Self
Enabled: True to enable tree line drawing, False otherwise.

Set_Expander_Column

procedure Set_Expander_Column
   (Self   : not null access Gtk_Tree_View_Record;
    Column : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class)

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. Deprecated since 4.10, 1

Parameters

Self
Column: null, or the column to draw the expander arrow at.

Set_Fixed_Height_Mode

procedure Set_Fixed_Height_Mode
   (Self   : not null access Gtk_Tree_View_Record;
    Enable : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Enable: True to enable fixed height mode

Set_Grid_Lines

procedure Set_Grid_Lines
   (Self       : not null access Gtk_Tree_View_Record;
    Grid_Lines : Gtk.Enums.Gtk_Tree_View_Grid_Lines)

Sets which grid lines to draw in Tree_View. Deprecated since 4.10, 1

Parameters

Self
Grid_Lines: a GtkTreeViewGridLines value indicating which grid lines to enable.

Set_Hadjustment

procedure Set_Hadjustment
   (Self        : not null access Gtk_Tree_View_Record;
    Hadjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Parameters

Self
Hadjustment

Set_Headers_Clickable

procedure Set_Headers_Clickable
   (Self    : not null access Gtk_Tree_View_Record;
    Setting : Boolean)

Allow the column title buttons to be clicked. Deprecated since 4.10, 1

Parameters

Self
Setting: True if the columns are clickable.

Set_Headers_Visible

procedure Set_Headers_Visible
   (Self            : not null access Gtk_Tree_View_Record;
    Headers_Visible : Boolean)

Sets the visibility state of the headers. Deprecated since 4.10, 1

Parameters

Self
Headers_Visible: True if the headers are visible

Set_Hover_Expand

procedure Set_Hover_Expand
   (Self   : not null access Gtk_Tree_View_Record;
    Expand : Boolean)

Enables or disables the hover expansion mode of Tree_View. Hover expansion makes rows expand or collapse if the pointer moves over them. Deprecated since 4.10, 1

Parameters

Self
Expand: True to enable hover selection mode

Set_Hover_Selection

procedure Set_Hover_Selection
   (Self  : not null access Gtk_Tree_View_Record;
    Hover : Boolean)

Parameters

Self
Hover: True to enable hover selection mode

Set_Hscroll_Policy

procedure Set_Hscroll_Policy
   (Self   : not null access Gtk_Tree_View_Record;
    Policy : Gtk.Enums.Gtk_Scrollable_Policy)

Parameters

Self
Policy

Set_Level_Indentation

procedure Set_Level_Indentation
   (Self        : not null access Gtk_Tree_View_Record;
    Indentation : Glib.Gint)

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. Deprecated since 4.10, 1

Parameters

Self
Indentation: the amount, in pixels, of extra indentation in Tree_View.

Set_Model

procedure Set_Model
   (Self  : not null access Gtk_Tree_View_Record;
    Model : Gtk.Tree_Model.Gtk_Tree_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. Deprecated since 4.10, 1

Parameters

Self
Model: The model.

Set_Reorderable

procedure Set_Reorderable
   (Self        : not null access Gtk_Tree_View_Record;
    Reorderable : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Reorderable: True, if the tree can be reordered.

Set_Row_Separator_Func

procedure Set_Row_Separator_Func
   (Self : not null access Gtk_Tree_View_Record;
    Func : Gtk_Tree_View_Row_Separator_Func)

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. Deprecated since 4.10, 1

Parameters

Self
Func: a GtkTreeViewRowSeparatorFunc

Set_Rubber_Banding

procedure Set_Rubber_Banding
   (Self   : not null access Gtk_Tree_View_Record;
    Enable : Boolean)

Enables or disables rubber banding in Tree_View. If the selection mode is Gtk.Enums.Selection_Multiple, rubber banding will allow the user to select multiple rows by dragging the mouse. Deprecated since 4.10, 1

Parameters

Self
Enable: True to enable rubber banding

Set_Search_Column

procedure Set_Search_Column
   (Self   : not null access Gtk_Tree_View_Record;
    Column : Glib.Gint)

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. Deprecated since 4.10, 1

Parameters

Self
Column: the column of the model to search in, or -1 to disable searching

Set_Search_Entry

procedure Set_Search_Entry
   (Self   : not null access Gtk_Tree_View_Record;
    GEntry : Gtk.Editable.Gtk_Editable)

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. Deprecated since 4.10, 1

Parameters

Self
GEntry: the entry the interactive search code of Tree_View should use

Set_Search_Equal_Func

procedure Set_Search_Equal_Func
   (Self              : not null access Gtk_Tree_View_Record;
    Search_Equal_Func : Gtk_Tree_View_Search_Equal_Func;
    Search_Destroy    : Glib.G_Destroy_Notify_Address)

Sets the compare function for the interactive search capabilities; note that somewhat like strcmp returning 0 for equality GtkTreeViewSearchEqualFunc returns False on matches. Deprecated since 4.10, 1

Parameters

Self
Search_Equal_Func: the compare function to use during the search
Search_Destroy: Destroy notifier for Search_User_Data

Set_Show_Expanders

procedure Set_Show_Expanders
   (Self    : not null access Gtk_Tree_View_Record;
    Enabled : Boolean)

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. Deprecated since 4.10, 1

Parameters

Self
Enabled: True to enable expander drawing, False otherwise.

Set_Tooltip_Cell

procedure Set_Tooltip_Cell
   (Self    : not null access Gtk_Tree_View_Record;
    Tooltip : not null access Gtk.Tooltip.Gtk_Tooltip_Record'Class;
    Path    : Gtk.Tree_Model.Gtk_Tree_Path;
    Column  : access Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record'Class;
    Cell    : access Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record'Class)

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. Deprecated since 4.10, 1

Parameters

Self
Tooltip: a GtkTooltip
Path: a GtkTreePath
Column: a GtkTreeViewColumn
Cell: a GtkCellRenderer

Set_Tooltip_Column

procedure Set_Tooltip_Column
   (Self   : not null access Gtk_Tree_View_Record;
    Column : Glib.Gint)

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. Deprecated since 4.10, 1

Parameters

Self
Column: an integer, which is a valid column number for Tree_View's model

Set_Tooltip_Row

procedure Set_Tooltip_Row
   (Self    : not null access Gtk_Tree_View_Record;
    Tooltip : not null access Gtk.Tooltip.Gtk_Tooltip_Record'Class;
    Path    : Gtk.Tree_Model.Gtk_Tree_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. Deprecated since 4.10, 1

Parameters

Self
Tooltip: a GtkTooltip
Path: a GtkTreePath

Set_Vadjustment

procedure Set_Vadjustment
   (Self        : not null access Gtk_Tree_View_Record;
    Vadjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Parameters

Self
Vadjustment

Set_Vscroll_Policy

procedure Set_Vscroll_Policy
   (Self   : not null access Gtk_Tree_View_Record;
    Policy : Gtk.Enums.Gtk_Scrollable_Policy)

Parameters

Self
Policy

Show_Expanders_Property

Show_Expanders_Property : constant Glib.Properties.Property_Boolean;

True if the view has expanders.

Signal_Columns_Changed

Signal_Columns_Changed : constant Glib.Signal_Name := "columns-changed";

The number of columns of the treeview has changed.

Signal_Cursor_Changed

Signal_Cursor_Changed : constant Glib.Signal_Name := "cursor-changed";

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

Signal_Expand_Collapse_Cursor_Row

Signal_Expand_Collapse_Cursor_Row : constant Glib.Signal_Name := "expand-collapse-cursor-row";

Callback parameters:

Signal_Move_Cursor

Signal_Move_Cursor : constant Glib.Signal_Name := "move-cursor";

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

Signal_Row_Activated

Signal_Row_Activated : constant Glib.Signal_Name := "row-activated";

The "row-activated" signal is emitted when the method [methodGtk.TreeView.row_activated] is called.

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

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

Callback parameters: -- @param Path the GtkTreePath for the activated row -- @param Column the GtkTreeViewColumn in which the activation occurred

Signal_Row_Collapsed

Signal_Row_Collapsed : constant Glib.Signal_Name := "row-collapsed";

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

Callback parameters: -- @param Iter the tree iter of the collapsed row -- @param Path a tree path that points to the row

Signal_Row_Expanded

Signal_Row_Expanded : constant Glib.Signal_Name := "row-expanded";

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

Callback parameters: -- @param Iter the tree iter of the expanded row -- @param Path a tree path that points to the row

Signal_Select_All

Signal_Select_All : constant Glib.Signal_Name := "select-all";

Signal_Select_Cursor_Parent

Signal_Select_Cursor_Parent : constant Glib.Signal_Name := "select-cursor-parent";

Signal_Select_Cursor_Row

Signal_Select_Cursor_Row : constant Glib.Signal_Name := "select-cursor-row";

Signal_Start_Interactive_Search

Signal_Start_Interactive_Search : constant Glib.Signal_Name := "start-interactive-search";

Signal_Test_Collapse_Row

Signal_Test_Collapse_Row : constant Glib.Signal_Name := "test-collapse-row";

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.

Callback parameters: -- @param Iter the tree iter of the row to collapse -- @param Path a tree path that points to the row

Signal_Test_Expand_Row

Signal_Test_Expand_Row : constant Glib.Signal_Name := "test-expand-row";

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.

Callback parameters: -- @param Iter the tree iter of the row to expand -- @param Path a tree path that points to the row

Signal_Toggle_Cursor_Row

Signal_Toggle_Cursor_Row : constant Glib.Signal_Name := "toggle-cursor-row";

Signal_Unselect_All

Signal_Unselect_All : constant Glib.Signal_Name := "unselect-all";

Tooltip_Column_Property

Tooltip_Column_Property : constant Glib.Properties.Property_Int;

Unset_Rows_Drag_Dest

procedure Unset_Rows_Drag_Dest
   (Self : not null access Gtk_Tree_View_Record)

Undoes the effect of Gtk.Tree_View.Enable_Model_Drag_Dest. Calling this method sets GtkTreeView:reorderable to False. Deprecated since 4.10, 1

Parameters

Self

Unset_Rows_Drag_Source

procedure Unset_Rows_Drag_Source
   (Self : not null access Gtk_Tree_View_Record)

Undoes the effect of Gtk.Tree_View.Enable_Model_Drag_Source. Calling this method sets GtkTreeView:reorderable to False. Deprecated since 4.10, 1

Parameters

Self

Update_Next_Accessible_Sibling

procedure Update_Next_Accessible_Sibling
   (Self        : not null access Gtk_Tree_View_Record;
    New_Sibling : Gtk.Accessible.Gtk_Accessible)

Parameters

Self
New_Sibling

Update_Platform_State

procedure Update_Platform_State
   (Self  : not null access Gtk_Tree_View_Record;
    State : Gtk.Accessible.Gtk_Accessible_Platform_State)

Parameters

Self
State