<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.ModelView.TreeModel</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-ModelView-TreeModel.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.ModelView.TreeModel</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Constructors
</a></li><li><a href="#g:5">Methods
</a></li><li><a href="#g:6">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The tree interface used by <code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code>.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:TreeModel">TreeModel</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:TreeModelClass">TreeModelClass</a> o </li><li class="src short"><a href="#v:castToTreeModel">castToTreeModel</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></li><li class="src short"><a href="#v:gTypeTreeModel">gTypeTreeModel</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toTreeModel">toTreeModel</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:TypedTreeModel">TypedTreeModel</a> row</li><li class="src short"><span class="keyword">class</span> <a href="#t:TypedTreeModelClass">TypedTreeModelClass</a> model </li><li class="src short"><a href="#v:toTypedTreeModel">toTypedTreeModel</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> model => model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModel">TypedTreeModel</a> row</li><li class="src short"><span class="keyword">data</span> <a href="#t:TreeIter">TreeIter</a> = <a href="#v:TreeIter">TreeIter</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-C-Types.html#t:CInt">CInt</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:TreePath">TreePath</a> = [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:ColumnId">ColumnId</a> row ty</li><li class="src short"><a href="#v:makeColumnIdInt">makeColumnIdInt</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:makeColumnIdBool">makeColumnIdBool</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:makeColumnIdString">makeColumnIdString</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:makeColumnIdPixbuf">makeColumnIdPixbuf</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:invalidColumnId">invalidColumnId</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty</li><li class="src short"><a href="#v:columnIdToNumber">columnIdToNumber</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:stringToTreePath">stringToTreePath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></li><li class="src short"><a href="#v:treeModelGetFlags">treeModelGetFlags</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelFlags">TreeModelFlags</a>]</li><li class="src short"><a href="#v:treeModelGetIter">treeModelGetIter</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelGetIterFromString">treeModelGetIterFromString</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelGetIterFirst">treeModelGetIterFirst</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelGetPath">treeModelGetPath</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></li><li class="src short"><a href="#v:treeModelGetValue">treeModelGetValue</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> ty</li><li class="src short"><a href="#v:treeModelIterNext">treeModelIterNext</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelIterChildren">treeModelIterChildren</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelIterHasChild">treeModelIterHasChild</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:treeModelIterNChildren">treeModelIterNChildren</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:treeModelIterNthChild">treeModelIterNthChild</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelIterParent">treeModelIterParent</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li class="src short"><a href="#v:treeModelForeach">treeModelForeach</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelGetStringFromIter">treeModelGetStringFromIter</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:treeModelRefNode">treeModelRefNode</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelUnrefNode">treeModelUnrefNode</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelRowChanged">treeModelRowChanged</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelRowInserted">treeModelRowInserted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelRowHasChildToggled">treeModelRowHasChildToggled</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelRowDeleted">treeModelRowDeleted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:treeModelRowsReordered">treeModelRowsReordered</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:rowChanged">rowChanged</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:rowInserted">rowInserted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:rowHasChildToggled">rowHasChildToggled</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:rowDeleted">rowDeleted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:rowsReordered">rowsReordered</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> interface defines a generic storage object for use by the
<code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code> and similar widgets. Specifically, the functions in defined here
are used by Gtk's widgets to access the stored data. Thus, rather than
calling these functions, an application programmer has to implement them.
While the module <a href="Graphics-UI-Gtk-ModelView-CustomStore.html">Graphics.UI.Gtk.ModelView.CustomStore</a> provides the
necessary functions to implement the <code>TreeMode</code> interface, it is often
sufficient to use the wo implementations that come with Gtk2Hs, namely are
<code>ListStore</code> and <code>TreeStore</code>.
</p><p>The model is represented as a hierarchical tree of values. It is important
to note that this interface only provides a way of examining a model and
observing changes. The implementation of each individual model decides how
and if changes are made.
</p><p>Two generic models are provided that implement the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> interface:
the <code>TreeStore</code> and the <code>ListStore</code>. To use these, the developer simply
inserts data into these models as necessary. These models provide the data
structure as well as the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> interface. In fact, they implement
other interfaces, making drag and drop and storing data trivial.
</p><p>A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> stores records of the same type. Each record is referred to
as row, just like in a relational database. Defining how the information of
a row is displayed can be done in two ways: If the widget displays data
using <code>Graphics.UI.Gtk.ModelView.CellRenderer.CellRenderer</code> or one of its
derivatives, it is possible to state how a row is mapped to the attributes
of a renderer using the
<code>Graphics.UI.Gtk.ModelView.CellLayout.cellLayoutSetAttributes</code> function.
Some widgets do not use
<code>Graphics.UI.Gtk.ModelView.CellRenderer.CellRenderer</code>s to display their
data. In this case an extraction function can be defined that maps a row to
one of a few basic types (like <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></code>s or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></code>s). This extraction
function is associated with a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> using
<code>Graphics.UI.Gtk.ModelView.CustomStore.treeModelSetColumn</code>. The latter can
be set in the widget for the property that should be set. The widget then
uses the function <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:treeModelGetValue">treeModelGetValue</a></code> and the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to extract the
value from the model. As the name suggests, using <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code>s creates a
view of the data as if each row were divided into a well-defined set of
columns, again, like a relational database.
</p><p>Models are accessed on a node level of granularity. There are two index
types used to reference a particular node in a model. They are the
<code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> and the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>. Most of the interface consists of operations
on a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p><p>A path is essentially a potential node. It is a location on a model that
may or may not actually correspond to a node on a specific model. A
<code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> is in fact a synonym for a list of <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></code>s and hence are easy to
manipulate. Each number refers to the offset at that level. Thus, the path
<code>[0]</code> refers to the root node and the path <code>[2,4]</code> refers to the fifth
child of the third node.
</p><p>By contrast, a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> is a reference to a specific node on a specific
model. It is an abstract data type filled in by the model. One can convert
a path to an iterator by calling <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:treeModelGetIter">treeModelGetIter</a></code>. These iterators are
the primary way of accessing a model and are similar to the iterators used
by <code><a href="Graphics-UI-Gtk-Multiline-TextBuffer.html#t:TextBuffer">TextBuffer</a></code>. The model interface defines a set of operations using them
for navigating the model. Iterators are expected to always be valid for as
long as the model is unchanged (and doesn't emit a signal).
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| GInterface
| +----TreeModel
| +--------TypedTreeModel
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TreeModel" class="def">TreeModel</a> <a href="src/Graphics-UI-Gtk-Types.html#TreeModel" class="link">Source</a></p><div class="subs instances"><p id="control.i:TreeModel" class="caption collapser" onclick="toggleSection('i:TreeModel')">Instances</p><div id="section.i:TreeModel" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:TreeModelClass" class="def">TreeModelClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#TreeModelClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:TreeModelClass" class="caption collapser" onclick="toggleSection('i:TreeModelClass')">Instances</p><div id="section.i:TreeModelClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> ListStore</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> TreeStore</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (TypedTreeModelFilter a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (<a href="Graphics-UI-Gtk-ModelView-TreeModelSort.html#t:TypedTreeModelSort">TypedTreeModelSort</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (<a href="Graphics-UI-Gtk-ModelView-ListStore.html#t:ListStore">ListStore</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (<a href="Graphics-UI-Gtk-ModelView-TreeStore.html#t:TreeStore">TreeStore</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (<a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToTreeModel" class="def">castToTreeModel</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a><a href="src/Graphics-UI-Gtk-Types.html#castToTreeModel" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeTreeModel" class="def">gTypeTreeModel</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeTreeModel" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toTreeModel" class="def">toTreeModel</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a><a href="src/Graphics-UI-Gtk-Types.html#toTreeModel" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TypedTreeModel" class="def">TypedTreeModel</a> row <a href="src/Graphics-UI-Gtk-ModelView-Types.html#TypedTreeModel" class="link">Source</a></p><div class="subs instances"><p id="control.i:TypedTreeModel" class="caption collapser" onclick="toggleSection('i:TypedTreeModel')">Instances</p><div id="section.i:TypedTreeModel" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModel">TypedTreeModel</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:TypedTreeModelClass" class="def">TypedTreeModelClass</a> model <a href="src/Graphics-UI-Gtk-ModelView-Types.html#TypedTreeModelClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:TypedTreeModelClass" class="caption collapser" onclick="toggleSection('i:TypedTreeModelClass')">Instances</p><div id="section.i:TypedTreeModelClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> TypedTreeModelFilter</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModelSort.html#t:TypedTreeModelSort">TypedTreeModelSort</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModel">TypedTreeModel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-ListStore.html#t:ListStore">ListStore</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> <a href="Graphics-UI-Gtk-ModelView-TreeStore.html#t:TreeStore">TreeStore</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:toTypedTreeModel" class="def">toTypedTreeModel</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> model => model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModel">TypedTreeModel</a> row<a href="src/Graphics-UI-Gtk-ModelView-Types.html#toTypedTreeModel" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TreeIter" class="def">TreeIter</a> <a href="src/Graphics-UI-Gtk-ModelView-Types.html#TreeIter" class="link">Source</a></p><div class="doc"><p>Tree Iterator: a pointer to an entry in a
<code>Graphics.UI.Gtk.ModelView.TreeModel</code>. The constructor of this structure is
public for the sake of creating custom tree models. The first value is a
time stamp that is handled by the functions that interface with Gtk. The
time stamps are used to print warnings if programmers use an iter to a
model that has changed meanwhile. The other three fields are used by the
custom model implementation to implement an indexing scheme. The precise
use of the three words is therefore implementation specific. See also
<code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TreeIter" class="def">TreeIter</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-C-Types.html#t:CInt">CInt</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a> !<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Word.html#t:Word">Word</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:TreeIter" class="caption collapser" onclick="toggleSection('i:TreeIter')">Instances</p><div id="section.i:TreeIter" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Foreign-Storable.html#t:Storable">Storable</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:TreePath" class="def">TreePath</a> = [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>]<a href="src/Graphics-UI-Gtk-ModelView-Types.html#TreePath" class="link">Source</a></p><div class="doc"><p>TreePath : a list of indices to specify a subtree or node in a
<code>Graphics.UI.Gtk.ModelView.TreeModel.TreeModel</code>. The node that correspond
to a given <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> might change if nodes are removed or added and a
<code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> may refer to a different or even non-existent node after a
modification of the model. In contrast, a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> is a more compact
representation of a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> which becomes invalid after each
modification of the underlying model. An intelligent index that is adjusted
with each update of the model to point to the same node (whenever possible)
is <code>Graphics.UI.Gtk.ModelView.TreeRowReference.TreeRowReference</code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ColumnId" class="def">ColumnId</a> row ty <a href="src/Graphics-UI-Gtk-ModelView-Types.html#ColumnId" class="link">Source</a></p><div class="doc"><p>The type of a tree column.
</p></div><div class="subs instances"><p id="control.i:ColumnId" class="caption collapser" onclick="toggleSection('i:ColumnId')">Instances</p><div id="section.i:ColumnId" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:makeColumnIdInt" class="def">makeColumnIdInt</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#makeColumnIdInt" class="link">Source</a></p><div class="doc"><p>Create a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to extract an integer.
</p></div></div><div class="top"><p class="src"><a name="v:makeColumnIdBool" class="def">makeColumnIdBool</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#makeColumnIdBool" class="link">Source</a></p><div class="doc"><p>Create a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to extract an Boolean.
</p></div></div><div class="top"><p class="src"><a name="v:makeColumnIdString" class="def">makeColumnIdString</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#makeColumnIdString" class="link">Source</a></p><div class="doc"><p>Create a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to extract an string.
</p></div></div><div class="top"><p class="src"><a name="v:makeColumnIdPixbuf" class="def">makeColumnIdPixbuf</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#makeColumnIdPixbuf" class="link">Source</a></p><div class="doc"><p>Create a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to extract an <code><a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:invalidColumnId" class="def">invalidColumnId</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#invalidColumnId" class="link">Source</a></p><div class="doc"><p>The invalid <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code>. Widgets use this value if no column id has
been set.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:columnIdToNumber" class="def">columnIdToNumber</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#columnIdToNumber" class="link">Source</a></p><div class="doc"><p>Convert a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a></code> to a bare number.
</p></div></div><div class="top"><p class="src"><a name="v:stringToTreePath" class="def">stringToTreePath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a><a href="src/Graphics-UI-Gtk-ModelView-Types.html#stringToTreePath" class="link">Source</a></p><div class="doc"><p>Convert a comma or colon separated string into a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code>. Any
non-digit characters are assumed to separate indices, thus, the function
always is always successful.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetFlags" class="def">treeModelGetFlags</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelFlags">TreeModelFlags</a>]<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetFlags" class="link">Source</a></p><div class="doc"><p>Returns a set of flags supported by this interface.
</p><p>The flags supported should not
change during the lifecycle of the tree_model.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetIter" class="def">treeModelGetIter</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetIter" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Turn a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> into a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p><p>Returns <code>Nothing</code> if the given <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> was invalid. The empty list
is always invalid. The root node of a tree can be accessed by passing
<code>[0]</code> as <code>path</code>.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetIterFromString" class="def">treeModelGetIterFromString</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetIterFromString" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>pathString</code> - A string representation of a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Turn a <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></code> into a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p><ul><li> Returns <code>Nothing</code> if the string is not a colon separated list of numbers
that references a valid node.
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelGetIterFirst" class="def">treeModelGetIterFirst</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetIterFirst" class="link">Source</a></p><div class="doc"><p>Retrieves an <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> to the first entry.
</p><p>Returns <code>Nothing</code> if the table is empty.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetPath" class="def">treeModelGetPath</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetPath" class="link">Source</a></p><div class="doc"><p>Turn an abstract <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> into a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code>.
</p><p>In case the given <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> was invalid, an empty list is returned.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetValue" class="def">treeModelGetValue</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetValue" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:ColumnId">ColumnId</a> row ty</td><td class="doc"><p><code>column</code> - The column to lookup the value at.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> ty</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Read the value of at a specific column and <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterNext" class="def">treeModelIterNext</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterNext" class="link">Source</a></p><div class="doc"><p>Retrieve an iterator to the node following it at the current level. If
there is no next node, <code>Nothing</code> is returned.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterChildren" class="def">treeModelIterChildren</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterChildren" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>parent</code> - a pointer to the parent
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Retrieve an iterator to the first child of <code>parent</code>. If <code>parent</code> has no
children, <code>Nothing</code>.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterHasChild" class="def">treeModelIterHasChild</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterHasChild" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> to test for children.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if <code>iter</code> has children.
</p></td></tr></table></div><div class="doc"><p>Returns <code>True</code> if <code>iter</code> has children, <code>False</code> otherwise.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterNChildren" class="def">treeModelIterNChildren</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterNChildren" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>, or <code>Nothing</code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>returns The number of children of <code>iter</code>.
</p></td></tr></table></div><div class="doc"><p>Returns the number of children that <code>iter</code> has. As a special case, if
<code>iter</code> is <code>Nothing</code>, then the number of toplevel nodes is returned.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterNthChild" class="def">treeModelIterNthChild</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterNthChild" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>parent</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> to get the child from, or
<code>Nothing</code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>n</code> - Then index of the desired child.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Retrieve the <code>n</code>th child of <code>parent</code>, counting from zero. If <code>n</code> is too
big or <code>parent</code> has no children, <code>Nothing</code> is returned. If <code>Nothing</code> is
specified for the <code>parent</code> argument, the function will return the <code>n</code>th
root node.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelIterParent" class="def">treeModelIterParent</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelIterParent" class="link">Source</a></p><div class="doc"><p>Retrieve the parent of this iterator.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelForeach" class="def">treeModelForeach</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => self -> (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelForeach" class="link">Source</a></p><div class="doc"><p>Maps a function over each node in model in a depth-first fashion. If it
returns <code>True</code>, then the tree ceases to be walked, and <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:treeModelForeach">treeModelForeach</a></code>
returns.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelGetStringFromIter" class="def">treeModelGetStringFromIter</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelGetStringFromIter" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - An <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>the returned string representation
</p></td></tr></table></div><div class="doc"><p>Generates a string representation of the iter. This string is a ':'
separated list of numbers. For example, "4:10:0:3" would be an acceptable
return value for this string.
</p><ul><li> Available since Gtk+ version 2.2
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelRefNode" class="def">treeModelRefNode</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRefNode" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Lets the tree ref the node. This is an optional method for models to
implement. To be more specific, models may ignore this call as it exists
primarily for performance reasons.
</p><p>This function is primarily meant as a way for views to let caching model
know when nodes are being displayed (and hence, whether or not to cache that
node.) For example, a file-system based model would not want to keep the
entire file-hierarchy in memory, just the sections that are currently being
displayed by every current view.
</p><p>A model should be expected to be able to get an iter independent of its
reffed state.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelUnrefNode" class="def">treeModelUnrefNode</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelUnrefNode" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - The <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Lets the tree unref the node. This is an optional method for models to
implement. To be more specific, models may ignore this call as it exists
primarily for performance reasons.
</p><p>For more information on what this means, see <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:treeModelRefNode">treeModelRefNode</a></code>. Please
note that nodes that are deleted are not unreffed.
</p></div></div><div class="top"><p class="src"><a name="v:treeModelRowChanged" class="def">treeModelRowChanged</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRowChanged" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> pointing to the changed row
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - A valid <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> pointing to the changed row
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Emits the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowChanged">rowChanged</a></code> signal on the model.
</p><ul><li> This function is only necessary to implement a custom tree model. When
using <code>Graphics.UI.Gtk.ModelView.ListStore</code> or
<code>Graphics.UI.Gtk.ModelView.TreeStore</code>, this function is called
automatically.
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelRowInserted" class="def">treeModelRowInserted</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRowInserted" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> pointing to the inserted row
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - A valid <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> pointing to the inserted row
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Emits the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowInserted">rowInserted</a></code> signal on the model.
</p><ul><li> This function is only necessary to implement a custom tree model. When
using <code>Graphics.UI.Gtk.ModelView.ListStore</code> or
<code>Graphics.UI.Gtk.ModelView.TreeStore</code>, this function is called
automatically.
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelRowHasChildToggled" class="def">treeModelRowHasChildToggled</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRowHasChildToggled" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> pointing to the changed row
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - A valid <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> pointing to the changed row
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Emits the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowHasChildToggled">rowHasChildToggled</a></code> signal on the model. This should be
called by models after the child state of a node changes.
</p><ul><li> This function is only necessary to implement a custom tree model. When
using <code>Graphics.UI.Gtk.ModelView.ListStore</code> or
<code>Graphics.UI.Gtk.ModelView.TreeStore</code>, this function is called
automatically.
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelRowDeleted" class="def">treeModelRowDeleted</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRowDeleted" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> pointing to the previous location of
the deleted row.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Emits the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowDeleted">rowDeleted</a></code> signal on the model. This should be called by
models after a row has been removed. The location pointed to by <code>path</code>
should be the location that the row previously was at. It may not be a
valid location anymore.
</p><ul><li> This function is only necessary to implement a custom tree model. When
using <code>Graphics.UI.Gtk.ModelView.ListStore</code> or
<code>Graphics.UI.Gtk.ModelView.TreeStore</code>, this function is called
automatically.
</li></ul></div></div><div class="top"><p class="src"><a name="v:treeModelRowsReordered" class="def">treeModelRowsReordered</a><a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#treeModelRowsReordered" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></td><td class="doc"><p><code>path</code> - A <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></code> pointing to the tree node whose
children have been reordered
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></td><td class="doc"><p><code>iter</code> - A valid <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> pointing to the node whose
children have been reordered, or <code>Nothing</code> if
<code>path</code> is <code>[]</code>.
</p></td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>]</td><td class="doc"><p><code>newOrder</code> - a list of integers giving the previous position
of each node at this hierarchy level.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Emits the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowsReordered">rowsReordered</a></code> signal on the model. This should be called by
models when their rows have been reordered. The length of <code>newOrder</code> must
be equal to the value returned by <code>treeModelIterNChildren self iter</code>.
</p><ul><li> This function is only necessary to implement a custom tree model. When
using <code>Graphics.UI.Gtk.ModelView.ListStore</code> or
<code>Graphics.UI.Gtk.ModelView.TreeStore</code>, this function is called
automatically.
</li></ul></div></div><h1 id="g:6">Signals
</h1><div class="top"><p class="src"><a name="v:rowChanged" class="def">rowChanged</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#rowChanged" class="link">Source</a></p><div class="doc"><p>This signal is emitted when a row in the model has changed.
</p></div></div><div class="top"><p class="src"><a name="v:rowInserted" class="def">rowInserted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#rowInserted" class="link">Source</a></p><div class="doc"><p>This signal is emitted when a new row has been inserted in the model.
</p></div></div><div class="top"><p class="src"><a name="v:rowHasChildToggled" class="def">rowHasChildToggled</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#rowHasChildToggled" class="link">Source</a></p><div class="doc"><p>This signal is emitted when a row has gotten the first child row or lost
its last child row.
</p></div></div><div class="top"><p class="src"><a name="v:rowDeleted" class="def">rowDeleted</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#rowDeleted" class="link">Source</a></p><div class="doc"><p>This signal is emitted when a row has been deleted.
</p><p>Note that no iterator is passed to the signal handler, since the row is
already deleted.
</p><p>Implementations of <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> must emit row-deleted <em>before</em> removing the
node from its internal data structures. This is because models and views
which access and monitor this model might have references on the node which
need to be released in the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:rowDeleted">rowDeleted</a></code> handler.
</p></div></div><div class="top"><p class="src"><a name="v:rowsReordered" class="def">rowsReordered</a> :: <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-ModelView-TreeModel.html#rowsReordered" class="link">Source</a></p><div class="doc"><p>This signal is emitted when the children of a node in the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code>
have been reordered. See <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#v:treeModelRowsReordered">treeModelRowsReordered</a></code> for more information
about the parameters that this signal carries.
</p><p>Note that this signal is <em>not</em> emitted when rows are reordered by DND,
since this is implemented by removing and then reinserting the row.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
