TreeViewColumn
A visible column in a class@Gtk.TreeView widget
The GtkTreeViewColumn object represents a visible column in a GtkTreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.
Please refer to the section-tree-widget.html for an overview of all the objects and data types related to the tree widget and how they work together, and to the class@Gtk.TreeView documentation for specifics about the CSS node structure for treeviews and their headers.
Skipped during bindings generation
parameter
x_offset: x_offset: Out parameter is not supportedparameter
x_offset: x_offset: Out parameter is not supportedmethod
cell-area: Property has no getter nor setter
Constructors
Properties
Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable.
Functions
Adds an attribute mapping to the list in @tree_column.
Returns true if any of the cells packed into the @tree_column are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data()
Sets the cell renderer based on the @tree_model and @iter. That is, for every attribute mapping in @tree_column, it will get a value from the set column on the @iter, and use that value to set the attribute on the cell renderer. This is used primarily by the GtkTreeView.
Clears all existing attributes previously set with gtk_tree_view_column_set_attributes().
Emitted when the column's header has been clicked.
Sets the current keyboard focus to be at @cell, if the column contains 2 or more editable and activatable cells.
Returns the current x alignment of @tree_column. This value can range between 0.0 and 1.0.
Gets the ID of the @buildable object.
Returns true if the user can click on the header for the column.
Gets the fixed width of the column. This may not be the actual displayed width of the column; for that, use gtk_tree_view_column_get_width().
Returns the maximum width in pixels of the @tree_column, or -1 if no maximum width is set.
Returns the minimum width in pixels of the @tree_column, or -1 if no minimum width is set.
Returns true if the @tree_column can be reordered by the user.
Returns true if the @tree_column can be resized by the end user.
Returns the current type of @tree_column.
Gets the logical @sort_column_id that the model sorts on when this column is selected for sorting.
Gets the value set by gtk_tree_view_column_set_sort_indicator().
Gets the value set by gtk_tree_view_column_set_sort_order().
Returns the spacing of @tree_column.
Returns the GtkTreeView wherein @tree_column has been inserted. If @column is currently not inserted in any tree view, null is returned.
Returns true if @tree_column is visible.
Returns the current X offset of @tree_column in pixels.
Adds the @cell to end of the column. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true.
Packs the @cell into the beginning of the column. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true.
Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.
Re-inserts @cell at @position.
Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right.
Sets the GtkCellLayoutDataFunc to use for @cell_layout.
Sets the GtkTreeCellDataFunc to use for the column.
Sets the header to be active if @clickable is true. When the header is active, then it can take keyboard focus, and can be clicked.
If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise unsets it. The effective value of @fixed_width is clamped between the minimum and maximum width of the column; however, the value stored in the “fixed-width” property is not clamped. If the column sizing is %GTK_TREE_VIEW_COLUMN_GROW_ONLY or %GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting a fixed width overrides the automatically calculated width. Note that
Sets the maximum width of the @tree_column. If @max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it’s the last column in a view. In this case, the column expands to fill any extra space.
Sets the minimum width of the @tree_column. If @min_width is -1, then the minimum width is unset.
If @reorderable is true, then the column can be reordered by the end user dragging the header.
If @resizable is true, then the user can explicitly resize the column by grabbing the outer edge of the column button.
Sets the growth behavior of @tree_column to @type.
Sets the logical @sort_column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.
Call this function with a @setting of true to display an arrow in the header button indicating the column is sorted. Call gtk_tree_view_column_set_sort_order() to change the direction of the arrow.
Changes the appearance of the sort indicator.
Sets the spacing field of @tree_column, which is the number of pixels to place between cell renderers packed into it.
Sets the visibility of @tree_column.