Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Interfaces.TreeSortable

Contents

Exported types
Methods
Signals
- sortColumnChanged

Description

TreeSortable is an interface to be implemented by tree models which support sorting. The TreeView uses the methods provided by this interface to sort the model.

Synopsis

newtype TreeSortable = TreeSortable (ManagedPtr TreeSortable)
noTreeSortable :: Maybe TreeSortable
class GObject o => IsTreeSortable o
toTreeSortable :: (MonadIO m, IsTreeSortable o) => o -> m TreeSortable
treeSortableGetSortColumnId :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> m (Bool, Int32, SortType)
treeSortableHasDefaultSortFunc :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> m Bool
treeSortableSetDefaultSortFunc :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> TreeIterCompareFunc -> m ()
treeSortableSetSortColumnId :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> Int32 -> SortType -> m ()
treeSortableSetSortFunc :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> Int32 -> TreeIterCompareFunc -> m ()
treeSortableSortColumnChanged :: (HasCallStack, MonadIO m, IsTreeSortable a) => a -> m ()
type C_TreeSortableSortColumnChangedCallback = Ptr () -> Ptr () -> IO ()
type TreeSortableSortColumnChangedCallback = IO ()
afterTreeSortableSortColumnChanged :: (IsTreeSortable a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId
genClosure_TreeSortableSortColumnChanged :: TreeSortableSortColumnChangedCallback -> IO Closure
mk_TreeSortableSortColumnChangedCallback :: C_TreeSortableSortColumnChangedCallback -> IO (FunPtr C_TreeSortableSortColumnChangedCallback)
noTreeSortableSortColumnChangedCallback :: Maybe TreeSortableSortColumnChangedCallback
onTreeSortableSortColumnChanged :: (IsTreeSortable a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId
wrap_TreeSortableSortColumnChangedCallback :: TreeSortableSortColumnChangedCallback -> C_TreeSortableSortColumnChangedCallback

Exported types

newtype TreeSortable Source #

Memory-managed wrapper type.

Constructors

TreeSortable (ManagedPtr TreeSortable)

Instances

GObject TreeSortable Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable Methods gobjectType :: TreeSortable -> IO GType #
IsObject TreeSortable Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable
IsTreeModel TreeSortable Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable
IsTreeSortable TreeSortable Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable

noTreeSortable :: Maybe TreeSortable Source #

A convenience alias for Nothing :: Maybe TreeSortable.

class GObject o => IsTreeSortable o Source #

Type class for types which can be safely cast to TreeSortable, for instance with toTreeSortable.

Instances

(GObject a, (UnknownAncestorError TreeSortable a :: Constraint)) => IsTreeSortable a Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable
IsTreeSortable TreeSortable Source #
Instance details Defined in GI.Gtk.Interfaces.TreeSortable
IsTreeSortable TreeStore Source #
Instance details Defined in GI.Gtk.Objects.TreeStore
IsTreeSortable ListStore Source #
Instance details Defined in GI.Gtk.Objects.ListStore
IsTreeSortable TreeModelSort Source #
Instance details Defined in GI.Gtk.Objects.TreeModelSort

toTreeSortable :: (MonadIO m, IsTreeSortable o) => o -> m TreeSortable Source #

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

Methods

getSortColumnId

treeSortableGetSortColumnId Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> m (Bool, Int32, SortType)	Returns: `True` if the sort column is not one of the special sort column ids.

Fills in sortColumnId and order with the current sort column and the order. It returns True unless the sortColumnId is TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.

hasDefaultSortFunc

treeSortableHasDefaultSortFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> m Bool	Returns: `True`, if the model has a default sort function

Returns True if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not.

setDefaultSortFunc

treeSortableSetDefaultSortFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> TreeIterCompareFunc	`sortFunc`: The comparison function
-> m ()

Sets the default comparison function used when sorting to be sortFunc. If the current sort column id of sortable is TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.

If sortFunc is Nothing, then there will be no default comparison function. This means that once the model has been sorted, it can’t go back to the default state. In this case, when the current sort column id of sortable is TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.

setSortColumnId

treeSortableSetSortColumnId Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> Int32	`sortColumnId`: the sort column id to set
-> SortType	`order`: The sort order of the column
-> m ()

Sets the current sort column to be sortColumnId. The sortable will resort itself to reflect this change, after emitting a TreeSortable::sort-column-changed signal. sortColumnId may either be a regular column id, or one of the following special values:

TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function will be used, if it is set
TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur

setSortFunc

treeSortableSetSortFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> Int32	`sortColumnId`: the sort column id to set the function for
-> TreeIterCompareFunc	`sortFunc`: The comparison function
-> m ()

Sets the comparison function used when sorting to be sortFunc. If the current sort column id of sortable is the same as sortColumnId, then the model will sort using this function.

sortColumnChanged

treeSortableSortColumnChanged Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSortable a)
=> a	`sortable`: A `TreeSortable`
-> m ()

Emits a TreeSortable::sort-column-changed signal on sortable.

Signals

sortColumnChanged

type C_TreeSortableSortColumnChangedCallback = Ptr () -> Ptr () -> IO () Source #

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

type TreeSortableSortColumnChangedCallback = IO () Source #

The ::sort-column-changed signal is emitted when the sort column or sort order of sortable is changed. The signal is emitted before the contents of sortable are resorted.

afterTreeSortableSortColumnChanged :: (IsTreeSortable a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “sort-column-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after treeSortable #sortColumnChanged callback

genClosure_TreeSortableSortColumnChanged :: TreeSortableSortColumnChangedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_TreeSortableSortColumnChangedCallback :: C_TreeSortableSortColumnChangedCallback -> IO (FunPtr C_TreeSortableSortColumnChangedCallback) Source #

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

noTreeSortableSortColumnChangedCallback :: Maybe TreeSortableSortColumnChangedCallback Source #

A convenience synonym for Nothing :: Maybe TreeSortableSortColumnChangedCallback.

onTreeSortableSortColumnChanged :: (IsTreeSortable a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “sort-column-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on treeSortable #sortColumnChanged callback

wrap_TreeSortableSortColumnChangedCallback :: TreeSortableSortColumnChangedCallback -> C_TreeSortableSortColumnChangedCallback Source #

Wrap a TreeSortableSortColumnChangedCallback into a C_TreeSortableSortColumnChangedCallback.