class Gtk::ColumnView

• Gtk::ColumnView
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

Gtk::ColumnView presents a large dynamic list of items using multiple columns with headers.

Gtk::ColumnView 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 [property@Gtk.ColumnView:show-row-separators] and [property@Gtk.ColumnView:show-column-separators] properties offer a simple way to display separators between the rows or columns.

Gtk::ColumnView 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 [property@Gtk.ColumnView:enable-rubberband].

The column view supports sorting that can be customized by the user by clicking on column headers. To set this up, the Gtk::Sorter returned by Gtk::ColumnView#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::ColumnViewColumn#sorter=. The initial sort order can be set with Gtk::ColumnView#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 Gtk::ColumnView#reorderable and Gtk::ColumnViewColumn#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]

Gtk::ColumnView uses a single CSS node named columnview. It may carry the .column-separators style class, when [property@Gtk.ColumnView:show-column-separators] property is set. Header widgets appear below a node with name header. The rows are contained in a Gtk::ListView widget, so there is a listview node with the same structure as for a standalone Gtk::ListView widget. If [property@Gtk.ColumnView: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

Gtk::ColumnView 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

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::Scrollable

Defined in:

Constructors

• .new(model : Gtk::SelectionModel | Nil) : self

  Creates a new Gtk::ColumnView.

• .new

  Initialize a new ColumnView.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, columns : Gio::ListModel | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, enable_rubberband : Bool | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, hadjustment : Gtk::Adjustment | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, hscroll_policy : Gtk::ScrollablePolicy | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, model : Gtk::SelectionModel | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, reorderable : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, show_column_separators : Bool | Nil = nil, show_row_separators : Bool | Nil = nil, single_click_activate : Bool | Nil = nil, sorter : Gtk::Sorter | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, vadjustment : Gtk::Adjustment | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, vscroll_policy : Gtk::ScrollablePolicy | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #activate_signal
• #append_column(column : Gtk::ColumnViewColumn) : Nil

  Appends the column to the end of the columns in self.

• #columns : Gio::ListModel

  Gets the list of columns in this column view.

• #enable_rubberband : Bool

  Returns whether rows can be selected by dragging with the mouse.

• #enable_rubberband=(enable_rubberband : Bool) : Nil

  Sets whether selections can be changed by dragging with the mouse.

• #enable_rubberband? : Bool
• #hash(hasher)

  See Object#hash(hasher)

• #insert_column(position : UInt32, column : Gtk::ColumnViewColumn) : Nil

  Inserts a column at the given position in the columns of self.

• #model : Gtk::SelectionModel | Nil

  Gets the model that's currently used to read the items displayed.

• #model=(model : Gtk::SelectionModel | Nil) : Nil

  Sets the model to use.

• #remove_column(column : Gtk::ColumnViewColumn) : Nil

  Removes the column from the list of columns of self.

• #reorderable : Bool

  Returns whether columns are reorderable.

• #reorderable=(reorderable : Bool) : Nil

  Sets whether columns should be reorderable by dragging.

• #reorderable? : Bool
• #show_column_separators : Bool

  Returns whether the list should show separators between columns.

• #show_column_separators=(show_column_separators : Bool) : Nil

  Sets whether the list should show separators between columns.

• #show_column_separators? : Bool
• #show_row_separators : Bool

  Returns whether the list should show separators between rows.

• #show_row_separators=(show_row_separators : Bool) : Nil

  Sets whether the list should show separators between rows.

• #show_row_separators? : Bool
• #single_click_activate : Bool

  Returns whether rows will be activated on single click and selected on hover.

• #single_click_activate=(single_click_activate : Bool) : Nil

  Sets whether rows should be activated on single click and selected on hover.

• #single_click_activate? : Bool
• #sort_by_column(column : Gtk::ColumnViewColumn | Nil, direction : Gtk::SortType) : Nil

  Sets the sorting of the view.

• #sorter : Gtk::Sorter | Nil

  Returns a special sorter that reflects the users sorting choices in the column view.

Constructor Detail

Class Method Detail

Instance Method Detail

gtk_column_view_column_set_sorter (column, sorter);
gtk_column_view_append_column (view, column);
sorter = g_object_ref (gtk_column_view_get_sorter (view)));
model = gtk_sort_list_model_new (store, sorter);
selection = gtk_no_selection_new (model);
gtk_column_view_set_model (view, selection);