GI.Gtk.Objects.TreeListRowSorter

TreeListRowSorter is a special-purpose sorter that will apply a given sorter to the levels in a tree, while respecting the tree structure.

Here is an example for setting up a column view with a tree model and a GtkTreeListSorter:

column_sorter = gtk_column_view_get_sorter (view);
sorter = gtk_tree_list_row_sorter_new (g_object_ref (column_sorter));
sort_model = gtk_sort_list_model_new (tree_model, sorter);
selection = gtk_single_selection_new (sort_model);
gtk_column_view_set_model (view, G_LIST_MODEL (selection));

Exported types

newtype TreeListRowSorter

Memory-managed wrapper type.

Constructors

TreeListRowSorter (ManagedPtr TreeListRowSorter)

Instances

Eq TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

Methods

(==) :: TreeListRowSorter -> TreeListRowSorter -> Bool

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

GObject TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

ManagedPtrNewtype TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

Methods

toManagedPtr :: TreeListRowSorter -> ManagedPtr TreeListRowSorter

TypedObject TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

Methods

glibType :: IO GType

HasParentTypes TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

IsGValue (Maybe TreeListRowSorter)

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

Defined in GI.Gtk.Objects.TreeListRowSorter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes TreeListRowSorter

Defined in GI.Gtk.Objects.TreeListRowSorter

type ParentTypes TreeListRowSorter = '[Sorter, Object]

class (GObject o, IsDescendantOf TreeListRowSorter o) => IsTreeListRowSorter o

Type class for types which can be safely cast to TreeListRowSorter, for instance with toTreeListRowSorter.

Instances

(GObject o, IsDescendantOf TreeListRowSorter o) => IsTreeListRowSorter o

Defined in GI.Gtk.Objects.TreeListRowSorter

toTreeListRowSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m TreeListRowSorter

Cast to TreeListRowSorter, 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

bindProperty, bindPropertyFull, changed, compare, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getOrder, getProperty, getQdata, getSorter.

Setters

setData, setDataFull, setProperty, setSorter.

getSorter

treeListRowSorterGetSorter

Arguments

:: (HasCallStack, MonadIO m, IsTreeListRowSorter a)

=> a

self: a TreeListRowSorter

-> m (Maybe Sorter)

Returns: the sorter used

Returns the sorter used by self.

new

treeListRowSorterNew

Arguments

:: (HasCallStack, MonadIO m, IsSorter a)

=> Maybe a

sorter: a Sorter, or Nothing

-> m TreeListRowSorter

Returns: a new TreeListRowSorter

Create a special-purpose sorter that applies the sorting of sorter to the levels of a TreeListModel.

Note that this sorter relies on TreeListModel:passthrough being False as it can only sort GtkTreeListRows.

setSorter

treeListRowSorterSetSorter

Arguments

:: (HasCallStack, MonadIO m, IsTreeListRowSorter a, IsSorter b)

=> a

self: a TreeListRowSorter

-> Maybe b

sorter: The sorter to use, or Nothing

-> m ()

Sets the sorter to use for items with the same parent.

This sorter will be passed the TreeListRow:item of the tree list rows passed to self.

Properties

sorter

The underlying sorter

clearTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m ()

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

clear #sorter

constructTreeListRowSorterSorter :: (IsTreeListRowSorter o, MonadIO m, IsSorter a) => a -> m (GValueConstruct o)

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

getTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m (Maybe Sorter)

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

get treeListRowSorter #sorter

setTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o, IsSorter a) => o -> a -> m ()

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

set treeListRowSorter [ #sorter := value ]