1
<refentry id="GtkTreeItem">
3
<refentrytitle role="top_of_page">GtkTreeItem</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>GTK Library</refmiscinfo>
9
<refname>GtkTreeItem</refname>
10
<refpurpose>The widget used for items in a GtkTree</refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
<refsynopsisdiv role="synopsis">
15
<title role="synopsis.title">Synopsis</title>
19
#include <gtk/gtk.h>
22
<link linkend="GtkTreeItem-struct">GtkTreeItem</link>;
23
#define <link linkend="GTK-TREE-ITEM-SUBTREE:CAPS">GTK_TREE_ITEM_SUBTREE</link> (obj)
24
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-tree-item-new">gtk_tree_item_new</link> (void);
25
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-tree-item-new-with-label">gtk_tree_item_new_with_label</link> (const <link linkend="gchar">gchar</link> *label);
26
<link linkend="void">void</link> <link linkend="gtk-tree-item-set-subtree">gtk_tree_item_set_subtree</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item,
27
<link linkend="GtkWidget">GtkWidget</link> *subtree);
28
<link linkend="void">void</link> <link linkend="gtk-tree-item-remove-subtree">gtk_tree_item_remove_subtree</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);
29
<link linkend="void">void</link> <link linkend="gtk-tree-item-select">gtk_tree_item_select</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);
30
<link linkend="void">void</link> <link linkend="gtk-tree-item-deselect">gtk_tree_item_deselect</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);
31
<link linkend="void">void</link> <link linkend="gtk-tree-item-expand">gtk_tree_item_expand</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);
32
<link linkend="void">void</link> <link linkend="gtk-tree-item-collapse">gtk_tree_item_collapse</link> (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);
38
<refsect1 role="object_hierarchy">
39
<title role="object_hierarchy.title">Object Hierarchy</title>
42
<link linkend="GObject">GObject</link>
43
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
44
+----<link linkend="GtkObject">GtkObject</link>
45
+----<link linkend="GtkWidget">GtkWidget</link>
46
+----<link linkend="GtkContainer">GtkContainer</link>
47
+----<link linkend="GtkBin">GtkBin</link>
48
+----<link linkend="GtkItem">GtkItem</link>
56
<refsect1 role="impl_interfaces">
57
<title role="impl_interfaces.title">Implemented Interfaces</title>
59
GtkTreeItem implements
60
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
66
<refsect1 role="signal_proto">
67
<title role="signal_proto.title">Signals</title>
70
"<link linkend="GtkTreeItem-collapse">collapse</link>" : Run First
71
"<link linkend="GtkTreeItem-expand">expand</link>" : Run First
76
<refsect1 role="desc">
77
<title role="desc.title">Description</title>
81
<link linkend="GtkTree"><type>GtkTree</type></link> is deprecated and unsupported. It is known to be
82
buggy. To use it, you must define the symbol <link linkend="GTK-ENABLE-BROKEN:CAPS"><literal>GTK_ENABLE_BROKEN</literal></link>
83
prior to including the GTK+ header files. Use <link linkend="GtkTreeView"><type>GtkTreeView</type></link> instead.
89
<refsect1 role="details">
90
<title role="details.title">Details</title>
92
<title><anchor id="GtkTreeItem-struct" role="struct"/>GtkTreeItem</title>
93
<indexterm role="deprecated"><primary>GtkTreeItem</primary></indexterm><programlisting>typedef struct _GtkTreeItem GtkTreeItem;</programlisting>
94
<warning><para><literal>GtkTreeItem</literal> is deprecated and should not be used in newly-written code.</para></warning>
99
<title><anchor id="GTK-TREE-ITEM-SUBTREE:CAPS" role="macro" condition="deprecated:"/>GTK_TREE_ITEM_SUBTREE()</title>
100
<indexterm role="deprecated"><primary>GTK_TREE_ITEM_SUBTREE</primary></indexterm><programlisting>#define GTK_TREE_ITEM_SUBTREE(obj) (GTK_TREE_ITEM(obj)->subtree)
102
<warning><para><literal>GTK_TREE_ITEM_SUBTREE</literal> is deprecated and should not be used in newly-written code.</para></warning>
105
</para><variablelist role="params">
106
<varlistentry><term><parameter>obj</parameter> :</term>
110
</simpara></listitem></varlistentry>
111
</variablelist></refsect2>
113
<title><anchor id="gtk-tree-item-new" role="function" condition="deprecated:"/>gtk_tree_item_new ()</title>
114
<indexterm role="deprecated"><primary>gtk_tree_item_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_tree_item_new (void);</programlisting>
115
<warning><para><literal>gtk_tree_item_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
118
</para><variablelist role="params">
119
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
122
</simpara></listitem></varlistentry>
123
</variablelist></refsect2>
125
<title><anchor id="gtk-tree-item-new-with-label" role="function" condition="deprecated:"/>gtk_tree_item_new_with_label ()</title>
126
<indexterm role="deprecated"><primary>gtk_tree_item_new_with_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_tree_item_new_with_label (const <link linkend="gchar">gchar</link> *label);</programlisting>
127
<warning><para><literal>gtk_tree_item_new_with_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
130
</para><variablelist role="params">
131
<varlistentry><term><parameter>label</parameter> :</term>
133
</simpara></listitem></varlistentry>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
137
</simpara></listitem></varlistentry>
138
</variablelist></refsect2>
140
<title><anchor id="gtk-tree-item-set-subtree" role="function" condition="deprecated:"/>gtk_tree_item_set_subtree ()</title>
141
<indexterm role="deprecated"><primary>gtk_tree_item_set_subtree</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_set_subtree (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item,
142
<link linkend="GtkWidget">GtkWidget</link> *subtree);</programlisting>
143
<warning><para><literal>gtk_tree_item_set_subtree</literal> is deprecated and should not be used in newly-written code.</para></warning>
146
</para><variablelist role="params">
147
<varlistentry><term><parameter>tree_item</parameter> :</term>
149
</simpara></listitem></varlistentry>
150
<varlistentry><term><parameter>subtree</parameter> :</term>
154
</simpara></listitem></varlistentry>
155
</variablelist></refsect2>
157
<title><anchor id="gtk-tree-item-remove-subtree" role="function" condition="deprecated:"/>gtk_tree_item_remove_subtree ()</title>
158
<indexterm role="deprecated"><primary>gtk_tree_item_remove_subtree</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_remove_subtree (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);</programlisting>
159
<warning><para><literal>gtk_tree_item_remove_subtree</literal> is deprecated and should not be used in newly-written code.</para></warning>
162
</para><variablelist role="params">
163
<varlistentry><term><parameter>tree_item</parameter> :</term>
167
</simpara></listitem></varlistentry>
168
</variablelist></refsect2>
170
<title><anchor id="gtk-tree-item-select" role="function" condition="deprecated:"/>gtk_tree_item_select ()</title>
171
<indexterm role="deprecated"><primary>gtk_tree_item_select</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_select (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);</programlisting>
172
<warning><para><literal>gtk_tree_item_select</literal> is deprecated and should not be used in newly-written code.</para></warning>
175
</para><variablelist role="params">
176
<varlistentry><term><parameter>tree_item</parameter> :</term>
180
</simpara></listitem></varlistentry>
181
</variablelist></refsect2>
183
<title><anchor id="gtk-tree-item-deselect" role="function" condition="deprecated:"/>gtk_tree_item_deselect ()</title>
184
<indexterm role="deprecated"><primary>gtk_tree_item_deselect</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_deselect (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);</programlisting>
185
<warning><para><literal>gtk_tree_item_deselect</literal> is deprecated and should not be used in newly-written code.</para></warning>
188
</para><variablelist role="params">
189
<varlistentry><term><parameter>tree_item</parameter> :</term>
193
</simpara></listitem></varlistentry>
194
</variablelist></refsect2>
196
<title><anchor id="gtk-tree-item-expand" role="function" condition="deprecated:"/>gtk_tree_item_expand ()</title>
197
<indexterm role="deprecated"><primary>gtk_tree_item_expand</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_expand (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);</programlisting>
198
<warning><para><literal>gtk_tree_item_expand</literal> is deprecated and should not be used in newly-written code.</para></warning>
201
</para><variablelist role="params">
202
<varlistentry><term><parameter>tree_item</parameter> :</term>
206
</simpara></listitem></varlistentry>
207
</variablelist></refsect2>
209
<title><anchor id="gtk-tree-item-collapse" role="function" condition="deprecated:"/>gtk_tree_item_collapse ()</title>
210
<indexterm role="deprecated"><primary>gtk_tree_item_collapse</primary></indexterm><programlisting><link linkend="void">void</link> gtk_tree_item_collapse (<link linkend="GtkTreeItem">GtkTreeItem</link> *tree_item);</programlisting>
211
<warning><para><literal>gtk_tree_item_collapse</literal> is deprecated and should not be used in newly-written code.</para></warning>
214
</para><variablelist role="params">
215
<varlistentry><term><parameter>tree_item</parameter> :</term>
219
</simpara></listitem></varlistentry>
220
</variablelist></refsect2>
224
<refsect1 role="signals">
225
<title role="signals.title">Signal Details</title>
226
<refsect2><title><anchor id="GtkTreeItem-collapse"/>The "collapse" signal</title>
227
<indexterm><primary>GtkTreeItem::collapse</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkTreeItem">GtkTreeItem</link> *treeitem,
228
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
231
</para><variablelist role="params">
232
<varlistentry><term><parameter>treeitem</parameter> :</term>
233
<listitem><simpara>the object which received the signal.
235
</simpara></listitem></varlistentry>
236
<varlistentry><term><parameter>user_data</parameter> :</term>
237
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
238
</variablelist></refsect2><refsect2><title><anchor id="GtkTreeItem-expand"/>The "expand" signal</title>
239
<indexterm><primary>GtkTreeItem::expand</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkTreeItem">GtkTreeItem</link> *treeitem,
240
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
243
</para><variablelist role="params">
244
<varlistentry><term><parameter>treeitem</parameter> :</term>
245
<listitem><simpara>the object which received the signal.
247
</simpara></listitem></varlistentry>
248
<varlistentry><term><parameter>user_data</parameter> :</term>
249
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
250
</variablelist></refsect2>