GI.Gtk.Objects.ColumnView

GtkColumnView is a widget to present a view into 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 ColumnView:show-row-separators and 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 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 Sorter returned by columnViewGetSorter 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 columnViewColumnSetSorter. The initial sort order can be set with columnViewSortByColumn.

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 ColumnView:reorderable and ColumnViewColumn:resizable properties.

To learn more about the list widget framework, see the overview.

CSS nodes

plain code

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 ColumnView:show-column-separators property is set. Header widets 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 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

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

Exported types

newtype ColumnView

Memory-managed wrapper type.

Constructors

ColumnView (ManagedPtr ColumnView)

Instances

Eq ColumnView

Defined in GI.Gtk.Objects.ColumnView

Methods

(==) :: ColumnView -> ColumnView -> Bool

(/=) :: ColumnView -> ColumnView -> Bool

GObject ColumnView

Defined in GI.Gtk.Objects.ColumnView

ManagedPtrNewtype ColumnView

Defined in GI.Gtk.Objects.ColumnView

Methods

toManagedPtr :: ColumnView -> ManagedPtr ColumnView

TypedObject ColumnView

Defined in GI.Gtk.Objects.ColumnView

Methods

glibType :: IO GType

HasParentTypes ColumnView

Defined in GI.Gtk.Objects.ColumnView

IsGValue (Maybe ColumnView)

Convert ColumnView to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.ColumnView

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ColumnView -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ColumnView)

type ParentTypes ColumnView

Defined in GI.Gtk.Objects.ColumnView

type ParentTypes ColumnView = '[Widget, Object, Accessible, Buildable, ConstraintTarget, Scrollable]

class (GObject o, IsDescendantOf ColumnView o) => IsColumnView o

Type class for types which can be safely cast to ColumnView, for instance with toColumnView.

Instances

(GObject o, IsDescendantOf ColumnView o) => IsColumnView o

Defined in GI.Gtk.Objects.ColumnView

toColumnView :: (MonadIO m, IsColumnView o) => o -> m ColumnView

Cast to ColumnView, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, appendColumn, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, insertColumn, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeColumn, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, sortByColumn, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBorder, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColumns, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getEnableRubberband, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHscrollPolicy, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getModel, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getReorderable, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getShowColumnSeparators, getShowRowSeparators, getSingleClickActivate, getSize, getSizeRequest, getSorter, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getVadjustment, getValign, getVexpand, getVexpandSet, getVisible, getVscrollPolicy, getWidth.

Setters

setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEnableRubberband, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHexpand, setHexpandSet, setHscrollPolicy, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setModel, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setReorderable, setSensitive, setShowColumnSeparators, setShowRowSeparators, setSingleClickActivate, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVscrollPolicy.

appendColumn

columnViewAppendColumn

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a, IsColumnViewColumn b)

=> a

self: a ColumnView

-> b

column: a ColumnViewColumn that hasn't been added to a ColumnView yet

-> m ()

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

getColumns

columnViewGetColumns

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m ListModel

Returns: The list managing the columns

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 ListModel:items-changed signal.

getEnableRubberband

columnViewGetEnableRubberband

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m Bool

Returns: True if rubberband selection is enabled

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

getModel

columnViewGetModel

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m (Maybe SelectionModel)

Returns: The model in use

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

getReorderable

columnViewGetReorderable

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m Bool

Returns: True if columns are reorderable

Returns whether columns are reorderable.

getShowColumnSeparators

columnViewGetShowColumnSeparators

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m Bool

Returns: True if the list shows column separators

Returns whether the list should show separators between columns.

getShowRowSeparators

columnViewGetShowRowSeparators

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m Bool

Returns: True if the list shows separators

Returns whether the list should show separators between rows.

getSingleClickActivate

columnViewGetSingleClickActivate

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m Bool

Returns: True if rows are activated on single click

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

getSorter

columnViewGetSorter

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> m (Maybe Sorter)

Returns: the Sorter of self

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 columnViewColumnSetSorter for setting up per-column sorting.

Here is an example: > > 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);

insertColumn

columnViewInsertColumn

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a, IsColumnViewColumn b)

=> a

self: a ColumnView

-> Word32

position: the position to insert column at

-> b

column: the ColumnViewColumn to insert

-> m ()

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

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

new

columnViewNew

Arguments

:: (HasCallStack, MonadIO m, IsSelectionModel a)

=> Maybe a

model: the list model to use, or Nothing

-> m ColumnView

Returns: a new ColumnView

Creates a new ColumnView.

You most likely want to call columnViewAppendColumn to add columns next.

removeColumn

columnViewRemoveColumn

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a, IsColumnViewColumn b)

=> a

self: a ColumnView

-> b

column: a ColumnViewColumn that's part of self

-> m ()

Removes the column from the list of columns of self.

setEnableRubberband

columnViewSetEnableRubberband

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> Bool

enableRubberband: True to enable rubberband selection

-> m ()

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

setModel

columnViewSetModel

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a, IsSelectionModel b)

=> a

self: a ColumnView

-> Maybe b

model: the model to use or Nothing for none

-> m ()

Sets the SelectionModel to use.

setReorderable

columnViewSetReorderable

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> Bool

reorderable: whether columns should be reorderable

-> m ()

Sets whether columns should be reorderable by dragging.

setShowColumnSeparators

columnViewSetShowColumnSeparators

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> Bool

showColumnSeparators: True to show column separators

-> m ()

Sets whether the list should show separators between columns.

setShowRowSeparators

columnViewSetShowRowSeparators

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> Bool

showRowSeparators: True to show row separators

-> m ()

Sets whether the list should show separators between rows.

setSingleClickActivate

columnViewSetSingleClickActivate

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a)

=> a

self: a ColumnView

-> Bool

singleClickActivate: True to activate items on single click

-> m ()

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

sortByColumn

columnViewSortByColumn

Arguments

:: (HasCallStack, MonadIO m, IsColumnView a, IsColumnViewColumn b)

=> a

self: a ColumnView

-> Maybe b

column: the ColumnViewColumn to sort by, or Nothing

-> SortType

direction: the direction to sort in

-> m ()

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 columnViewGetSorter is set on a sort model, and columnViewColumnSetSorter has been called on column to associate a sorter with the column.

If column is Nothing, the view will be unsorted.

Properties

columns

The list of columns

getColumnViewColumns :: (MonadIO m, IsColumnView o) => o -> m ListModel

Get the value of the “columns” property. When overloading is enabled, this is equivalent to

get columnView #columns

enableRubberband

Allow rubberband selection

constructColumnViewEnableRubberband :: (IsColumnView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “enable-rubberband” property. This is rarely needed directly, but it is used by new.

getColumnViewEnableRubberband :: (MonadIO m, IsColumnView o) => o -> m Bool

Get the value of the “enable-rubberband” property. When overloading is enabled, this is equivalent to

get columnView #enableRubberband

setColumnViewEnableRubberband :: (MonadIO m, IsColumnView o) => o -> Bool -> m ()

Set the value of the “enable-rubberband” property. When overloading is enabled, this is equivalent to

set columnView [ #enableRubberband := value ]

model

Model for the items displayed

clearColumnViewModel :: (MonadIO m, IsColumnView o) => o -> m ()

Set the value of the “model” property to Nothing. When overloading is enabled, this is equivalent to

clear #model

constructColumnViewModel :: (IsColumnView o, MonadIO m, IsSelectionModel a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

getColumnViewModel :: (MonadIO m, IsColumnView o) => o -> m (Maybe SelectionModel)

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get columnView #model

setColumnViewModel :: (MonadIO m, IsColumnView o, IsSelectionModel a) => o -> a -> m ()

Set the value of the “model” property. When overloading is enabled, this is equivalent to

set columnView [ #model := value ]

reorderable

Whether columns are reorderable

constructColumnViewReorderable :: (IsColumnView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “reorderable” property. This is rarely needed directly, but it is used by new.

getColumnViewReorderable :: (MonadIO m, IsColumnView o) => o -> m Bool

Get the value of the “reorderable” property. When overloading is enabled, this is equivalent to

get columnView #reorderable

setColumnViewReorderable :: (MonadIO m, IsColumnView o) => o -> Bool -> m ()

Set the value of the “reorderable” property. When overloading is enabled, this is equivalent to

set columnView [ #reorderable := value ]

showColumnSeparators

Show separators between columns

constructColumnViewShowColumnSeparators :: (IsColumnView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-column-separators” property. This is rarely needed directly, but it is used by new.

getColumnViewShowColumnSeparators :: (MonadIO m, IsColumnView o) => o -> m Bool

Get the value of the “show-column-separators” property. When overloading is enabled, this is equivalent to

get columnView #showColumnSeparators

setColumnViewShowColumnSeparators :: (MonadIO m, IsColumnView o) => o -> Bool -> m ()

Set the value of the “show-column-separators” property. When overloading is enabled, this is equivalent to

set columnView [ #showColumnSeparators := value ]

showRowSeparators

Show separators between rows

constructColumnViewShowRowSeparators :: (IsColumnView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-row-separators” property. This is rarely needed directly, but it is used by new.

getColumnViewShowRowSeparators :: (MonadIO m, IsColumnView o) => o -> m Bool

Get the value of the “show-row-separators” property. When overloading is enabled, this is equivalent to

get columnView #showRowSeparators

setColumnViewShowRowSeparators :: (MonadIO m, IsColumnView o) => o -> Bool -> m ()

Set the value of the “show-row-separators” property. When overloading is enabled, this is equivalent to

set columnView [ #showRowSeparators := value ]

singleClickActivate

Activate rows on single click and select them on hover

constructColumnViewSingleClickActivate :: (IsColumnView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “single-click-activate” property. This is rarely needed directly, but it is used by new.

getColumnViewSingleClickActivate :: (MonadIO m, IsColumnView o) => o -> m Bool

Get the value of the “single-click-activate” property. When overloading is enabled, this is equivalent to

get columnView #singleClickActivate

setColumnViewSingleClickActivate :: (MonadIO m, IsColumnView o) => o -> Bool -> m ()

Set the value of the “single-click-activate” property. When overloading is enabled, this is equivalent to

set columnView [ #singleClickActivate := value ]

sorter

Sorter with the sorting choices of the user

getColumnViewSorter :: (MonadIO m, IsColumnView o) => o -> m (Maybe Sorter)

Get the value of the “sorter” property. When overloading is enabled, this is equivalent to

get columnView #sorter

Signals

activate

type C_ColumnViewActivateCallback = Ptr () -> Word32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ColumnViewActivateCallback

Arguments

 = Word32

position: position of item to activate

-> IO ()

The activate signal is 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 listItemSetActivatable for details on how to use this signal.

afterColumnViewActivate :: (IsColumnView a, MonadIO m) => a -> ColumnViewActivateCallback -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after columnView #activate callback

genClosure_ColumnViewActivate :: MonadIO m => ColumnViewActivateCallback -> m (GClosure C_ColumnViewActivateCallback)

Wrap the callback into a GClosure.

mk_ColumnViewActivateCallback :: C_ColumnViewActivateCallback -> IO (FunPtr C_ColumnViewActivateCallback)

Generate a function pointer callable from C code, from a C_ColumnViewActivateCallback.

noColumnViewActivateCallback :: Maybe ColumnViewActivateCallback

A convenience synonym for Nothing :: Maybe ColumnViewActivateCallback.

onColumnViewActivate :: (IsColumnView a, MonadIO m) => a -> ColumnViewActivateCallback -> m SignalHandlerId

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on columnView #activate callback

wrap_ColumnViewActivateCallback :: ColumnViewActivateCallback -> C_ColumnViewActivateCallback

Wrap a ColumnViewActivateCallback into a C_ColumnViewActivateCallback.