<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ --> <title>dist/build/Graphics/UI/Gtk/ModelView/TreeModelSort.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a> <a name="line-2"></a><span class='hs-comment'>{-# LINE 2 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-3"></a><span class='hs-comment'>-- -*-haskell-*-</span> <a name="line-4"></a><span class='hs-comment'>-- GIMP Toolkit (GTK) TreeModelSort</span> <a name="line-5"></a><span class='hs-comment'>--</span> <a name="line-6"></a><span class='hs-comment'>-- Author : Duncan Coutts</span> <a name="line-7"></a><span class='hs-comment'>--</span> <a name="line-8"></a><span class='hs-comment'>-- Created: 4 August 2004</span> <a name="line-9"></a><span class='hs-comment'>--</span> <a name="line-10"></a><span class='hs-comment'>-- Copyright (C) 2004-2005 Duncan Coutts, Axel Simon</span> <a name="line-11"></a><span class='hs-comment'>--</span> <a name="line-12"></a><span class='hs-comment'>-- This library is free software; you can redistribute it and/or</span> <a name="line-13"></a><span class='hs-comment'>-- modify it under the terms of the GNU Lesser General Public</span> <a name="line-14"></a><span class='hs-comment'>-- License as published by the Free Software Foundation; either</span> <a name="line-15"></a><span class='hs-comment'>-- version 2.1 of the License, or (at your option) any later version.</span> <a name="line-16"></a><span class='hs-comment'>--</span> <a name="line-17"></a><span class='hs-comment'>-- This library is distributed in the hope that it will be useful,</span> <a name="line-18"></a><span class='hs-comment'>-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="line-19"></a><span class='hs-comment'>-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="line-20"></a><span class='hs-comment'>-- Lesser General Public License for more details.</span> <a name="line-21"></a><span class='hs-comment'>--</span> <a name="line-22"></a><span class='hs-comment'>-- |</span> <a name="line-23"></a><span class='hs-comment'>-- Maintainer : gtk2hs-users@lists.sourceforge.net</span> <a name="line-24"></a><span class='hs-comment'>-- Stability : provisional</span> <a name="line-25"></a><span class='hs-comment'>-- Portability : portable (depends on GHC)</span> <a name="line-26"></a><span class='hs-comment'>--</span> <a name="line-27"></a><span class='hs-comment'>-- A 'TreeModel' which makes an underlying tree model sortable</span> <a name="line-28"></a><span class='hs-comment'>--</span> <a name="line-29"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>ModelView</span><span class='hs-varop'>.</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-layout'>(</span> <a name="line-30"></a><span class='hs-comment'>-- * Detail</span> <a name="line-31"></a><span class='hs-comment'>--</span> <a name="line-32"></a><span class='hs-comment'>-- | The 'TreeModelSort' is a model which implements the 'TreeSortable'</span> <a name="line-33"></a><span class='hs-comment'>-- interface. It does not hold any data itself, but rather is created with a</span> <a name="line-34"></a><span class='hs-comment'>-- child model and proxies its data. It has identical rows to its</span> <a name="line-35"></a><span class='hs-comment'>-- child model, and the changes in the child are propagated. The primary</span> <a name="line-36"></a><span class='hs-comment'>-- purpose of this model is to provide a way to sort a model without</span> <a name="line-37"></a><span class='hs-comment'>-- modifying it.</span> <a name="line-38"></a> <a name="line-39"></a><span class='hs-comment'>-- * Class Hierarchy</span> <a name="line-40"></a><span class='hs-comment'>-- |</span> <a name="line-41"></a><span class='hs-comment'>-- @</span> <a name="line-42"></a><span class='hs-comment'>-- | 'GObject'</span> <a name="line-43"></a><span class='hs-comment'>-- | +----TreeModelSort</span> <a name="line-44"></a><span class='hs-comment'>-- @</span> <a name="line-45"></a> <a name="line-46"></a><span class='hs-comment'>-- * Types</span> <a name="line-47"></a> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>,</span> <a name="line-48"></a> <span class='hs-conid'>TreeModelSortClass</span><span class='hs-layout'>,</span> <a name="line-49"></a> <span class='hs-varid'>castToTreeModelSort</span><span class='hs-layout'>,</span> <span class='hs-varid'>gTypeTreeModelSort</span><span class='hs-layout'>,</span> <a name="line-50"></a> <span class='hs-varid'>toTreeModelSort</span><span class='hs-layout'>,</span> <a name="line-51"></a> <a name="line-52"></a> <span class='hs-conid'>TypedTreeModelSort</span><span class='hs-layout'>,</span> <a name="line-53"></a> <a name="line-54"></a><span class='hs-comment'>-- * Constructors</span> <a name="line-55"></a> <span class='hs-varid'>treeModelSortNewWithModel</span><span class='hs-layout'>,</span> <a name="line-56"></a> <a name="line-57"></a><span class='hs-comment'>-- * Methods</span> <a name="line-58"></a> <span class='hs-varid'>treeModelSortGetModel</span><span class='hs-layout'>,</span> <a name="line-59"></a> <span class='hs-varid'>treeModelSortConvertChildPathToPath</span><span class='hs-layout'>,</span> <a name="line-60"></a> <span class='hs-varid'>treeModelSortConvertPathToChildPath</span><span class='hs-layout'>,</span> <a name="line-61"></a> <span class='hs-varid'>treeModelSortConvertChildIterToIter</span><span class='hs-layout'>,</span> <a name="line-62"></a> <span class='hs-varid'>treeModelSortConvertIterToChildIter</span><span class='hs-layout'>,</span> <a name="line-63"></a> <span class='hs-varid'>treeModelSortResetDefaultSortFunc</span><span class='hs-layout'>,</span> <a name="line-64"></a> <span class='hs-varid'>treeModelSortClearCache</span><span class='hs-layout'>,</span> <a name="line-65"></a> <a name="line-66"></a> <span class='hs-varid'>treeModelSortIterIsValid</span><span class='hs-layout'>,</span> <a name="line-67"></a> <a name="line-68"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-69"></a> <a name="line-70"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span><span class='hs-layout'>)</span> <a name="line-71"></a> <a name="line-72"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>FFI</span> <a name="line-73"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>GObject</span> <span class='hs-layout'>(</span><span class='hs-varid'>wrapNewGObject</span><span class='hs-layout'>,</span> <span class='hs-varid'>makeNewGObject</span><span class='hs-layout'>)</span> <a name="line-74"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <a name="line-75"></a><span class='hs-comment'>{-# LINE 74 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-76"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>ModelView</span><span class='hs-varop'>.</span><span class='hs-conid'>TreeModel</span> <a name="line-77"></a><span class='hs-comment'>{-# LINE 75 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-78"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>ModelView</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <a name="line-79"></a><span class='hs-comment'>{-# LINE 76 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-80"></a> <a name="line-81"></a> <a name="line-82"></a><span class='hs-comment'>{-# LINE 78 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-83"></a> <a name="line-84"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>TreeModelClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <a name="line-85"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <a name="line-86"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>GObjectClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-87"></a> <span class='hs-varid'>toGObject</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>tm</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GObject</span> <span class='hs-layout'>(</span><span class='hs-varid'>castForeignPtr</span> <span class='hs-varid'>tm</span><span class='hs-layout'>)</span> <a name="line-88"></a> <span class='hs-varid'>unsafeCastGObject</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varop'>.</span> <span class='hs-varid'>castForeignPtr</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unGObject</span> <a name="line-89"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>TreeSortableClass</span> <span class='hs-conid'>TreeModelSort</span> <a name="line-90"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>TreeSortableClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>row</span><span class='hs-layout'>)</span> <a name="line-91"></a> <a name="line-92"></a><span class='hs-comment'>--------------------</span> <a name="line-93"></a><span class='hs-comment'>-- Constructors</span> <a name="line-94"></a> <a name="line-95"></a><a name="treeModelSortNewWithModel"></a><span class='hs-comment'>-- | Creates a new 'TreeModelSort', that will be a sorted view of the given</span> <a name="line-96"></a><span class='hs-comment'>-- model.</span> <a name="line-97"></a><span class='hs-comment'>--</span> <a name="line-98"></a><span class='hs-definition'>treeModelSortNewWithModel</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>TreeModelClass</span> <span class='hs-layout'>(</span><span class='hs-varid'>childModel</span> <span class='hs-varid'>row</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <a name="line-99"></a> <span class='hs-conid'>TypedTreeModelClass</span> <span class='hs-varid'>childModel</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <a name="line-100"></a> <span class='hs-varid'>childModel</span> <span class='hs-varid'>row</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>TypedTreeModelSort</span> <span class='hs-varid'>row</span><span class='hs-layout'>)</span> <a name="line-101"></a><span class='hs-definition'>treeModelSortNewWithModel</span> <span class='hs-varid'>childModel</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>unsafeTreeModelSortToGeneric</span> <span class='hs-varop'>$</span> <a name="line-102"></a> <span class='hs-varid'>wrapNewGObject</span> <span class='hs-varid'>mkTreeModelSort</span> <span class='hs-varop'>$</span> <a name="line-103"></a> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModel</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <a name="line-104"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModel</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_new_with_model</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span> <a name="line-105"></a><span class='hs-comment'>{-# LINE 100 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-106"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModel</span> <span class='hs-varid'>childModel</span><span class='hs-layout'>)</span> <a name="line-107"></a> <a name="line-108"></a><span class='hs-comment'>--------------------</span> <a name="line-109"></a><span class='hs-comment'>-- Methods</span> <a name="line-110"></a> <a name="line-111"></a><a name="treeModelSortGetModel"></a><span class='hs-comment'>-- | Returns the underlying model the 'TreeModelSort' is sorting.</span> <a name="line-112"></a><span class='hs-comment'>--</span> <a name="line-113"></a><span class='hs-definition'>treeModelSortGetModel</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreeModel</span> <a name="line-114"></a><span class='hs-definition'>treeModelSortGetModel</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span> <a name="line-115"></a> <span class='hs-varid'>makeNewGObject</span> <span class='hs-varid'>mkTreeModel</span> <span class='hs-varop'>$</span> <a name="line-116"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_get_model</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span> <a name="line-117"></a><span class='hs-comment'>{-# LINE 111 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-118"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-119"></a> <a name="line-120"></a><a name="treeModelSortConvertChildPathToPath"></a><span class='hs-comment'>-- | Converts the given path to a path relative to the given sorted model.</span> <a name="line-121"></a><span class='hs-comment'>--</span> <a name="line-122"></a><span class='hs-comment'>-- * The given path points to a row in the child model. The returned path will</span> <a name="line-123"></a><span class='hs-comment'>-- point to the same row in the sorted model.</span> <a name="line-124"></a><span class='hs-comment'>--</span> <a name="line-125"></a><span class='hs-definition'>treeModelSortConvertChildPathToPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <a name="line-126"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreePath</span> <a name="line-127"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreePath</span> <a name="line-128"></a><span class='hs-definition'>treeModelSortConvertChildPathToPath</span> <span class='hs-varid'>self</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span> <a name="line-129"></a><span class='hs-definition'>treeModelSortConvertChildPathToPath</span> <span class='hs-varid'>self</span> <span class='hs-varid'>childPath</span> <span class='hs-keyglyph'>=</span> <a name="line-130"></a> <span class='hs-varid'>withTreePath</span> <span class='hs-varid'>childPath</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>childPath</span> <span class='hs-keyglyph'>-></span> <a name="line-131"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>NativeTreePath</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_convert_child_path_to_path</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <a name="line-132"></a><span class='hs-comment'>{-# LINE 125 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-133"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-134"></a> <span class='hs-varid'>childPath</span> <a name="line-135"></a> <span class='hs-varop'>>>=</span> <span class='hs-varid'>fromTreePath</span> <a name="line-136"></a> <a name="line-137"></a><a name="treeModelSortConvertPathToChildPath"></a><span class='hs-comment'>-- | Converts path in the sorted model to a path on the unsorted model on which</span> <a name="line-138"></a><span class='hs-comment'>-- the given 'TreeModelSort' is based. That is, the given path points to a</span> <a name="line-139"></a><span class='hs-comment'>-- location in the given 'TreeModelSort'. The returned path will point to the</span> <a name="line-140"></a><span class='hs-comment'>-- same location in the underlying unsorted model.</span> <a name="line-141"></a><span class='hs-comment'>--</span> <a name="line-142"></a><span class='hs-definition'>treeModelSortConvertPathToChildPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <a name="line-143"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreePath</span> <a name="line-144"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreePath</span> <a name="line-145"></a><span class='hs-definition'>treeModelSortConvertPathToChildPath</span> <span class='hs-varid'>self</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span> <a name="line-146"></a><span class='hs-definition'>treeModelSortConvertPathToChildPath</span> <span class='hs-varid'>self</span> <span class='hs-varid'>sortedPath</span> <span class='hs-keyglyph'>=</span> <a name="line-147"></a> <span class='hs-varid'>withTreePath</span> <span class='hs-varid'>sortedPath</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>sortedPath</span> <span class='hs-keyglyph'>-></span> <a name="line-148"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>NativeTreePath</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_convert_path_to_child_path</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <a name="line-149"></a><span class='hs-comment'>{-# LINE 141 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-150"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-151"></a> <span class='hs-varid'>sortedPath</span> <a name="line-152"></a> <span class='hs-varop'>>>=</span> <span class='hs-varid'>fromTreePath</span> <a name="line-153"></a> <a name="line-154"></a><a name="treeModelSortConvertChildIterToIter"></a><span class='hs-comment'>-- | Return an iterator in the sorted model that points to the row pointed to</span> <a name="line-155"></a><span class='hs-comment'>-- by the given iter from the unsorted model.</span> <a name="line-156"></a><span class='hs-comment'>--</span> <a name="line-157"></a><span class='hs-definition'>treeModelSortConvertChildIterToIter</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <a name="line-158"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreeIter</span> <a name="line-159"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreeIter</span> <a name="line-160"></a><span class='hs-definition'>treeModelSortConvertChildIterToIter</span> <span class='hs-varid'>self</span> <span class='hs-varid'>childIter</span> <span class='hs-keyglyph'>=</span> <a name="line-161"></a> <span class='hs-varid'>with</span> <span class='hs-varid'>childIter</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>childIterPtr</span> <span class='hs-keyglyph'>-></span> <a name="line-162"></a> <span class='hs-varid'>alloca</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>sortIterPtr</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <a name="line-163"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_convert_child_iter_to_iter</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span><span class='hs-layout'>)</span> <a name="line-164"></a><span class='hs-comment'>{-# LINE 155 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-165"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-166"></a> <span class='hs-varid'>sortIterPtr</span> <a name="line-167"></a> <span class='hs-varid'>childIterPtr</span> <a name="line-168"></a> <span class='hs-varid'>peek</span> <span class='hs-varid'>sortIterPtr</span> <a name="line-169"></a> <a name="line-170"></a><a name="treeModelSortConvertIterToChildIter"></a><span class='hs-comment'>-- | Return an iterator in the unsorted model that points to the row pointed to</span> <a name="line-171"></a><span class='hs-comment'>-- by the given iter from the sorted model.</span> <a name="line-172"></a><span class='hs-comment'>--</span> <a name="line-173"></a><span class='hs-definition'>treeModelSortConvertIterToChildIter</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <a name="line-174"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreeIter</span> <a name="line-175"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreeIter</span> <a name="line-176"></a><span class='hs-definition'>treeModelSortConvertIterToChildIter</span> <span class='hs-varid'>self</span> <span class='hs-varid'>sortedIter</span> <span class='hs-keyglyph'>=</span> <a name="line-177"></a> <span class='hs-varid'>with</span> <span class='hs-varid'>sortedIter</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>sortedIterPtr</span> <span class='hs-keyglyph'>-></span> <a name="line-178"></a> <span class='hs-varid'>alloca</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>childIterPtr</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <a name="line-179"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_convert_iter_to_child_iter</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span><span class='hs-layout'>)</span> <a name="line-180"></a><span class='hs-comment'>{-# LINE 170 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-181"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-182"></a> <span class='hs-varid'>childIterPtr</span> <a name="line-183"></a> <span class='hs-varid'>sortedIterPtr</span> <a name="line-184"></a> <span class='hs-varid'>peek</span> <span class='hs-varid'>childIterPtr</span> <a name="line-185"></a> <a name="line-186"></a><a name="treeModelSortResetDefaultSortFunc"></a><span class='hs-comment'>-- | This resets the default sort function. As a consequence, the order of</span> <a name="line-187"></a><span class='hs-comment'>-- this model will be the same order as that of the child model.</span> <a name="line-188"></a><span class='hs-comment'>--</span> <a name="line-189"></a><span class='hs-definition'>treeModelSortResetDefaultSortFunc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-190"></a><span class='hs-definition'>treeModelSortResetDefaultSortFunc</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span> <a name="line-191"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_reset_default_sort_func</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span> <a name="line-192"></a><span class='hs-comment'>{-# LINE 181 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-193"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-194"></a> <a name="line-195"></a><a name="treeModelSortClearCache"></a><span class='hs-comment'>-- | Clear the cache of unref'd iterators.</span> <a name="line-196"></a><span class='hs-comment'>--</span> <a name="line-197"></a><span class='hs-comment'>-- * This function should almost never be called. It clears the</span> <a name="line-198"></a><span class='hs-comment'>-- 'TreeModelSort' of any cached iterators that haven't been reffed with</span> <a name="line-199"></a><span class='hs-comment'>-- 'treeModelRefNode'. This might be useful if the child model being sorted is</span> <a name="line-200"></a><span class='hs-comment'>-- static (and doesn't change often) and there has been a lot of unreffed</span> <a name="line-201"></a><span class='hs-comment'>-- access to nodes. As a side effect of this function, all unreffed iters will</span> <a name="line-202"></a><span class='hs-comment'>-- be invalid.</span> <a name="line-203"></a><span class='hs-comment'>--</span> <a name="line-204"></a><span class='hs-definition'>treeModelSortClearCache</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-205"></a><span class='hs-definition'>treeModelSortClearCache</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span> <a name="line-206"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_clear_cache</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span> <a name="line-207"></a><span class='hs-comment'>{-# LINE 195 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-208"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-209"></a> <a name="line-210"></a> <a name="line-211"></a><a name="treeModelSortIterIsValid"></a><span class='hs-comment'>-- | Checks if the given iter is a valid iter for this 'TreeModelSort'.</span> <a name="line-212"></a><span class='hs-comment'>--</span> <a name="line-213"></a><span class='hs-comment'>-- * WARNING: This function is slow. Only use it for debugging and\/or testing</span> <a name="line-214"></a><span class='hs-comment'>-- purposes.</span> <a name="line-215"></a><span class='hs-comment'>--</span> <a name="line-216"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.2</span> <a name="line-217"></a><span class='hs-comment'>--</span> <a name="line-218"></a><span class='hs-definition'>treeModelSortIterIsValid</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelSortClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <a name="line-219"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreeIter</span> <span class='hs-comment'>-- ^ @iter@ - A 'TreeIter'.</span> <a name="line-220"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span> <span class='hs-comment'>-- ^ returns @True@ if the iter is valid, @False@ if the iter is</span> <a name="line-221"></a> <span class='hs-comment'>-- invalid.</span> <a name="line-222"></a><span class='hs-definition'>treeModelSortIterIsValid</span> <span class='hs-varid'>self</span> <span class='hs-varid'>iter</span> <span class='hs-keyglyph'>=</span> <a name="line-223"></a> <span class='hs-varid'>liftM</span> <span class='hs-varid'>toBool</span> <span class='hs-varop'>$</span> <a name="line-224"></a> <span class='hs-varid'>with</span> <span class='hs-varid'>iter</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>iterPtr</span> <span class='hs-keyglyph'>-></span> <a name="line-225"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeModelSort</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tree_model_sort_iter_is_valid</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <a name="line-226"></a><span class='hs-comment'>{-# LINE 213 "./Graphics/UI/Gtk/ModelView/TreeModelSort.chs" #-}</span> <a name="line-227"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModelSort</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <a name="line-228"></a> <span class='hs-varid'>iterPtr</span> <a name="line-229"></a> <a name="line-230"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_new_with_model"</span> <a name="line-231"></a> <span class='hs-varid'>gtk_tree_model_sort_new_with_model</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModel</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModel</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-232"></a> <a name="line-233"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_get_model"</span> <a name="line-234"></a> <span class='hs-varid'>gtk_tree_model_sort_get_model</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModel</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-235"></a> <a name="line-236"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_convert_child_path_to_path"</span> <a name="line-237"></a> <span class='hs-varid'>gtk_tree_model_sort_convert_child_path_to_path</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>NativeTreePath</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>NativeTreePath</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-238"></a> <a name="line-239"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_convert_path_to_child_path"</span> <a name="line-240"></a> <span class='hs-varid'>gtk_tree_model_sort_convert_path_to_child_path</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>NativeTreePath</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>NativeTreePath</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-241"></a> <a name="line-242"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_convert_child_iter_to_iter"</span> <a name="line-243"></a> <span class='hs-varid'>gtk_tree_model_sort_convert_child_iter_to_iter</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeIter</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeIter</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-244"></a> <a name="line-245"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_convert_iter_to_child_iter"</span> <a name="line-246"></a> <span class='hs-varid'>gtk_tree_model_sort_convert_iter_to_child_iter</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeIter</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeIter</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-247"></a> <a name="line-248"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_reset_default_sort_func"</span> <a name="line-249"></a> <span class='hs-varid'>gtk_tree_model_sort_reset_default_sort_func</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-250"></a> <a name="line-251"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_clear_cache"</span> <a name="line-252"></a> <span class='hs-varid'>gtk_tree_model_sort_clear_cache</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-253"></a> <a name="line-254"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_tree_model_sort_iter_is_valid"</span> <a name="line-255"></a> <span class='hs-varid'>gtk_tree_model_sort_iter_is_valid</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeModelSort</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>TreeIter</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> </pre></body> </html>