Struct gtk4::ColumnView

#[repr(transparent)]
pub struct ColumnView { /* private fields */ }

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

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 show-row-separators and show-column-separators properties offer a simple way to display separators between the rows or columns.

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 enable-rubberband.

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

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

ColumnView uses the AccessibleRole::TreeGrid role, header title widgets are using the AccessibleRole::ColumnHeader role. The row widgets are using the AccessibleRole::Row role, and individual cells are using the AccessibleRole::GridCell role

Properties

columns

The list of columns.

Readable

enable-rubberband

Allow rubberband selection.

Readable | Writeable

header-factory

Factory for creating header widgets.

Readable | Writeable

model

Model for the items displayed.

Readable | Writeable

reorderable

Whether columns are reorderable.

Readable | Writeable

row-factory

The factory used for configuring rows.

Readable | Writeable

show-column-separators

Show separators between columns.

Readable | Writeable

show-row-separators

Show separators between rows.

Readable | Writeable

single-click-activate

Activate rows on single click and select them on hover.

Readable | Writeable

sorter

Sorter with the sorting choices of the user.

Readable

tab-behavior

Behavior of the Tab key

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Scrollable

hadjustment

Horizontal Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

hscroll-policy

Determines when horizontal scrolling should start.

Readable | Writeable

vadjustment

Vertical Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

vscroll-policy

Determines when vertical scrolling should start.

Readable | Writeable

Signals

activate

Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.activate-item action.

This allows for a convenient way to handle activation in a columnview. See ListItemExt::set_activatable() for details on how to use this signal.

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, ScrollableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ColumnView

pub fn new(model: Option<impl IsA<SelectionModel>>) -> ColumnView

Creates a new ColumnView.

You most likely want to call append_column() to add columns next.

model

the list model to use

Returns

a new ColumnView

pub fn builder() -> ColumnViewBuilder

Creates a new builder-pattern struct instance to construct ColumnView objects.

This method returns an instance of ColumnViewBuilder which can be used to create ColumnView objects.

pub fn append_column(&self, column: &ColumnViewColumn)

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

column

a ColumnViewColumn that hasn’t been added to a ColumnView yet

pub fn columns(&self) -> ListModel

Gets the list of columns in this column view.

This list is constant over the lifetime of @self and can be used to monitor changes to the columns of @self by connecting to the ::items-changed signal.

Returns

The list managing the columns

pub fn enables_rubberband(&self) -> bool

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

Returns

true if rubberband selection is enabled

pub fn header_factory(&self) -> Option<ListItemFactory>

Available on crate feature v4_12 only.

Gets the factory that’s currently used to populate section headers.

Returns

The factory in use

pub fn model(&self) -> Option<SelectionModel>

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

Returns

The model in use

pub fn is_reorderable(&self) -> bool

Returns whether columns are reorderable.

Returns

true if columns are reorderable

pub fn row_factory(&self) -> Option<ListItemFactory>

Available on crate feature v4_12 only.

Gets the factory set via set_row_factory().

Returns

The factory

pub fn shows_column_separators(&self) -> bool

Returns whether the list should show separators between columns.

Returns

true if the list shows column separators

pub fn shows_row_separators(&self) -> bool

Returns whether the list should show separators between rows.

Returns

true if the list shows separators

pub fn is_single_click_activate(&self) -> bool

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

Returns

true if rows are activated on single click

pub fn sorter(&self) -> Option<Sorter>

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

To allow users to customizable sorting by clicking on column headers, this sorter needs to be set on the sort model underneath the model that is displayed by the view.

See ColumnViewColumn::set_sorter() for setting up per-column sorting.

Here is an example: ⚠️ The following code is in c ⚠️

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);

Returns

the Sorter of @self

pub fn tab_behavior(&self) -> ListTabBehavior

Available on crate feature v4_12 only.

Gets the behavior set for the Tab key.

Returns

The behavior of the Tab key

pub fn insert_column(&self, position: u32, column: &ColumnViewColumn)

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

If @column is already a column of @self, it will be repositioned.

position

the position to insert @column at

column

the ColumnViewColumn to insert

pub fn remove_column(&self, column: &ColumnViewColumn)

Removes the @column from the list of columns of @self.

column

a ColumnViewColumn that’s part of @self

pub fn scroll_to( &self, pos: u32, column: Option<&ColumnViewColumn>, flags: ListScrollFlags, scroll: Option<ScrollInfo> )

Available on crate feature v4_12 only.

Scroll to the row at the given position - or cell if a column is given - and performs the actions specified in @flags.

This function works no matter if the listview is shown or focused. If it isn’t, then the changes will take effect once that happens.

pos

position of the item

column

The column to scroll to or None to not scroll columns.

flags

actions to perform

scroll

details of how to perform the scroll operation or None to scroll into view

pub fn set_enable_rubberband(&self, enable_rubberband: bool)

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

enable_rubberband

true to enable rubberband selection

pub fn set_header_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Available on crate feature v4_12 only.

Sets the ListItemFactory to use for populating the ListHeader objects used in section headers.

If this factory is set to None, the list will not show section headers.

factory

the factory to use

pub fn set_model(&self, model: Option<&impl IsA<SelectionModel>>)

Sets the model to use.

This must be a SelectionModel.

model

the model to use

pub fn set_reorderable(&self, reorderable: bool)

Sets whether columns should be reorderable by dragging.

reorderable

whether columns should be reorderable

pub fn set_row_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Available on crate feature v4_12 only.

Sets the factory used for configuring rows. The factory must be for configuring ColumnViewRow objects.

If this factory is not set - which is the default - then the defaults will be used.

This factory is not used to set the widgets displayed in the individual cells. For that see GtkColumnViewColumn::set_factory() and ColumnViewCell.

factory

The row factory

pub fn set_show_column_separators(&self, show_column_separators: bool)

Sets whether the list should show separators between columns.

show_column_separators

true to show column separators

pub fn set_show_row_separators(&self, show_row_separators: bool)

Sets whether the list should show separators between rows.

show_row_separators

true to show row separators

pub fn set_single_click_activate(&self, single_click_activate: bool)

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

single_click_activate

true to activate items on single click

pub fn set_tab_behavior(&self, tab_behavior: ListTabBehavior)

Available on crate feature v4_12 only.

Sets the behavior of the Tab and Shift+Tab keys.

tab_behavior

The desired tab behavior

pub fn sort_by_column( &self, column: Option<&ColumnViewColumn>, direction: SortType )

Sets the sorting of the view.

This function should be used to set up the initial sorting. At runtime, users can change the sorting of a column view by clicking on the list headers.

This call only has an effect if the sorter returned by sorter() is set on a sort model, and ColumnViewColumn::set_sorter() has been called on @column to associate a sorter with the column.

If @column is None, the view will be unsorted.

column

the ColumnViewColumn to sort by

direction

the direction to sort in

pub fn connect_activate<F: Fn(&Self, u32) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when a row has been activated by the user, usually via activating the GtkListBase|list.activate-item action.

This allows for a convenient way to handle activation in a columnview. See ListItemExt::set_activatable() for details on how to use this signal.

position

position of item to activate

pub fn connect_columns_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_enable_rubberband_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_header_factory_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 only.

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reorderable_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_row_factory_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 only.

pub fn connect_show_column_separators_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_row_separators_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_single_click_activate_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_sorter_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_tab_behavior_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 only.

Trait Implementations

impl Clone for ColumnView

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColumnView

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ColumnView

fn default() -> Self

Returns the “default value” for a type.

impl Display for ColumnView

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ColumnView

type ParamSpec = ParamSpecObject

type SetValue = ColumnView

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ColumnView>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColumnView

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ColumnView

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ColumnView

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for ColumnView

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ColumnView

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ColumnView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColumnView

impl IsA<Accessible> for ColumnView

impl IsA<Buildable> for ColumnView

impl IsA<ConstraintTarget> for ColumnView

impl IsA<Scrollable> for ColumnView

impl IsA<Widget> for ColumnView