Gtk.ColumnView – gtk4 Reference Manual

ColumnView

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_column_view_get_type ()" ) ]
public class ColumnView : Widget, Accessible, Buildable, ConstraintTarget, Scrollable

`GtkColumnView` presents a large dynamic list of items using multiple columns with headers.

`GtkColumnView` uses the factories of its columns to generate a cell widget for each column, for each visible item and displays them together as the row for this item.

The [[email protected]:show-row-separators] and [[email protected]:show-column-separators] properties offer a simple way to display separators between the rows or columns.

`GtkColumnView` allows the user to select items according to the selection characteristics of the model. For models that allow multiple selected items, it is possible to turn on *rubberband selection*, using [[email protected]:enable-rubberband].

The column view supports sorting that can be customized by the user by clicking on column headers. To set this up, the `GtkSorter` returned by [[email protected]_sorter] must be attached to a sort model for the data that the view is showing, and the columns must have sorters attached to them by calling [[email protected]_sorter]. The initial sort order can be set with [ [email protected]_by_column].

The column view also supports interactive resizing and reordering of columns, via Drag-and-Drop of the column headers. This can be enabled or disabled with the [[email protected]:reorderable] and [[email protected]:resizable] properties.

To learn more about the list widget framework, see the [overview](section-list-widget.html).

CSS nodes

``` columnview.column-separators.navigation-sidebar ├── header │ ├── <column header> ┊ ┊ │ ╰── <column header> │ ├── listview │ ┊ ╰── [rubberband] ```

`GtkColumnView` uses a single CSS node named columnview. It may carry the .column-separators style class, when [ [email protected]:show-column-separators] property is set. Header widgets appear below a node with name header. The rows are contained in a `GtkListView` widget, so there is a listview node with the same structure as for a standalone `GtkListView` widget. If [ [email protected]:show-row-separators] is set, it will be passed on to the list view, causing its CSS node to carry the .separators style class. For rubberband selection, a node with name rubberband is used.

The main columnview node may also carry style classes to select the style of [list presentation](section-list-widget.html#list-styles): .rich-list, .navigation-sidebar or .data-table.

Accessibility

`GtkColumnView` uses the gtk_accessible_role_tree_grid role, header title widgets are using the gtk_accessible_role_column_header role. The row widgets are using the gtk_accessible_role_row role, and individual cells are using the gtk_accessible_role_grid_cell role

Namespace: Gtk

Package: gtk4

Content:

Properties:

public ListModel columns { get; }
The list of columns.
public bool enable_rubberband { get; set; }
Allow rubberband selection.
public SelectionModel model { get; set; }
Model for the items displayed.
public bool reorderable { get; set; }
Whether columns are reorderable.
public bool show_column_separators { get; set; }
Show separators between columns.
public bool show_row_separators { get; set; }
Show separators between rows.
public bool single_click_activate { get; set; }
Activate rows on single click and select them on hover.
public Sorter sorter { get; }
Sorter with the sorting choices of the user.

Creation methods:

public ColumnView (owned SelectionModel? model)
Creates a new `GtkColumnView`.

Methods:

public void append_column (ColumnViewColumn column)
Appends the column to the end of the columns in this.
public unowned ListModel get_columns ()
Gets the list of columns in this column view.
public bool get_enable_rubberband ()
Returns whether rows can be selected by dragging with the mouse.
public unowned SelectionModel? get_model ()
Gets the model that's currently used to read the items displayed.
public bool get_reorderable ()
Returns whether columns are reorderable.
public bool get_show_column_separators ()
Returns whether the list should show separators between columns.
public bool get_show_row_separators ()
Returns whether the list should show separators between rows.
public bool get_single_click_activate ()
Returns whether rows will be activated on single click and selected on hover.
public unowned Sorter? get_sorter ()
Returns a special sorter that reflects the users sorting choices in the column view.
public void insert_column (uint position, ColumnViewColumn column)
Inserts a column at the given position in the columns of this.
public void remove_column (ColumnViewColumn column)
Removes the column from the list of columns of this.
public void set_enable_rubberband (bool enable_rubberband)
Sets whether selections can be changed by dragging with the mouse.
public void set_model (SelectionModel? model)
Sets the model to use.
public void set_reorderable (bool reorderable)
Sets whether columns should be reorderable by dragging.
public void set_show_column_separators (bool show_column_separators)
Sets whether the list should show separators between columns.
public void set_show_row_separators (bool show_row_separators)
Sets whether the list should show separators between rows.
public void set_single_click_activate (bool single_click_activate)
Sets whether rows should be activated on single click and selected on hover.
public void sort_by_column (ColumnViewColumn? column, SortType direction)
Sets the sorting of the view.

Signals:

public signal void activate (uint position)
Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Scrollable

2022 vala-language.org