GI.Gtk.Interfaces.TreeSortable

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.

Exported types

newtype TreeSortable

Constructors

TreeSortable (ManagedPtr TreeSortable)

Instances

GObject TreeSortable

Methods

gobjectType :: TreeSortable -> IO GType

IsObject TreeSortable

IsTreeSortable TreeSortable

IsTreeModel TreeSortable

((~) * info (ResolveTreeSortableMethod t TreeSortable), MethodInfo * info TreeSortable p) => IsLabel t (TreeSortable -> p)

Methods

fromLabel :: Proxy# Symbol t -> TreeSortable -> p

((~) * info (ResolveTreeSortableMethod t TreeSortable), MethodInfo * info TreeSortable p) => IsLabelProxy t (TreeSortable -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> TreeSortable -> p

HasAttributeList * TreeSortable

type AttributeList TreeSortable

type AttributeList TreeSortable

type SignalList TreeSortable

type SignalList TreeSortable

noTreeSortable :: Maybe TreeSortable

class GObject o => IsTreeSortable o

Instances

(GObject a, UnknownAncestorError Constraint TreeSortable a) => IsTreeSortable a

IsTreeSortable TreeSortable

IsTreeSortable TreeModelSort

IsTreeSortable ListStore

IsTreeSortable TreeStore

toTreeSortable :: IsTreeSortable o => o -> IO TreeSortable

Methods

getSortColumnId

data TreeSortableGetSortColumnIdMethodInfo

Instances

((~) * signature (m (Bool, Int32, SortType)), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableGetSortColumnIdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableGetSortColumnIdMethodInfo a -> signature -> s

treeSortableGetSortColumnId

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

data TreeSortableHasDefaultSortFuncMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableHasDefaultSortFuncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableHasDefaultSortFuncMethodInfo a -> signature -> s

treeSortableHasDefaultSortFunc

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

data TreeSortableSetDefaultSortFuncMethodInfo

Instances

((~) * signature (TreeIterCompareFunc -> m ()), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableSetDefaultSortFuncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableSetDefaultSortFuncMethodInfo a -> signature -> s

treeSortableSetDefaultSortFunc

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

data TreeSortableSetSortColumnIdMethodInfo

Instances

((~) * signature (Int32 -> SortType -> m ()), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableSetSortColumnIdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableSetSortColumnIdMethodInfo a -> signature -> s

treeSortableSetSortColumnId

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

data TreeSortableSetSortFuncMethodInfo

Instances

((~) * signature (Int32 -> TreeIterCompareFunc -> m ()), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableSetSortFuncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableSetSortFuncMethodInfo a -> signature -> s

treeSortableSetSortFunc

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

data TreeSortableSortColumnChangedMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsTreeSortable a) => MethodInfo * TreeSortableSortColumnChangedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TreeSortableSortColumnChangedMethodInfo a -> signature -> s

treeSortableSortColumnChanged

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

type TreeSortableSortColumnChangedCallback = IO ()

data TreeSortableSortColumnChangedSignalInfo

Instances

SignalInfo TreeSortableSortColumnChangedSignalInfo

Associated Types

type HaskellCallbackType TreeSortableSortColumnChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o TreeSortableSortColumnChangedSignalInfo -> o -> HaskellCallbackType TreeSortableSortColumnChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType TreeSortableSortColumnChangedSignalInfo

type HaskellCallbackType TreeSortableSortColumnChangedSignalInfo = TreeSortableSortColumnChangedCallback

afterTreeSortableSortColumnChanged :: (GObject a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId

genClosure_TreeSortableSortColumnChanged :: TreeSortableSortColumnChangedCallback -> IO Closure

mk_TreeSortableSortColumnChangedCallback :: C_TreeSortableSortColumnChangedCallback -> IO (FunPtr C_TreeSortableSortColumnChangedCallback)

noTreeSortableSortColumnChangedCallback :: Maybe TreeSortableSortColumnChangedCallback

onTreeSortableSortColumnChanged :: (GObject a, MonadIO m) => a -> TreeSortableSortColumnChangedCallback -> m SignalHandlerId

wrap_TreeSortableSortColumnChangedCallback :: TreeSortableSortColumnChangedCallback -> Ptr () -> Ptr () -> IO ()