<!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.CellRendererPixbuf</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-CellRendererPixbuf.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-ModelView-CellRendererPixbuf.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.CellRendererPixbuf</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">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Renders a pixbuf in a cell
</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:CellRendererPixbuf">CellRendererPixbuf</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> o => <a href="#t:CellRendererPixbufClass">CellRendererPixbufClass</a> o </li><li class="src short"><a href="#v:castToCellRendererPixbuf">castToCellRendererPixbuf</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></li><li class="src short"><a href="#v:gTypeCellRendererPixbuf">gTypeCellRendererPixbuf</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toCellRendererPixbuf">toCellRendererPixbuf</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></li><li class="src short"><a href="#v:cellRendererPixbufNew">cellRendererPixbufNew</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></li><li class="src short"><a href="#v:cellPixbuf">cellPixbuf</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:cellPixbufExpanderOpen">cellPixbufExpanderOpen</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:cellPixbufExpanderClosed">cellPixbufExpanderClosed</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:cellPixbufStockId">cellPixbufStockId</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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:cellPixbufStockSize">cellPixbufStockSize</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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:cellPixbufStockDetail">cellPixbufStockDetail</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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:cellPixbufIconName">cellPixbufIconName</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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:cellPixbufFollowState">cellPixbufFollowState</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></code> can be used to render an image in a cell. It
allows to render either a given <code><a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></code> (set via the <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbuf">cellPixbuf</a></code>
property) or a stock icon (set via the <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbufStockId">cellPixbufStockId</a></code> property).
</p><p>To support the tree view, <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></code> also supports rendering two
alternative pixbufs, when the
<code>Graphics.UI.Gtk.ModelView.CellRenderer.cellIsExpander</code> property is <code>True</code>.
If the this property is <code>True</code> and the <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbufExpanderOpen">cellPixbufExpanderOpen</a></code> property is
set to a pixbuf, it renders that pixbuf, if the
<code>Graphics.UI.Gtk.ModelView.CellRenderer.cellIsExpanded</code> property is <code>False</code>
and the <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbufExpanderClosed">cellPixbufExpanderClosed</a></code> property is set to a pixbuf, it renders
that one.
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Object.html#t:Object">Object</a></code>
| +----<code><a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRenderer">CellRenderer</a></code>
| +----CellRendererPixbuf
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CellRendererPixbuf" class="def">CellRendererPixbuf</a> <a href="src/Graphics-UI-Gtk-Types.html#CellRendererPixbuf" class="link">Source</a></p><div class="subs instances"><p id="control.i:CellRendererPixbuf" class="caption collapser" onclick="toggleSection('i:CellRendererPixbuf')">Instances</p><div id="section.i:CellRendererPixbuf" 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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</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="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> o => <a name="t:CellRendererPixbufClass" class="def">CellRendererPixbufClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#CellRendererPixbufClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:CellRendererPixbufClass" class="caption collapser" onclick="toggleSection('i:CellRendererPixbufClass')">Instances</p><div id="section.i:CellRendererPixbufClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToCellRendererPixbuf" class="def">castToCellRendererPixbuf</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a><a href="src/Graphics-UI-Gtk-Types.html#castToCellRendererPixbuf" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeCellRendererPixbuf" class="def">gTypeCellRendererPixbuf</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeCellRendererPixbuf" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toCellRendererPixbuf" class="def">toCellRendererPixbuf</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a><a href="src/Graphics-UI-Gtk-Types.html#toCellRendererPixbuf" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:cellRendererPixbufNew" class="def">cellRendererPixbufNew</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-CellRendererPixbuf.html#t:CellRendererPixbuf">CellRendererPixbuf</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#cellRendererPixbufNew" class="link">Source</a></p><div class="doc"><p>Create a new CellRendererPixbuf object.
</p></div></div><h1 id="g:5">Attributes
</h1><div class="top"><p class="src"><a name="v:cellPixbuf" class="def">cellPixbuf</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#cellPixbuf" class="link">Source</a></p><div class="doc"><p>The pixbuf to render.
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufExpanderOpen" class="def">cellPixbufExpanderOpen</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#cellPixbufExpanderOpen" class="link">Source</a></p><div class="doc"><p>Pixbuf for open expander.
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufExpanderClosed" class="def">cellPixbufExpanderClosed</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#cellPixbufExpanderClosed" class="link">Source</a></p><div class="doc"><p>Pixbuf for closed expander.
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufStockId" class="def">cellPixbufStockId</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-CellRendererPixbuf.html#cellPixbufStockId" class="link">Source</a></p><div class="doc"><p>The stock ID of the stock icon to render.
</p><p>Default value: <code>""</code>
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufStockSize" class="def">cellPixbufStockSize</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-CellRendererPixbuf.html#cellPixbufStockSize" class="link">Source</a></p><div class="doc"><p>The <code>IconSize</code> value that specifies the size of the rendered icon.
</p><p>Default value: 1
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufStockDetail" class="def">cellPixbufStockDetail</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-CellRendererPixbuf.html#cellPixbufStockDetail" class="link">Source</a></p><div class="doc"><p>Render detail to pass to the theme engine.
</p><p>Default value: <code>""</code>
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufIconName" class="def">cellPixbufIconName</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-CellRendererPixbuf.html#cellPixbufIconName" class="link">Source</a></p><div class="doc"><p>The name of the themed icon to display. This property only has an effect
if not overridden by <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbufStockId">cellPixbufStockId</a></code> or <code><a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#v:cellPixbuf">cellPixbuf</a></code> attributes.
</p><p>Default value: <code>""</code>
</p></div></div><div class="top"><p class="src"><a name="v:cellPixbufFollowState" class="def">cellPixbufFollowState</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererPixbuf.html#t:CellRendererPixbufClass">CellRendererPixbufClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-CellRendererPixbuf.html#cellPixbufFollowState" class="link">Source</a></p><div class="doc"><p>Specifies whether the rendered pixbuf should be colorized according to
the <code>CellRendererState</code>.
</p><p>Default value: <code>False</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>
