Class
GtkColumnView
Description [src]
final class Gtk.ColumnView : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Scrollable {
/* No available fields */
}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 GtkColumnView:show-row-separators and
GtkColumnView: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
GtkColumnView: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
gtk_column_view_get_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 gtk_column_view_column_set_sorter(). The initial sort
order can be set with gtk_column_view_sort_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 GtkColumnView:reorderable and
GtkColumnViewColumn:resizable properties.
To learn more about the list widget framework, see the overview.
CSS nodes
columnview[.column-separators][.rich-list][.navigation-sidebar][.data-table]
├── header
│ ├── <column header>
┊ ┊
│ ╰── <column header>
│
├── listview
│
┊
╰── [rubberband]
GtkColumnView uses a single CSS node named columnview. It may carry the
.column-separators style class, when GtkColumnView: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 GtkColumnView: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: .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.
Instance methods
gtk_column_view_get_enable_rubberband
Returns whether rows can be selected by dragging with the mouse.
gtk_column_view_get_header_factory
Gets the factory that’s currently used to populate section headers.
since: 4.12
gtk_column_view_get_row_factory
Gets the factory set via gtk_column_view_set_row_factory().
since: 4.12
gtk_column_view_get_show_column_separators
Returns whether the list should show separators between columns.
gtk_column_view_get_show_row_separators
Returns whether the list should show separators between rows.
gtk_column_view_get_single_click_activate
Returns whether rows will be activated on single click and selected on hover.
gtk_column_view_get_sorter
Returns a special sorter that reflects the users sorting choices in the column view.
gtk_column_view_scroll_to
Scroll to the row at the given position - or cell if a column is
given - and performs the actions specified in flags.
since: 4.12
gtk_column_view_set_enable_rubberband
Sets whether selections can be changed by dragging with the mouse.
gtk_column_view_set_header_factory
Sets the factory to use for populating the
GtkListHeader objects used in section headers.
since: 4.12
gtk_column_view_set_show_column_separators
Sets whether the list should show separators between columns.
gtk_column_view_set_single_click_activate
Sets whether rows should be activated on single click and selected on hover.
Methods inherited from GtkAccessible (20)
Methods inherited from GtkBuildable (1)
Methods inherited from GtkScrollable (9)
Properties
Properties inherited from GtkAccessible (1)
Properties inherited from GtkScrollable (4)
Signals
Gtk.ColumnView::activate
Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.activate-item action.