| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.TreeListRowSorter
Description
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));
Synopsis
- newtype TreeListRowSorter = TreeListRowSorter (ManagedPtr TreeListRowSorter)
- class (GObject o, IsDescendantOf TreeListRowSorter o) => IsTreeListRowSorter o
- toTreeListRowSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m TreeListRowSorter
- treeListRowSorterGetSorter :: (HasCallStack, MonadIO m, IsTreeListRowSorter a) => a -> m (Maybe Sorter)
- treeListRowSorterNew :: (HasCallStack, MonadIO m, IsSorter a) => Maybe a -> m TreeListRowSorter
- treeListRowSorterSetSorter :: (HasCallStack, MonadIO m, IsTreeListRowSorter a, IsSorter b) => a -> Maybe b -> m ()
- clearTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m ()
- constructTreeListRowSorterSorter :: (IsTreeListRowSorter o, MonadIO m, IsSorter a) => a -> m (GValueConstruct o)
- getTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m (Maybe Sorter)
- setTreeListRowSorterSorter :: (MonadIO m, IsTreeListRowSorter o, IsSorter a) => o -> a -> m ()
Exported types
newtype TreeListRowSorter Source #
Memory-managed wrapper type.
Constructors
| TreeListRowSorter (ManagedPtr TreeListRowSorter) |
Instances
class (GObject o, IsDescendantOf TreeListRowSorter o) => IsTreeListRowSorter o Source #
Type class for types which can be safely cast to TreeListRowSorter, for instance with toTreeListRowSorter.
Instances
| (GObject o, IsDescendantOf TreeListRowSorter o) => IsTreeListRowSorter o Source # | |
Defined in GI.Gtk.Objects.TreeListRowSorter | |
toTreeListRowSorter :: (MonadIO m, IsTreeListRowSorter o) => o -> m TreeListRowSorter Source #
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
getSorter
treeListRowSorterGetSorter Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTreeListRowSorter a) | |
| => a |
|
| -> m (Maybe Sorter) | Returns: the sorter used |
Returns the sorter used by self.
new
Arguments
| :: (HasCallStack, MonadIO m, IsSorter a) | |
| => Maybe a | |
| -> m TreeListRowSorter | Returns: a new |
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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsTreeListRowSorter a, IsSorter b) | |
| => a |
|
| -> Maybe b |
|
| -> 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 () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “sorter” property.
When overloading is enabled, this is equivalent to
settreeListRowSorter [ #sorter:=value ]