ColumnView
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 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.
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 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 GtkSorter returned by method@Gtk.ColumnView.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 method@Gtk.ColumnViewColumn.set_sorter. The initial sort order can be set with method@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 property@Gtk.ColumnView:reorderable and property@Gtk.ColumnViewColumn:resizable properties.
To learn more about the list widget framework, see the section-list-widget.html.
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 property@Gtk.ColumnView: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 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 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
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
A list of css classes applied to this widget.
Allow rubberband selection.
Whether the widget should grab focus when it is clicked with the mouse.
Horizontal GtkAdjustment of the scrollable widget.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Factory for creating header widgets.
Whether to use the hexpand property.
Determines when horizontal scrolling should start.
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
Model for the items displayed.
Whether the widget will receive the default action when it is focused.
Whether columns are reorderable.
The factory used for configuring rows.
The scale factor of the widget.
Show separators between columns.
Show separators between rows.
Activate rows on single click and select them on hover.
Behavior of the Tab key
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Vertical GtkAdjustment of the scrollable widget.
Whether to use the vexpand property.
Determines when vertical scrolling should start.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
Requests the user's screen reader to announce the given message.
Appends the @column to the end of the columns in @self.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.activate-item action.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when @widget is associated with a GdkSurface.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Determines whether the input focus can enter @widget or any of its children.
Queries whether @widget can be the target of pointer events.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Gets the list of columns in this column view.
Returns the list of style classes applied to @widget.
Returns the CSS name that is used for @self.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Returns whether rows can be selected by dragging with the mouse.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Determines whether @widget can own the input focus.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Retrieves the GtkAdjustment used for horizontal scrolling.
Returns the current value of the has-tooltip property.
Gets the factory that's currently used to populate section headers.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
Gets the horizontal GtkScrollablePolicy.
Returns the widget’s last child.
Retrieves the layout manager used by @widget.
Gets the bottom margin of @widget.
Gets the end margin of @widget.
Gets the start margin of @widget.
Gets the top margin of @widget.
Gets the model that's currently used to read the items displayed.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
#Fetches the requested opacity for this widget.
Returns the widget’s overflow value.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Returns whether columns are reorderable.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gets the factory set via method@Gtk.ColumnView.set_row_factory.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns whether the list should show separators between columns.
Returns whether the list should show separators between rows.
Returns whether rows will be activated on single click and selected on hover.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Gets the behavior set for the Tab key.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Retrieves the GtkAdjustment used for vertical scrolling.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
Determines whether the widget is visible.
Gets the vertical GtkScrollablePolicy.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Inserts a column at the given position in the columns of @self.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes the @column from the list of columns of @self.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Scroll to the row at the given position - or cell if a column is given - and performs the actions specified in @flags.
Sets the parent and sibling of an accessible object.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether @widget can be the target of pointer events.
Sets whether @widget should be mapped along with its parent.
Clear all style classes applied to @widget and replace them with @classes.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Sets whether selections can be changed by dragging with the mouse.
Specifies whether @widget can own the input focus.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Sets the font map to use for Pango rendering.
Sets the horizontal adjustment of the GtkScrollable.
Sets the has-tooltip property on @widget to @has_tooltip.
Sets the GtkListItemFactory to use for populating the class@Gtk.ListHeader objects used in section headers.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets the GtkScrollablePolicy.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
Sets the bottom margin of @widget.
Sets the end margin of @widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets the model to use.
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Sets whether columns should be reorderable by dragging.
Sets the factory used for configuring rows. The factory must be for configuring class@Gtk.ColumnViewRow objects.
Sets the sensitivity of a widget.
Sets whether the list should show separators between columns.
Sets whether the list should show separators between rows.
Sets whether rows should be activated on single click and selected on hover.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets the behavior of the Tab and Shift+Tab keys.
Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
Sets @text as the contents of the tooltip.
Sets the vertical adjustment of the GtkScrollable.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets the visibility state of @widget.
Sets the GtkScrollablePolicy.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Sets the sorting of the view.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.