<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkcellrendererpixbuf">
  <refnamediv>
    <refname>gtk.CellRendererPixbuf</refname> <refpurpose>an object that
    renders a pixbuf into a <link
    linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
    cell</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.CellRendererPixbuf</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link></methodname>
	<methodparam></methodparam>
      </constructorsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
      +-- <link linkend="class-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkcellrendererpixbuf">
    <title>gtk.CellRendererPixbuf Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="3.5in"/>
	  <tbody>

        <row valign="top">
          <entry>"follow-state"</entry>
          <entry>Read-Write</entry>
          <entry>If <literal>True</literal> the rendered pixbuf should be
          colorized according to the <xref
          linkend="gtk-cellrenderer-state-constants"
          endterm="gtk-cellrenderer-state-constants-title"></xref>.  This
          property is available in GTK+ 2.8 and above.</entry>
        </row>
	
	<row valign="top">
          <entry>"gicon"</entry>
          <entry>Read-Write</entry>
          <entry>If <literal>True</literal> the GIcon representing the icon to display.
	  If the icon theme is changed, the image will be updated automatically. This
          property is available in GTK+ 2.14 and above.</entry>
        </row>

        <row valign="top">
          <entry>"icon-name"</entry>
          <entry>Read-Write</entry>
          <entry>The name of the themed icon to display.  This property only
          has an effect if not overridden by "stock_id" or "pixbuf"
          properties.  This property is available in GTK+ 2.8 and
          above.</entry>
        </row>

            <row valign="top">
              <entry>"pixbuf"</entry>
              <entry>Read/Write</entry>
              <entry>The pixbuf to render.</entry>
            </row>

            <row valign="top">
              <entry>"pixbuf-expander-closed"</entry>
              <entry>Read/Write</entry>
              <entry>Pixbuf for closed expander.</entry>
            </row>

            <row valign="top">
              <entry>"pixbuf-expander-open"</entry>
              <entry>Read/Write</entry>
              <entry>Pixbuf for open expander.</entry>
            </row>

            <row valign="top">
              <entry>"stock-detail"</entry>
              <entry>Read/Write</entry>
              <entry>Render detail to pass to the theme engine</entry>
            </row>

            <row valign="top">
              <entry>"stock-id"</entry>
              <entry>Read/Write</entry>
              <entry>The stock ID of the stock icon to render</entry>
            </row>

            <row valign="top">
              <entry>"stock-size"</entry>
              <entry>Read/Write</entry>
              <entry>The size of the rendered icon</entry>
            </row>

          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkcellrendererpixbuf">
    <title>gtk.CellRendererPixbuf Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
</refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link> 
manages the rendering of a pixbuf into a <link
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
cell.</para>

  </refsect1>

  <refsect1 id="constructor-gtkcellrendererpixbuf">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.CellRendererPixbuf</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>the new cell renderer</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link>. 
Rendering parameters are adjusted using the object properties. The object
properties can be set globally (with <link
linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>). 
Also, with <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>, 
you can bind a property to a value in a <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
For example, you can bind the "pixbuf" property on the cell renderer to a
pixbuf value in the model, thus rendering a different image in each row of
the <link
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>

  </refsect1>

</refentry>
