path: root/docs/reference/pygtk-gtktreeviewcolumn.xml

<?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-gtktreeviewcolumn">
  <refnamediv>
    <refname>gtk.TreeViewColumn</refname>
    <refpurpose>a visible column in a <link
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
widget</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.TreeViewColumn</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtktreeviewcolumn">gtk.TreeViewColumn</link></methodname>
	<methodparam><parameter>title</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter>cell_renderer</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--pack-start">pack_start</link></methodname>
	<methodparam><parameter
		       role="keyword">cell</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">expand</parameter><initializer>True</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--pack-end">pack_end</link></methodname>
	<methodparam><parameter
		       role="keyword">cell</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">expand</parameter><initializer>True</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--clear">clear</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-cell-renderers">get_cell_renderers</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--add-attribute">add_attribute</link></methodname>
	<methodparam><parameter
		       role="keyword">cell_renderer</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">attribute</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-attributes">set_attributes</link></methodname>
	<methodparam><parameter>cell_renderer</parameter></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-cell-data-func">set_cell_data_func</link></methodname>
	<methodparam><parameter>cell_renderer</parameter></methodparam>
	<methodparam><parameter>func</parameter></methodparam>
	<methodparam><parameter>func_data</parameter>
	  <initializer>None</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--clear-attributes">clear_attributes</link></methodname>
	<methodparam><parameter
		       role="keyword">cell_renderer</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-spacing">set_spacing</link></methodname>
	<methodparam><parameter
		       role="keyword">spacing</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-spacing">get_spacing</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-visible">set_visible</link></methodname>
	<methodparam><parameter
		       role="keyword">visible</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-visible">get_visible</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-resizable">set_resizable</link></methodname>
	<methodparam><parameter
		       role="keyword">resizable</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-resizable">get_resizable</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-sizing">set_sizing</link></methodname>
	<methodparam><parameter
		       role="keyword">type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-sizing">get_sizing</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-width">get_width</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-fixed-width">get_fixed_width</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-fixed-width">set_fixed_width</link></methodname>
	<methodparam><parameter
		       role="keyword">fixed_width</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-min-width">set_min_width</link></methodname>
	<methodparam><parameter
		       role="keyword">min_width</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-min-width">get_min_width</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-max-width">set_max_width</link></methodname>
	<methodparam><parameter
		       role="keyword">max_width</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-max-width">get_max_width</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--clicked">clicked</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-title">set_title</link></methodname>
	<methodparam><parameter
		       role="keyword">title</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-title">get_title</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtktreeviewcolumn--set-expand">set_expand</link></methodname>
	<methodparam><parameter
		       role="keyword">expand</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtktreeviewcolumn--get-expand">get_expand</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-clickable">set_clickable</link></methodname>
	<methodparam><parameter
		       role="keyword">active</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-clickable">get_clickable</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-widget">set_widget</link></methodname>
	<methodparam><parameter
		       role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-widget">get_widget</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-alignment">set_alignment</link></methodname>
	<methodparam><parameter
		       role="keyword">xalign</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-alignment">get_alignment</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-reorderable">set_reorderable</link></methodname>
	<methodparam><parameter
		       role="keyword">reorderable</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-reorderable">get_reorderable</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-sort-column-id">set_sort_column_id</link></methodname>
	<methodparam><parameter
		       role="keyword">sort_column_id</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-sort-column-id">get_sort_column_id</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-sort-indicator">set_sort_indicator</link></methodname>
	<methodparam><parameter
		       role="keyword">setting</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-sort-indicator">get_sort_indicator</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--set-sort-order">set_sort_order</link></methodname>
	<methodparam><parameter
		       role="keyword">order</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-sort-order">get_sort_order</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--cell-set-cell-data">cell_set_cell_data</link></methodname>
	<methodparam><parameter
		       role="keyword">tree_model</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">iter</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">is_expander</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">is_expanded</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--cell-get-size">cell_get_size</link></methodname>
	<methodparam><parameter>cell_area</parameter><initializer>(0,0,0,0)</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--cell-is-visible">cell_is_visible</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtktreeviewcolumn--focus-cell">focus_cell</link></methodname>
	<methodparam><parameter role="keyword">cell</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtktreeviewcolumn--cell-get-position">cell_get_position</link></methodname>
	<methodparam><parameter role="keyword">cell_renderer</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--queue-resize">queue_resize</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtktreeviewcolumn--get-tree-view">get_tree_view</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtktreeviewcolumn">gtk.TreeViewColumn</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtktreeviewcolumn">
    <title>gtk.TreeViewColumn Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object 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="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"alignment"</entry>
	      <entry>Read-Write</entry>
	      <entry>The alignment of the column header text or
widget</entry>
	    </row>

	    <row valign="top">
	      <entry>"clickable"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the header can be
clicked</entry>
	    </row>

	    <row valign="top">
	      <entry>"expand"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the column can expand to
take extra available space. Available in GTK+ 2.4 and above</entry>
	    </row>

	    <row valign="top">
	      <entry>"fixed-width"</entry>
	      <entry>Read-Write</entry>
	      <entry>The current fixed width of the column</entry>
	    </row>

	    <row valign="top">
	      <entry>"max-width"</entry>
	      <entry>Read-Write</entry>
	      <entry>The maximum allowed width of the column</entry>
	    </row>

	    <row valign="top">
	      <entry>"min-width"</entry>
	      <entry>Read-Write</entry>
	      <entry>The minimum allowed width of the column</entry>
	    </row>

	    <row valign="top">
	      <entry>"reorderable"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the column can be reordered
around the headers</entry>
	    </row>

	    <row valign="top">
	      <entry>"resizable"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the user can resize the
column</entry>
	    </row>

	    <row valign="top">
	      <entry>"sizing"</entry>
	      <entry>Read-Write</entry>
	      <entry>The resize mode of the column:
<literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>,
<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal> or
<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal></entry>
	    </row>

	    <row valign="top">
	      <entry>"sort-indicator"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, how a sort
indicator</entry>
	    </row>

	    <row valign="top">
	      <entry>"sort-order"</entry>
	      <entry>Read-Write</entry>
	      <entry>The sort direction the sort indicator should indicate:
<literal>gtk.SORT_ASCENDING</literal> or
<literal>gtk.SORT_DESCENDING</literal></entry>
	    </row>

            <row valign="top">
              <entry>"spacing"</entry>
              <entry>Read-Write</entry>
              <entry>Space which is inserted between cells</entry>
            </row>

	    <row valign="top">
	      <entry>"title"</entry>
	      <entry>Read-Write</entry>
	      <entry>The title to appear in the column header</entry>
	    </row>

	    <row valign="top">
	      <entry>"visible"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, display the column</entry>
	    </row>

	    <row valign="top">
	      <entry>"widget"</entry>
	      <entry>Read-Write</entry>
	      <entry>The widget to put in the column header button instead
of the column title</entry>
	    </row>

	    <row valign="top">
	      <entry>"width"</entry>
	      <entry>Read</entry>
	      <entry>The current width of the column</entry>
	    </row>

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

  </refsect1>

  <refsect1 id="signal-prototypes-gtktreeviewcolumn">
    <title>gtk.TreeViewColumn 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>

    <variablelist>
      <varlistentry>
        <term>"<link
linkend="signal-gtktreeviewcolumn--clicked">clicked</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>treeviewcolumn</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
object is a visible column in a <link
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
widget. A <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
manages the display of the header and the cells using a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</para>

    <para>In PyGTK 2.4 <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
implementes the <link
linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
interface.</para>

  </refsect1>

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

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.TreeViewColumn</methodname>
	<methodparam><parameter>title</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter>cell_renderer</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter>title</parameter>&nbsp;:</term>
	<listitem><simpara>the header title string</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter>cell_renderer</parameter>&nbsp;:</term>
	<listitem><simpara>a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter>...</parameter>&nbsp;:</term>
	<listitem><simpara>zero or more <literal>attribute=column</literal>
pairs</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>A newly created <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>.</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link> 
with the header string specified by <parameter>title</parameter> and using
the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
specified by <parameter>cell_renderer</parameter>. Zero or more
<literal>attribute=column</literal> pairs may be added to specify from which
tree model column to retrieve the attribute value. For example:</para>

    <programlisting>
  column = gtk.TreeViewColumn('Column Title', cell_renderer, text=0, foreground=1)
</programlisting>

    <para>will retrieve the 'text' attribute values for the cell renderer
from column 0 in the treemodel and the 'foreground' attribute values from
column 1. See the <link
linkend="method-gtktreeviewcolumn--add-attribute"><methodname>add_attribute</methodname>()</link> 
method for more detail.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtktreeviewcolumn--pack-start">
      <title>gtk.TreeViewColumn.pack_start</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_start</methodname>
	  <methodparam><parameter
			 role="keyword">cell</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>cell</parameter> is to be given the extra space allocated to the
cell box.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack_start</methodname>() method packs the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
specified by <parameter>cell</parameter> into the beginning column. If
<parameter>expand</parameter> is <literal>True</literal>, then the
<parameter>cell</parameter> is allocated a share of all available space that
the column is allocated. Note <parameter>expand</parameter> defaults to
<literal>True</literal> in PyGTK 2.4.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--pack-end">
      <title>gtk.TreeViewColumn.pack_end</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_end</methodname>
	  <methodparam><parameter
			 role="keyword">cell</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>cell</parameter> is to be given the extra space allocated to the
cell box.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack_end</methodname>() method packs the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
specified by <parameter>cell</parameter> into the column. If
<parameter>expand</parameter> is <literal>True</literal>, then the
<parameter>cell</parameter> is allocated a share of all available space that
the column is allocated. Note <parameter>expand</parameter> defaults to
<literal>True</literal> in PyGTK 2.4.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--clear">
      <title>gtk.TreeViewColumn.clear</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>clear</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <para>The <methodname>clear</methodname>() method unsets all the
mappings on all renderers on the column.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-cell-renderers">
      <title>gtk.TreeViewColumn.get_cell_renderers</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_cell_renderers</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a list of <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
objects</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_cell_renderers</methodname>() method returns
a list containing all the cell renderers in the column, in no particular
order.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--add-attribute">
      <title>gtk.TreeViewColumn.add_attribute</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add_attribute</methodname>
	  <methodparam><parameter
			 role="keyword">cell_renderer</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">attribute</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">column</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">cell_renderer</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
to set attributes on</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">attribute</parameter>&nbsp;:</term>
	  <listitem><simpara>an attribute on the
renderer</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">column</parameter>&nbsp;:</term>
	  <listitem><simpara>the column position on the model to get the
attribute from.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add_attribute</methodname>() method adds an
attribute mapping to the list in the tree column.  The
<parameter>column</parameter> is the column of the tree model to get a value
from, and the <parameter>attribute</parameter> is the parameter on
<parameter>cell_renderer</parameter> to be set from the value. So for
example if column 2 of the model contains strings, you could have the "text"
attribute of a <link
linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link> 
get its values from column 2.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-attributes">
      <title>gtk.TreeViewColumn.set_attributes</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_attributes</methodname>
	  <methodparam><parameter>cell_renderer</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>cell_renderer</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
we're setting the attributes of</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>zero or more
<literal>attribute=column</literal> pairs</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_attributes</methodname>() method sets the
attribute locations of the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
specified by <parameter>cell_renderer</parameter> using the
<literal>attribute=column</literal> pairs (e.g. text=0, foreground=1). See
the <link
linkend="method-gtktreeviewcolumn--add-attribute"><methodname>add_attribute</methodname>()</link> 
method for more detail. All existing cell attributes are removed, and
replaced with the new attributes.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-cell-data-func">
      <title>gtk.TreeViewColumn.set_cell_data_func</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_cell_data_func</methodname>
	  <methodparam><parameter>cell_renderer</parameter></methodparam>
	  <methodparam><parameter>func</parameter></methodparam>
	  <methodparam><parameter>func_data</parameter>
	    <initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>cell_renderer</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>func</parameter>&nbsp;:</term>
	  <listitem><simpara>the function or method to
use.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>func_data</parameter>&nbsp;:</term>
	  <listitem><simpara>the user data to pass when calling
<parameter>func</parameter>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_cell_data_func</methodname>() method sets
the data function (or method) to use for the column <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
specified by <parameter>cell_renderer</parameter>. This function (or method)
is used instead of the standard attribute mappings for setting the column
values, and should set the attributes of the cell renderer as appropriate.
<parameter>func</parameter> may be <literal>None</literal> to remove the
current data function. The signature of <parameter>func</parameter>
is:</para>

      <programlisting>
<methodsynopsis language="python">
          <methodname>celldatafunction</methodname>
          <methodparam><parameter>column</parameter></methodparam>
          <methodparam><parameter>cell</parameter></methodparam>
          <methodparam><parameter>model</parameter></methodparam>
          <methodparam><parameter>iter</parameter></methodparam>
          <methodparam><parameter>user_data</parameter></methodparam>
        </methodsynopsis>
<methodsynopsis language="python">
          <methodname>celldatamethod</methodname>
          <methodparam><parameter>self</parameter></methodparam>
          <methodparam><parameter>column</parameter></methodparam>
          <methodparam><parameter>cell</parameter></methodparam>
          <methodparam><parameter>model</parameter></methodparam>
          <methodparam><parameter>iter</parameter></methodparam>
          <methodparam><parameter>user_data</parameter></methodparam>
        </methodsynopsis>
</programlisting>

      <para>where <parameter>column</parameter> is the <link
linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link> 
in the treeview, <parameter>cell</parameter> is the <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
for <parameter>column</parameter>, <parameter>model</parameter> is the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> for
the treeview and <parameter>iter</parameter> is the <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
pointing at the row.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--clear-attributes">
      <title>gtk.TreeViewColumn.clear_attributes</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>clear_attributes</methodname>
	  <methodparam><parameter
			 role="keyword">cell_renderer</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">cell_renderer</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> 
to clear the attribute mapping on.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>clear_attributes</methodname>() method clears
all existing attributes previously set with the <link
linkend="method-gtktreeviewcolumn--set-attributes"><methodname>set_attributes</methodname>()</link> 
method.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-spacing">
      <title>gtk.TreeViewColumn.set_spacing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_spacing</methodname>
	  <methodparam><parameter
			 role="keyword">spacing</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
	  <listitem><simpara>the distance between cell renderers in
pixels.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_spacing</methodname>() method sets the
spacing field of the treeview column, which is the number of pixels to place
between cell renderers packed into it.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-spacing">
      <title>gtk.TreeViewColumn.get_spacing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_spacing</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the spacing of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_spacing</methodname>() method returns the
spacing of the treeview column.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-visible">
      <title>gtk.TreeViewColumn.set_visible</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_visible</methodname>
	  <methodparam><parameter
			 role="keyword">visible</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> the treeview column
is visible.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_visible</methodname>() method sets the
"visible" property to the value of <parameter>visible</parameter>. If
<parameter>visible</parameter> is <literal>True</literal> the treeview
column is visible</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-visible">
      <title>gtk.TreeViewColumn.get_visible</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_visible</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the column is
visible</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_visible</methodname>() method returns the
value of the "visible" property. If "visible" is <literal>True</literal> the
treeview column is visible.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-resizable">
      <title>gtk.TreeViewColumn.set_resizable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_resizable</methodname>
	  <methodparam><parameter
			 role="keyword">resizable</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">resizable</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>, the column can be
resized</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_resizable</methodname>() method sets the
"resizable" property to the value of <parameter>resizable</parameter>. If
<parameter>resizable</parameter> is <literal>True</literal> the user can
explicitly resize the column by grabbing the outer edge of the column
button. If <parameter>resizable</parameter> is <literal>True</literal> and
the sizing mode of the column is
<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal>, the sizing mode is changed
to <literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-resizable">
      <title>gtk.TreeViewColumn.get_resizable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_resizable</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal>, if the treeview column
can be resized.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_resizable</methodname>() method returns the
value of the "resizable" property. If "resizable" is
<literal>True</literal>, the treeview column can be resized by the
user.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-sizing">
      <title>gtk.TreeViewColumn.set_sizing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_sizing</methodname>
	  <methodparam><parameter
			 role="keyword">type</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">type</parameter>&nbsp;:</term>
	  <listitem><simpara>The treeview column sizing:
<literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>,
<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal> or
<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_sizing</methodname>() method sets the
"sizing" property to the value of <parameter>type</parameter>. The value of
type must be one of the <xref linkend="gtk-treeviewcolumn-sizing-constants"
endterm="gtk-treeviewcolumn-sizing-constants-title"></xref>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-sizing">
      <title>gtk.TreeViewColumn.get_sizing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_sizing</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the treeview column sizing
type.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_sizing</methodname>() method returns the
value of the "sizing" property that contains the current type of the
treeview column sizing mode. See the <link
linkend="method-gtktreeviewcolumn--set-sizing"><methodname>set_sizing</methodname>()</link> 
method for more detail.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-width">
      <title>gtk.TreeViewColumn.get_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_width</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current width of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_width</methodname>() method returns the
value of the "width" property that contains the current size of the treeview
column in pixels.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-fixed-width">
      <title>gtk.TreeViewColumn.get_fixed_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_fixed_width</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the fixed width of the treeview
column</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_fixed_width</methodname>() method returns
the value of the "fixed-width" property that contains the fixed width of the
treeview column i.e. the width of the treeview column only if the sizing
type is <literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-fixed-width">
      <title>gtk.TreeViewColumn.set_fixed_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_fixed_width</methodname>
	  <methodparam><parameter
			 role="keyword">fixed_width</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">fixed_width</parameter>&nbsp;:</term>
	  <listitem><simpara>the size to set the treeview column to. Must be
greater than 0.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_fixed_width</methodname>() method sets the
"fixed-width" property to the value of <parameter>fixed_width</parameter>.
The value of <parameter>fixed_width</parameter> is the size of the column in
pixels. This is meaningful only if the sizing type is
<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>. The size of the column is
clamped to the min and max width for the column. Please note that the min
and max width of the column doesn't actually affect the "fixed_width"
property of the widget, just the actual size when displayed.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-min-width">
      <title>gtk.TreeViewColumn.set_min_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_min_width</methodname>
	  <methodparam><parameter
			 role="keyword">min_width</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">min_width</parameter>&nbsp;:</term>
	  <listitem><simpara>the minimum width of the treeview column in
pixels, or -1.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_min_width</methodname>() method sets the
"min-width" property to the value of <parameter>min_width</parameter>. The
value of <parameter>min_width</parameter> is the minimum width of the
treeview column.  If <parameter>min_width</parameter> is -1, then the
minimum width is unset.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-min-width">
      <title>gtk.TreeViewColumn.get_min_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_min_width</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the minimum width of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_min_width</methodname>() method returns the
value of the "min-width" property that contains the minimum width in pixels
of the treeview column, or -1 if no minimum width is set.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-max-width">
      <title>gtk.TreeViewColumn.set_max_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_max_width</methodname>
	  <methodparam><parameter
			 role="keyword">max_width</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">max_width</parameter>&nbsp;:</term>
	  <listitem><simpara>the maximum width of the column in pixels, or
-1.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_max_width</methodname>() method sets the
"max-width" property to the value of <parameter>max_width</parameter>. The
value of <parameter>max_width</parameter> becomes the maximum width of the
treeview column.  If <parameter>max_width</parameter> is -1, then the
maximum width is unset. Note, the column can actually be wider than max
width if it's the last column in a view. In this case, the column expands to
fill any extra space.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-max-width">
      <title>gtk.TreeViewColumn.get_max_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_max_width</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the maximum width of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_max_width</methodname>() method returns the
value of the "max-width" property that contains the maximum width in pixels
of the treeview column, or -1 if no maximum width is set.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--clicked">
      <title>gtk.TreeViewColumn.clicked</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>clicked</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <para>The <methodname>clicked</methodname>() method emits the
"clicked" signal on the treeview column. The treeview column must be
clickable.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-title">
      <title>gtk.TreeViewColumn.set_title</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_title</methodname>
	  <methodparam><parameter
			 role="keyword">title</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">title</parameter>&nbsp;:</term>
	  <listitem><simpara>the title string of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_title</methodname>() method sets the "title"
property to the value of <parameter>title</parameter>. The "title" property
contains the string that is used to set the treeview column title.  If a
custom widget has been set (see the <link
linkend="method-gtktreeviewcolumn--set-widget"><methodname>set_widget</methodname>()</link> 
method), this value is ignored.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-title">
      <title>gtk.TreeViewColumn.get_title</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_title</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the title of the column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_title</methodname>() method returns the
value of the "title" property that contains the treeview column
title.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-expand">
      <title>gtk.TreeViewColumn.set_expand</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_expand</methodname>
	  <methodparam><parameter role="keyword">expand</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> the column expands
	  to take extra space if available.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>set_expand</methodname>() method sets the
"expand" property to the value of <parameter>expand</parameter>. If expand
is <literal>True</literal> the column expands to take available extra
space. This space is shared equally among all columns that have their
"expand" property set to <literal>True</literal>. If no column has this
option set, then the last column gets all extra space. By default, every
column is created with this <literal>False</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-expand">
      <title>gtk.TreeViewColumn.get_expand</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_expand</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal>, if the column
	  expands</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>get_expand</methodname>() method returns the
value of the "expand" property. If "expand is <literal>True</literal> if the
column expands to take any available space.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-clickable">
      <title>gtk.TreeViewColumn.set_clickable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_clickable</methodname>
	  <methodparam><parameter
			 role="keyword">active</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">active</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> the treeview column
header can be clicked</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_clickable</methodname>() method sets the
"clickable" property to the value of <parameter>active</parameter>. If
<parameter>active</parameter> is <literal>True</literal> the header can take
keyboard focus, and be clicked.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-clickable">
      <title>gtk.TreeViewColumn.get_clickable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_clickable</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the user can click
the column header.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_clickable</methodname>() method returns the
value of the "clickable" property. If "clickable" is <literal>True</literal>
the user can click on the header for the treeview column.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-widget">
      <title>gtk.TreeViewColumn.set_widget</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_widget</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a child <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_widget</methodname>() method sets the widget
in the header to be <parameter>widget</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-widget">
      <title>gtk.TreeViewColumn.get_widget</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_widget</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> in the
column header, or <literal>None</literal></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_widget</methodname>() method returns the
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> in
the button on the column header. If a custom widget has not been set using
the <link
linkend="method-gtktreeviewcolumn--set-widget"><methodname>set_widget</methodname>()</link> 
method <literal>None</literal> is returned.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-alignment">
      <title>gtk.TreeViewColumn.set_alignment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_alignment</methodname>
	  <methodparam><parameter
			 role="keyword">xalign</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
	  <listitem><simpara>the horizontal alignment, in the range 0.0 to
1.0 inclusive.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_alignment</methodname>() method sets the
"alignment" property to the value of <parameter>xalign</parameter>.
<parameter>xalign</parameter> specifies the alignment of the title or custom
widget inside the column header. The alignment value specifies the fraction
of free space to the left of the widget.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-alignment">
      <title>gtk.TreeViewColumn.get_alignment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_alignment</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current alignment of the treeview
column.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_alignment</methodname>() method returns the
value of the "alignment" property that contains the current horizontal
alignment of the treeview column. See the <link
linkend="method-gtktreeviewcolumn--set-alignment"><methodname>set_alignment</methodname>()</link> 
method for more detail.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-reorderable">
      <title>gtk.TreeViewColumn.set_reorderable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_reorderable</methodname>
	  <methodparam><parameter
			 role="keyword">reorderable</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">reorderable</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>, the column can be
reordered.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_reorderable</methodname>() method sets the
"reorderable" property to the value of <parameter>reorderable</parameter>.
If <parameter>reorderable</parameter> is <literal>True</literal>, the column
can be reordered by the end user dragging the header.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-reorderable">
      <title>gtk.TreeViewColumn.get_reorderable</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_reorderable</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the treeview column
can be reordered by the user.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_reorderable</methodname>() method returns
the value of the "reorderable" property. If "reorderable" is
<literal>True</literal> the treeview column can be reordered by the
user.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-sort-column-id">
      <title>gtk.TreeViewColumn.set_sort_column_id</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_sort_column_id</methodname>
	  <methodparam><parameter
			 role="keyword">sort_column_id</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">sort_column_id</parameter>&nbsp;:</term>
	  <listitem><simpara>the logical column ID of the model to sort
on or -1.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_sort_column_id</methodname>() method is a
convenience method that sets the column's sort column ID to the value
specified by <parameter>sort_column_id</parameter> (an integer value). The
treeview model sorts on the <parameter>sort_column_id</parameter> when this
treeview column is selected for sorting. This method also makes the treeview
column header clickable. If <parameter>sort_column_id</parameter> is -1
sorting using the treeview column is disabled.</para>

      <para>This method sets up a number of callbacks that manage the
sorting of the tree model when the column header is clicked. These callbacks
provide toggling of the sort order, enabling the sort indicator and so
on.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-sort-column-id">
      <title>gtk.TreeViewColumn.get_sort_column_id</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_sort_column_id</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current column ID for this column, or -1 if
this column can't be used for sorting.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_sort_column_id</methodname>() method returns
the logical column ID that the model sorts on when this column is selected
for sorting. See the <link
linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link> 
method.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-sort-indicator">
      <title>gtk.TreeViewColumn.set_sort_indicator</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_sort_indicator</methodname>
	  <methodparam><parameter
			 role="keyword">setting</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> display an indicator
that the column is sorted</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_sort_indicator</methodname>() method sets
the "sort-indicator" property to the value of
<parameter>setting</parameter>. If <parameter>setting</parameter> is
<literal>True</literal> an arrow is displayed in the header button when the
column is sorted. Call the <link
linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link>
to change the direction of the arrow.</para>

      <note>
        <para>If the <link
linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
convenience method has been called the visibility of the sort indicator will
be managed automatically. See the <link
linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link>
method for more information.</para>
      </note>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-sort-indicator">
      <title>gtk.TreeViewColumn.get_sort_indicator</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_sort_indicator</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the sort indicator
arrow is displayed</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_sort_indicator</methodname>() method returns
the value of the "sort-indicator" property. If "sort-indicator" is
<literal>True</literal> an arrow is displayed in the header button when the
column is sorted.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--set-sort-order">
      <title>gtk.TreeViewColumn.set_sort_order</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_sort_order</methodname>
	  <methodparam><parameter
			 role="keyword">order</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">order</parameter>&nbsp;:</term>
	  <listitem><simpara>the sort order that the sort indicator should
indicate</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_sort_order</methodname>() method set the "sort-order" property to the
value of order. The value of order must be either:
<literal>gtk.SORT_ASCENDING</literal> or
<literal>gtk.SORT_DESCENDING</literal>. This method changes the appearance
of the sort indicator.</para>

      <note>
	<para>This method <emphasis>does not</emphasis> actually sort the
model. Use the <link
linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link> 
method if you want automatic sorting support.  This method is primarily for
custom sorting behavior, and should be used in conjunction with the <link
linkend="method-gtktreesortable--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link> 
method to do that. For custom models, the mechanism will vary.</para>
      </note>

      <para>The sort indicator changes direction to indicate normal sort or
reverse sort. Of course, you must have the sort indicator enabled to see
anything when calling this method; see the <link
linkend="method-gtktreeviewcolumn--set-sort-indicator"><methodname>set_sort_indicator</methodname>()</link> 
method.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--get-sort-order">
      <title>gtk.TreeViewColumn.get_sort_order</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_sort_order</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the sort order the sort indicator is
indicating</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_sort_order</methodname>() method returns the
value of the "sort-order" property that indicates in which direction the
treeview column is sorted. See the <link
linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link> 
method for more detail.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--cell-set-cell-data">
      <title>gtk.TreeViewColumn.cell_set_cell_data</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>cell_set_cell_data</methodname>
	  <methodparam><parameter
			 role="keyword">tree_model</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">iter</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">is_expander</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">is_expanded</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">tree_model</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to
get the cell renderer's attributes from.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to
get the cell renderer's attributes from.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">is_expander</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>, the row has
children</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">is_expanded</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>, the row has visible
children</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>cell_set_cell_data</methodname>() method sets
the cell renderer attributes based on the specified
<parameter>tree_model</parameter> and <parameter>iter</parameter>. That is,
for every attribute mapping in the treeview column, it will get a value from
the set column in the <parameter>iter</parameter>, and use that value to set
the attribute on the cell renderer. If <parameter>is_expander</parameter> is
<literal>True</literal> the tree model row has children that may or may not
be displayed. If <parameter>is_expanded</parameter> is
<literal>True</literal> the tree model row has children that are
displayed.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--cell-get-size">
      <title>gtk.TreeViewColumn.cell_get_size</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>cell_get_size</methodname>
	<methodparam><parameter>cell_area</parameter><initializer>(0,0,0,0)</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>cell_area</parameter>&nbsp;:</term>
	  <listitem><simpara>an optional 4-tuple or 4-list or <link
          linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
          specifying the area allocated for a cell in the
          column</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing five values: a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
holding the area a cell in the column will be allocated; the x offset of the
cell; the y offset of the cell; the cell width; and, the cell
height</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>cell_get_size</methodname>() method returns a
tuple containing:</para>

      <itemizedlist>
	<listitem>
	  <simpara>a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
holding the area a cell in the treeview column will be allocated.</simpara>
	</listitem>
	<listitem>
	  <simpara>the x offset of the cell relative to
<parameter>cell_area</parameter>.</simpara>
	</listitem>
	<listitem>
	  <simpara>the y offset of the cell relative to
<parameter>cell_area</parameter>.</simpara>
	</listitem>
	<listitem>
	  <simpara>the width of the cell.</simpara>
	</listitem>
	<listitem>
	  <simpara>the height of the cell.</simpara>
	</listitem>
      </itemizedlist>

      <para>This method is used primarily by the <link
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--cell-is-visible">
      <title>gtk.TreeViewColumn.cell_is_visible</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>cell_is_visible</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal>, if any of the cells
packed into the treeview column are currently visible</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>cell_is_visible</methodname>() method returns
<literal>True</literal> if any of the cells packed into the treeview column
are visible. For this to be meaningful, you must first initialize the cells
with the <link
linkend="method-gtktreeviewcolumn--cell-set-cell-data"><methodname>cell_set_cell_data</methodname>()</link> 
method.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--focus-cell">
      <title>gtk.TreeViewColumn.focus_cell</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>focus_cell</methodname>
	  <methodparam><parameter role="keyword">cell</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.2 and above.</para>
      </note>

      <para>The <methodname>focus_cell</methodname>() method sets the
current keyboard focus to be at <parameter>cell</parameter>, if the column
contains 2 or more editable and activatable cells.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--cell-get-position">
      <title>gtk.TreeViewColumn.cell_get_position</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>cell_get_position</methodname>
	  <methodparam><parameter role="keyword">cell_renderer</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">cell_renderer</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a 2-tuple containing the horizontal position
	  and size of a cell or <literal>None</literal></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.4 and above.</para>
      </note>

      <para>The <methodname>cell_get_position</methodname>() method returns
the horizontal position and size of the cell specified by
<parameter>cell_renderer</parameter>. If the cell is not found in the
column, <literal>None</literal> is returned.</para>

    </refsect2>

    <refsect2 id="method-gtktreeviewcolumn--queue-resize">
      <title>gtk.TreeViewColumn.queue_resize</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>queue_resize</methodname>
	</methodsynopsis></programlisting>

      <note>
	<para>This method is available in PyGTK 2.8 and above.</para>
      </note>

      <para>The <methodname>queue_resize</methodname>() method flags the
 column, and the cell renderers added to this column, to have their sizes
 renegotiated.</para>

    </refsect2>
    
    <refsect2 id="method-gtktreeviewcolumn--get-tree-view">
      <title>gtk.TreeViewColumn.get_tree_view</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_tree_view</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>The tree view wherein column has been inserted if any,
      <literal>None</literal>otherwise.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This method is available in PyGTK 2.12 and above.</para>
      </note>

      <para>The <methodname>get_tree_view</methodname>() method returns
      the <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
      wherein tree_column has been inserted. If column is currently not
      inserted in any tree view, <literal>None</literal> is returned.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtktreeviewcolumn--clicked">
      <title>The "clicked" gtk.TreeViewColumn Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>treeviewcolumn</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>treeviewcolumn</parameter>&nbsp;:</term>
	  <listitem><simpara>the treeviewcolumn that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "clicked" signal is emitted when the user clicks on the
<parameter>treeviewcolumn</parameter> header button.</para>

    </refsect2>

  </refsect1>

</refentry>