<?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/TreeRowReference.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/TreeRowReference.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) Class TreeRowReference</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: 14 April 2005</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Copyright (C) 2005 Axel Simon, Duncan Coutts</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 persistent index into a tree model.</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'>TreeRowReference</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'>-- | A 'RowReference' is an index into a</span>
<a name="line-33"></a><span class='hs-comment'>-- 'Graphics.UI.Gtk.ModelView.TreeModel.TreeModel' that is persistent even if</span>
<a name="line-34"></a><span class='hs-comment'>-- rows are inserted, deleted or reordered.</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a>
<a name="line-37"></a><span class='hs-comment'>-- * Types</span>
<a name="line-38"></a> <span class='hs-conid'>TreeRowReference</span><span class='hs-layout'>,</span>
<a name="line-39"></a>
<a name="line-40"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-41"></a> <span class='hs-varid'>treeRowReferenceNew</span><span class='hs-layout'>,</span>
<a name="line-42"></a>
<a name="line-43"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-44"></a> <span class='hs-varid'>treeRowReferenceGetPath</span><span class='hs-layout'>,</span>
<a name="line-45"></a> <span class='hs-varid'>treeRowReferenceValid</span><span class='hs-layout'>,</span>
<a name="line-46"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-47"></a>
<a name="line-48"></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-49"></a>
<a name="line-50"></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-51"></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-52"></a><span class='hs-comment'>{-# LINE 51 "./Graphics/UI/Gtk/ModelView/TreeRowReference.chs" #-}</span>
<a name="line-53"></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-54"></a><span class='hs-comment'>{-# LINE 52 "./Graphics/UI/Gtk/ModelView/TreeRowReference.chs" #-}</span>
<a name="line-55"></a>
<a name="line-56"></a>
<a name="line-57"></a><span class='hs-comment'>{-# LINE 54 "./Graphics/UI/Gtk/ModelView/TreeRowReference.chs" #-}</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="TreeRowReference"></a><span class='hs-comment'>-- | Tree Row Reference : like a 'TreePath' it points to a subtree or node, but</span>
<a name="line-60"></a><a name="TreeRowReference"></a><span class='hs-comment'>-- it is persistent. It identifies the same node (so long as it exists) even</span>
<a name="line-61"></a><a name="TreeRowReference"></a><span class='hs-comment'>-- when items are added, removed, or reordered.</span>
<a name="line-62"></a><a name="TreeRowReference"></a><span class='hs-comment'>--</span>
<a name="line-63"></a><a name="TreeRowReference"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>TreeRowReference</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TreeRowReference</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-layout'>(</span><span class='hs-conid'>TreeRowReference</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-64"></a><span class='hs-comment'>{-# LINE 60 "./Graphics/UI/Gtk/ModelView/TreeRowReference.chs" #-}</span>
<a name="line-65"></a>
<a name="line-66"></a><span class='hs-comment'>--------------------</span>
<a name="line-67"></a><span class='hs-comment'>-- Constructors</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="treeRowReferenceNew"></a><span class='hs-comment'>-- | Creates a row reference based on a path. This reference will keep pointing</span>
<a name="line-70"></a><span class='hs-comment'>-- to the node pointed to by the given path, so long as it exists. Returns @Nothing@ if there is no node at the given path.</span>
<a name="line-71"></a><span class='hs-comment'>--</span>
<a name="line-72"></a><span class='hs-definition'>treeRowReferenceNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeModelClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-73"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TreePath</span>
<a name="line-74"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>TreeRowReference</span><span class='hs-layout'>)</span>
<a name="line-75"></a><span class='hs-definition'>treeRowReferenceNew</span> <span class='hs-varid'>self</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withTreePath</span> <span class='hs-varid'>path</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>path</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-76"></a> <span class='hs-varid'>rowRefPtr</span> <span class='hs-keyglyph'><-</span>
<a name="line-77"></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-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_row_reference_new</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>toTreeModel</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span> <span class='hs-varid'>path</span>
<a name="line-78"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>rowRefPtr</span><span class='hs-varop'>==</span><span class='hs-varid'>nullPtr</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyword'>else</span>
<a name="line-79"></a> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TreeRowReference</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-80"></a> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>rowRefPtr</span> <span class='hs-varid'>tree_row_reference_free</span>
<a name="line-81"></a>
<a name="line-82"></a><span class='hs-comment'>--------------------</span>
<a name="line-83"></a><span class='hs-comment'>-- Methods</span>
<a name="line-84"></a>
<a name="line-85"></a><a name="treeRowReferenceGetPath"></a><span class='hs-comment'>-- | Returns a path that the row reference currently points to.</span>
<a name="line-86"></a><span class='hs-comment'>--</span>
<a name="line-87"></a><span class='hs-comment'>-- * The returned path may be the empty list if the reference was invalid.</span>
<a name="line-88"></a><span class='hs-comment'>--</span>
<a name="line-89"></a><span class='hs-definition'>treeRowReferenceGetPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeRowReference</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>TreePath</span>
<a name="line-90"></a><span class='hs-definition'>treeRowReferenceGetPath</span> <span class='hs-varid'>ref</span> <span class='hs-keyglyph'>=</span>
<a name="line-91"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeRowReference</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_row_reference_get_path</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span> <span class='hs-varid'>ref</span>
<a name="line-92"></a> <span class='hs-varop'>>>=</span> <span class='hs-varid'>fromTreePath</span> <span class='hs-comment'>-- path must be freed</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="treeRowReferenceValid"></a><span class='hs-comment'>-- | Returns True if the reference refers to a current valid path.</span>
<a name="line-95"></a><span class='hs-comment'>--</span>
<a name="line-96"></a><span class='hs-definition'>treeRowReferenceValid</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TreeRowReference</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-97"></a><span class='hs-definition'>treeRowReferenceValid</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=</span>
<a name="line-98"></a> <span class='hs-varid'>liftM</span> <span class='hs-varid'>toBool</span> <span class='hs-varop'>$</span>
<a name="line-99"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>TreeRowReference</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_row_reference_valid</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-100"></a><span class='hs-comment'>{-# LINE 95 "./Graphics/UI/Gtk/ModelView/TreeRowReference.chs" #-}</span>
<a name="line-101"></a> <span class='hs-varid'>self</span>
<a name="line-102"></a>
<a name="line-103"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"&gtk_tree_row_reference_free"</span>
<a name="line-104"></a> <span class='hs-varid'>tree_row_reference_free</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FinalizerPtr</span> <span class='hs-conid'>TreeRowReference</span>
<a name="line-105"></a>
<a name="line-106"></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_row_reference_new"</span>
<a name="line-107"></a> <span class='hs-varid'>gtk_tree_row_reference_new</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-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'>TreeRowReference</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-108"></a>
<a name="line-109"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"gtk_tree_row_reference_get_path"</span>
<a name="line-110"></a> <span class='hs-varid'>gtk_tree_row_reference_get_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'>TreeRowReference</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>
<a name="line-111"></a>
<a name="line-112"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"gtk_tree_row_reference_valid"</span>
<a name="line-113"></a> <span class='hs-varid'>gtk_tree_row_reference_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'>TreeRowReference</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>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
677c1b5134368504c2e447757584d19e
>
files
>
1091
