<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkListItem">
<refmeta>
<refentrytitle role="top_of_page" id="GtkListItem.top_of_page">GtkListItem</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkListItem</refname>
<refpurpose>An item in a GtkList</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkListItem.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkListItem-struct">GtkListItem</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-list-item-new">gtk_list_item_new</link>                   (void);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-list-item-new-with-label">gtk_list_item_new_with_label</link>        (const <link linkend="gchar">gchar</link> *label);
<link linkend="void">void</link>                <link linkend="gtk-list-item-select">gtk_list_item_select</link>                (<link linkend="GtkListItem">GtkListItem</link> *list_item);
<link linkend="void">void</link>                <link linkend="gtk-list-item-deselect">gtk_list_item_deselect</link>              (<link linkend="GtkListItem">GtkListItem</link> *list_item);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkListItem.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkItem">GtkItem</link>
                                       +----GtkListItem
</synopsis>
</refsect1>



<refsect1 id="GtkListItem.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkListItem implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>



<refsect1 id="GtkListItem.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GtkListItem-end-selection">end-selection</link>&quot;                                  : Run Last / Action
  &quot;<link linkend="GtkListItem-extend-selection">extend-selection</link>&quot;                               : Run Last / Action
  &quot;<link linkend="GtkListItem-scroll-horizontal">scroll-horizontal</link>&quot;                              : Run Last / Action
  &quot;<link linkend="GtkListItem-scroll-vertical">scroll-vertical</link>&quot;                                : Run Last / Action
  &quot;<link linkend="GtkListItem-select-all">select-all</link>&quot;                                     : Run Last / Action
  &quot;<link linkend="GtkListItem-start-selection">start-selection</link>&quot;                                : Run Last / Action
  &quot;<link linkend="GtkListItem-toggle-add-mode">toggle-add-mode</link>&quot;                                : Run Last / Action
  &quot;<link linkend="GtkListItem-toggle-focus-row">toggle-focus-row</link>&quot;                               : Run Last / Action
  &quot;<link linkend="GtkListItem-undo-selection">undo-selection</link>&quot;                                 : Run Last / Action
  &quot;<link linkend="GtkListItem-unselect-all">unselect-all</link>&quot;                                   : Run Last / Action
</synopsis>
</refsect1>


<refsect1 id="GtkListItem.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GtkListItem"><type>GtkListItem</type></link> widget is used for each item in a <link linkend="GtkList"><type>GtkList</type></link>.
</para>
<para>
GtkList has has been deprecated since GTK+ 2.0 and should not be used
in newly written code. Use <link linkend="GtkTreeView"><type>GtkTreeView</type></link> instead.
</para>
</refsect1>

<refsect1 id="GtkListItem.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkListItem-struct" role="struct">
<title>GtkListItem</title>
<indexterm zone="GtkListItem-struct" role="deprecated"><primary sortas="ListItem">GtkListItem</primary></indexterm><programlisting>typedef struct _GtkListItem GtkListItem;</programlisting>
<warning><para><literal>GtkListItem</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
The <link linkend="GtkListItem"><type>GtkListItem</type></link> struct contains private data only, and should
only be accessed using the functions below.
</para></refsect2>
<refsect2 id="gtk-list-item-new" role="function" condition="deprecated:">
<title>gtk_list_item_new ()</title>
<indexterm zone="gtk-list-item-new" role="deprecated"><primary sortas="list_item_new">gtk_list_item_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_list_item_new                   (void);</programlisting>
<warning><para><literal>gtk_list_item_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new <link linkend="GtkListitem"><type>GtkListitem</type></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="GtkListItem"><type>GtkListItem</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-list-item-new-with-label" role="function" condition="deprecated:">
<title>gtk_list_item_new_with_label ()</title>
<indexterm zone="gtk-list-item-new-with-label" role="deprecated"><primary sortas="list_item_new_with_label">gtk_list_item_new_with_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_list_item_new_with_label        (const <link linkend="gchar">gchar</link> *label);</programlisting>
<warning><para><literal>gtk_list_item_new_with_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new <link linkend="GtkListItem"><type>GtkListItem</type></link> with a child label containing the given string.
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter>&#160;:</term>
<listitem><simpara>the string to use for the child label.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="GtkListItem"><type>GtkListItem</type></link> with a child <link linkend="GtkLabel"><type>GtkLabel</type></link> with the text set to
<parameter>label</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-list-item-select" role="function" condition="deprecated:">
<title>gtk_list_item_select ()</title>
<indexterm zone="gtk-list-item-select" role="deprecated"><primary sortas="list_item_select">gtk_list_item_select</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_list_item_select                (<link linkend="GtkListItem">GtkListItem</link> *list_item);</programlisting>
<warning><para><literal>gtk_list_item_select</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Selects the item, by emitting the item's "select" signal.
Depending on the selection mode of the list, this may cause other items to
be deselected.
</para><variablelist role="params">
<varlistentry><term><parameter>list_item</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GtkListItem"><type>GtkListItem</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-list-item-deselect" role="function" condition="deprecated:">
<title>gtk_list_item_deselect ()</title>
<indexterm zone="gtk-list-item-deselect" role="deprecated"><primary sortas="list_item_deselect">gtk_list_item_deselect</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_list_item_deselect              (<link linkend="GtkListItem">GtkListItem</link> *list_item);</programlisting>
<warning><para><literal>gtk_list_item_deselect</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deselects the item, by emitting the item's "deselect" signal.
</para><variablelist role="params">
<varlistentry><term><parameter>list_item</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GtkListItem"><type>GtkListItem</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="GtkListItem.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkListItem-end-selection" role="signal"><title>The <literal>&quot;end-selection&quot;</literal> signal</title>
<indexterm zone="GtkListItem-end-selection"><primary sortas="ListItem::end-selection">GtkListItem::end-selection</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-extend-selection" role="signal"><title>The <literal>&quot;extend-selection&quot;</literal> signal</title>
<indexterm zone="GtkListItem-extend-selection"><primary sortas="ListItem::extend-selection">GtkListItem::extend-selection</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link>  *listitem,
                                                        <link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
                                                        <link linkend="gfloat">gfloat</link>        position,
                                                        <link linkend="gboolean">gboolean</link>      auto_start_selection,
                                                        <link linkend="gpointer">gpointer</link>      user_data)                 : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>scroll_type</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auto_start_selection</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-scroll-horizontal" role="signal"><title>The <literal>&quot;scroll-horizontal&quot;</literal> signal</title>
<indexterm zone="GtkListItem-scroll-horizontal"><primary sortas="ListItem::scroll-horizontal">GtkListItem::scroll-horizontal</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link>  *listitem,
                                                        <link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
                                                        <link linkend="gfloat">gfloat</link>        position,
                                                        <link linkend="gpointer">gpointer</link>      user_data)        : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>scroll_type</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-scroll-vertical" role="signal"><title>The <literal>&quot;scroll-vertical&quot;</literal> signal</title>
<indexterm zone="GtkListItem-scroll-vertical"><primary sortas="ListItem::scroll-vertical">GtkListItem::scroll-vertical</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link>  *listitem,
                                                        <link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
                                                        <link linkend="gfloat">gfloat</link>        position,
                                                        <link linkend="gpointer">gpointer</link>      user_data)        : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>scroll_type</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-select-all" role="signal"><title>The <literal>&quot;select-all&quot;</literal> signal</title>
<indexterm zone="GtkListItem-select-all"><primary sortas="ListItem::select-all">GtkListItem::select-all</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-start-selection" role="signal"><title>The <literal>&quot;start-selection&quot;</literal> signal</title>
<indexterm zone="GtkListItem-start-selection"><primary sortas="ListItem::start-selection">GtkListItem::start-selection</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-toggle-add-mode" role="signal"><title>The <literal>&quot;toggle-add-mode&quot;</literal> signal</title>
<indexterm zone="GtkListItem-toggle-add-mode"><primary sortas="ListItem::toggle-add-mode">GtkListItem::toggle-add-mode</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-toggle-focus-row" role="signal"><title>The <literal>&quot;toggle-focus-row&quot;</literal> signal</title>
<indexterm zone="GtkListItem-toggle-focus-row"><primary sortas="ListItem::toggle-focus-row">GtkListItem::toggle-focus-row</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-undo-selection" role="signal"><title>The <literal>&quot;undo-selection&quot;</literal> signal</title>
<indexterm zone="GtkListItem-undo-selection"><primary sortas="ListItem::undo-selection">GtkListItem::undo-selection</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkListItem-unselect-all" role="signal"><title>The <literal>&quot;unselect-all&quot;</literal> signal</title>
<indexterm zone="GtkListItem-unselect-all"><primary sortas="ListItem::unselect-all">GtkListItem::unselect-all</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkListItem">GtkListItem</link> *listitem,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>listitem</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>


<refsect1 id="GtkListItem.see-also">
<title>See Also</title>
<para>
<variablelist>
<varlistentry>
<term><link linkend="GtkList"><type>GtkList</type></link></term>
<listitem><para>the parent list widget.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

</refentry>
