<!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.CustomStore</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-CustomStore.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-ModelView-CustomStore.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.CustomStore</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">The definition of a row-based store.
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Allows a custom data structure to be used with the <code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code> and other
widgets that follow the model-view-controller paradigm. The two models
<code>Graphics.UI.Gtk.ModelView.ListStore.ListStore</code> and
<code>Graphics.UI.Gtk.ModelView.TreeStore.TreeStore</code> are based on the
<code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a></code>. Even if no application-specific tree model
should be implemented, this module is relevant in that it provides the
functions <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#v:customStoreSetColumn">customStoreSetColumn</a></code> and
<code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#v:customStoreGetRow">customStoreGetRow</a></code> functions.
</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:CustomStore">CustomStore</a> private row</li><li class="src short"><span class="keyword">data</span> <a href="#t:TreeModelFlags">TreeModelFlags</a> <ul class="subs"><li>= <a href="#v:TreeModelItersPersist">TreeModelItersPersist</a> </li><li>| <a href="#v:TreeModelListOnly">TreeModelListOnly</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:TreeModelIface">TreeModelIface</a> row = <a href="#v:TreeModelIface">TreeModelIface</a> {<ul class="subs"><li><a href="#v:treeModelIfaceGetFlags">treeModelIfaceGetFlags</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-CustomStore.html#t:TreeModelFlags">TreeModelFlags</a>]</li><li><a href="#v:treeModelIfaceGetIter">treeModelIfaceGetIter</a> :: <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><a href="#v:treeModelIfaceGetPath">treeModelIfaceGetPath</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="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></li><li><a href="#v:treeModelIfaceGetRow">treeModelIfaceGetRow</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> row</li><li><a href="#v:treeModelIfaceIterNext">treeModelIfaceIterNext</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li><a href="#v:treeModelIfaceIterChildren">treeModelIfaceIterChildren</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/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><a href="#v:treeModelIfaceIterHasChild">treeModelIfaceIterHasChild</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-Bool.html#t:Bool">Bool</a></li><li><a href="#v:treeModelIfaceIterNChildren">treeModelIfaceIterNChildren</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/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><a href="#v:treeModelIfaceIterNthChild">treeModelIfaceIterNthChild</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/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><a href="#v:treeModelIfaceIterParent">treeModelIfaceIterParent</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</li><li><a href="#v:treeModelIfaceRefNode">treeModelIfaceRefNode</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><a href="#v:treeModelIfaceUnrefNode">treeModelIfaceUnrefNode</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></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:DragSourceIface">DragSourceIface</a> model row = <a href="#v:DragSourceIface">DragSourceIface</a> {<ul class="subs"><li><a href="#v:treeDragSourceRowDraggable">treeDragSourceRowDraggable</a> :: model row -> <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-Bool.html#t:Bool">Bool</a></li><li><a href="#v:treeDragSourceDragDataGet">treeDragSourceDragDataGet</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:treeDragSourceDragDataDelete">treeDragSourceDragDataDelete</a> :: model row -> <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-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:DragDestIface">DragDestIface</a> model row = <a href="#v:DragDestIface">DragDestIface</a> {<ul class="subs"><li><a href="#v:treeDragDestRowDropPossible">treeDragDestRowDropPossible</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:treeDragDestDragDataReceived">treeDragDestDragDataReceived</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><a href="#v:customStoreNew">customStoreNew</a> :: (<a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModelClass">TreeModelClass</a> (model row), <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> model) => private -> (<a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> model row) -> <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelIface">TreeModelIface</a> row -> <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-CustomStore.html#t:DragSourceIface">DragSourceIface</a> model row) -> <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-CustomStore.html#t:DragDestIface">DragDestIface</a> model row) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (model row)</li><li class="src short"><a href="#v:customStoreGetRow">customStoreGetRow</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:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> row</li><li class="src short"><a href="#v:customStoreSetColumn">customStoreSetColumn</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:ColumnId">ColumnId</a> row ty -> (row -> ty) -> <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:customStoreGetPrivate">customStoreGetPrivate</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> private</li><li class="src short"><a href="#v:customStoreGetStamp">customStoreGetStamp</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> <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/Foreign-C-Types.html#t:CInt">CInt</a></li><li class="src short"><a href="#v:customStoreInvalidateIters">customStoreInvalidateIters</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> <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">The definition of a row-based store.
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CustomStore" class="def">CustomStore</a> private row <a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#CustomStore" class="link">Source</a></p><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a></code> is an instance of a Gtk+ <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> and can thus be used
for any widget that stores data in a <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code>. The user may either
create an instance of a <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a></code> or use one of the pre-defined
models <code>Graphics.UI.Gtk.ModelView.ListStore.ListStore</code> of
<code>Graphics.UI.Gtk.ModelView.TreeStore.TreeStore</code>.
</p></div><div class="subs instances"><p id="control.i:CustomStore" class="caption collapser" onclick="toggleSection('i:CustomStore')">Instances</p><div id="section.i:CustomStore" class="show"><table><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-CustomStore.html#t:CustomStore">CustomStore</a> private row)</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"><span class="keyword">data</span> <a name="t:TreeModelFlags" class="def">TreeModelFlags</a> <a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#TreeModelFlags" class="link">Source</a></p><div class="doc"><p>These flags indicate various properties of a
<code>Graphics.UI.Gtk.ModelView.TreeModel.TreeModel</code>.
</p><ul><li> If a model has <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#v:TreeModelItersPersist">TreeModelItersPersist</a></code> set, iterators remain valid after
a <code>Graphics.UI.Gtk.ModelView.TreeModel.TreeModel</code> signal was emitted.
</li><li> The <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#v:TreeModelListOnly">TreeModelListOnly</a></code> flag is set if the rows are arranged in a simple
flat list. This is set in the
<code>Graphics.UI.Gtk.ModelView.ListStore.ListStore</code> implementation.
</li></ul></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TreeModelItersPersist" class="def">TreeModelItersPersist</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:TreeModelListOnly" class="def">TreeModelListOnly</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:TreeModelFlags" class="caption collapser" onclick="toggleSection('i:TreeModelFlags')">Instances</p><div id="section.i:TreeModelFlags" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Bounded">Bounded</a> <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelFlags">TreeModelFlags</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/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelFlags">TreeModelFlags</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-Flags.html#t:Flags">Flags</a> <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelFlags">TreeModelFlags</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TreeModelIface" class="def">TreeModelIface</a> row <a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#TreeModelIface" class="link">Source</a></p><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelIface">TreeModelIface</a></code> structure contains all functions that are required
to implement an application-specific <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TreeModelIface" class="def">TreeModelIface</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:treeModelIfaceGetFlags" class="def">treeModelIfaceGetFlags</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-CustomStore.html#t:TreeModelFlags">TreeModelFlags</a>]</dt><dd class="doc"><p>Return the flags that are valid for this model.
</p></dd><dt class="src"><a name="v:treeModelIfaceGetIter" class="def">treeModelIfaceGetIter</a> :: <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>)</dt><dd class="doc"><p>Convert an path into the tree into a more concise <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>.
Return <code>Nothing</code> if the path does not exit.
</p></dd><dt class="src"><a name="v:treeModelIfaceGetPath" class="def">treeModelIfaceGetPath</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="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a></dt><dd class="doc"><p>Convert an iterator to a path. The iterator will always be valid.
</p></dd><dt class="src"><a name="v:treeModelIfaceGetRow" class="def">treeModelIfaceGetRow</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> row</dt><dd class="doc"><p>Retrieve a row at the given iterator.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterNext" class="def">treeModelIfaceIterNext</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</dt><dd class="doc"><p>Advance the given iterator to the next node at the same level.
Return <code>Nothing</code> if there is no next node at this level.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterChildren" class="def">treeModelIfaceIterChildren</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/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>)</dt><dd class="doc"><p>Advance the given iterator to the first child of this iterator.
Return <code>Notihing</code> if the node at this iterator has no children.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterHasChild" class="def">treeModelIfaceIterHasChild</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-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Check if the node at the given iterator has children.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterNChildren" class="def">treeModelIfaceIterNChildren</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/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></dt><dd class="doc"><p>Query the number of children the the node at the given iteratore has.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterNthChild" class="def">treeModelIfaceIterNthChild</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/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</dt><dd class="doc"><p>Ask for an iterator to the <code>n</code>th child. Return <code>Nothing</code> if
no such child exists.
</p></dd><dt class="src"><a name="v:treeModelIfaceIterParent" class="def">treeModelIfaceIterParent</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a>)</dt><dd class="doc"><p>Ask for an iterator to the parent of the node.
</p></dd><dt class="src"><a name="v:treeModelIfaceRefNode" class="def">treeModelIfaceRefNode</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></dt><dd class="doc"><p>Increase a reference count for this node. A positive reference count
indicates that the node is used (that is, most likely it is visible)
in at least one widget. Tracking reference counts for nodes is
optional but may be useful to infer when a given row can be discarded
if it was retrieved from an external source.
</p></dd><dt class="src"><a name="v:treeModelIfaceUnrefNode" class="def">treeModelIfaceUnrefNode</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></dt><dd class="doc"><p>Decrement the reference count of the given node.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DragSourceIface" class="def">DragSourceIface</a> model row <a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#DragSourceIface" class="link">Source</a></p><div class="doc"><p>A structure containing functions that enable this widget to be used
as a source in drag-and-drop.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DragSourceIface" class="def">DragSourceIface</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:treeDragSourceRowDraggable" class="def">treeDragSourceRowDraggable</a> :: model row -> <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-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Determine if the row at the given path is draggable. Return
<code>False</code> if for some reason this row should not be dragged by
the user.
</p></dd><dt class="src"><a name="v:treeDragSourceDragDataGet" class="def">treeDragSourceDragDataGet</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Fill in the <code><a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a></code> structure with information on
the given node using
<code>Graphics.UI.Gtk.General.Selection.selectionDataSet</code>.
</p></dd><dt class="src"><a name="v:treeDragSourceDragDataDelete" class="def">treeDragSourceDragDataDelete</a> :: model row -> <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-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>The widget is informed that the row at the given path should
be deleted as the result of this drag.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DragDestIface" class="def">DragDestIface</a> model row <a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#DragDestIface" class="link">Source</a></p><div class="doc"><p>A structure containing functions that enable this widget to be used
as a target in drag-and-drop.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DragDestIface" class="def">DragDestIface</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:treeDragDestRowDropPossible" class="def">treeDragDestRowDropPossible</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Tell the drag-and-drop mechanism if the row can be dropped at the
given path.
</p></dd><dt class="src"><a name="v:treeDragDestDragDataReceived" class="def">treeDragDestDragDataReceived</a> :: model row -> <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreePath">TreePath</a> -> <a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>The data in the <code><a href="Graphics-UI-Gtk-General-Selection.html#t:SelectionDataM">SelectionDataM</a></code> structure should be read using
<code>Graphics.UI.Gtk.General.Selection.selectionDataGet</code> and
its information be used to insert a new row at the given path.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:customStoreNew" class="def">customStoreNew</a><a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#customStoreNew" 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> (model row), <a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TypedTreeModelClass">TypedTreeModelClass</a> model)</td><td class="doc empty"> </td></tr><tr><td class="src">=> private</td><td class="doc"><p>Any private data the store needs to store. Usually an <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-IORef.html#t:IORef">IORef</a></code>.
</p></td></tr><tr><td class="src">-> (<a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> model row)</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelIface">TreeModelIface</a> row</td><td class="doc"><p>Functions necessary to implement the <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeModel">TreeModel</a></code> interface.
</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-CustomStore.html#t:DragSourceIface">DragSourceIface</a> model row)</td><td class="doc"><p>Functions to enable this store to generate drag events.
</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-CustomStore.html#t:DragDestIface">DragDestIface</a> model row)</td><td class="doc"><p>Functions to enable this store to receive drag events.
</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> (model row)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Create a new store that implements the <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:TreeModelIface">TreeModelIface</a></code> interface and
optionally the <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:DragSourceIface">DragSourceIface</a></code> and the <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:DragDestIface">DragDestIface</a></code>. If the latter two
are set to <code>Nothing</code> a dummy interface is substituted that rejects every
drag and drop.
</p></div></div><div class="top"><p class="src"><a name="v:customStoreGetRow" class="def">customStoreGetRow</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:TreeIter">TreeIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> row<a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#customStoreGetRow" class="link">Source</a></p><div class="doc"><p>Extract a row of the given model at the given <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:customStoreSetColumn" class="def">customStoreSetColumn</a><a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#customStoreSetColumn" 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:TypedTreeModelClass">TypedTreeModelClass</a> model</td><td class="doc empty"> </td></tr><tr><td class="src">=> model row</td><td class="doc"><p>the store in which to allocate a new column
</p></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>the column that should be set
</p></td></tr><tr><td class="src">-> (row -> ty)</td><td class="doc"><p>the function that sets the property
</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>Set or update a column mapping. This function should be used before
the model is installed into a widget since the number of defined
columns are only checked once by widgets.
</p></div></div><div class="top"><p class="src"><a name="v:customStoreGetPrivate" class="def">customStoreGetPrivate</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> private<a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#customStoreGetPrivate" class="link">Source</a></p><div class="doc"><p>Return the private data stored in this <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a></code>. The private data
is meant as a container for the data stored in this model.
</p></div></div><div class="top"><p class="src"><a name="v:customStoreGetStamp" class="def">customStoreGetStamp</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> <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/Foreign-C-Types.html#t:CInt">CInt</a><a href="src/Graphics-UI-Gtk-ModelView-CustomStore.html#customStoreGetStamp" class="link">Source</a></p><div class="doc"><p>Query the current value of the stamp that is used to create
<code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code> iterators. The stamp is compared each time a view
accesses this store. If the stamp doesn't match, a warning
is emitted. The stamp should be updated each time a the data
in the model changes. The rationale is that a view should never
use a stale <code><a href="Graphics-UI-Gtk-ModelView-TreeModel.html#t:TreeIter">TreeIter</a></code>, i.e., one that refers to an old model.
</p></div></div><div class="top"><p class="src"><a name="v:customStoreInvalidateIters" class="def">customStoreInvalidateIters</a> :: <a href="Graphics-UI-Gtk-ModelView-CustomStore.html#t:CustomStore">CustomStore</a> private row -> <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-CustomStore.html#customStoreInvalidateIters" class="link">Source</a></p><div class="doc"><p>Create a new stamp. See <code><a href="Graphics-UI-Gtk-ModelView-CustomStore.html#v:customStoreGetStamp">customStoreGetStamp</a></code>.
</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>
