1
<refentry id="GtkListItem">
3
<refentrytitle role="top_of_page">GtkListItem</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>GTK Library</refmiscinfo>
9
<refname>GtkListItem</refname>
10
<refpurpose>An item in a GtkList</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="GtkListItem-struct">GtkListItem</link>;
23
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-list-item-new">gtk_list_item_new</link> (void);
24
<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);
25
<link linkend="void">void</link> <link linkend="gtk-list-item-select">gtk_list_item_select</link> (<link linkend="GtkListItem">GtkListItem</link> *list_item);
26
<link linkend="void">void</link> <link linkend="gtk-list-item-deselect">gtk_list_item_deselect</link> (<link linkend="GtkListItem">GtkListItem</link> *list_item);
32
<refsect1 role="object_hierarchy">
33
<title role="object_hierarchy.title">Object Hierarchy</title>
36
<link linkend="GObject">GObject</link>
37
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
38
+----<link linkend="GtkObject">GtkObject</link>
39
+----<link linkend="GtkWidget">GtkWidget</link>
40
+----<link linkend="GtkContainer">GtkContainer</link>
41
+----<link linkend="GtkBin">GtkBin</link>
42
+----<link linkend="GtkItem">GtkItem</link>
50
<refsect1 role="impl_interfaces">
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
53
GtkListItem implements
54
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
60
<refsect1 role="signal_proto">
61
<title role="signal_proto.title">Signals</title>
64
"<link linkend="GtkListItem-end-selection">end-selection</link>" : Run Last / Action
65
"<link linkend="GtkListItem-extend-selection">extend-selection</link>" : Run Last / Action
66
"<link linkend="GtkListItem-scroll-horizontal">scroll-horizontal</link>" : Run Last / Action
67
"<link linkend="GtkListItem-scroll-vertical">scroll-vertical</link>" : Run Last / Action
68
"<link linkend="GtkListItem-select-all">select-all</link>" : Run Last / Action
69
"<link linkend="GtkListItem-start-selection">start-selection</link>" : Run Last / Action
70
"<link linkend="GtkListItem-toggle-add-mode">toggle-add-mode</link>" : Run Last / Action
71
"<link linkend="GtkListItem-toggle-focus-row">toggle-focus-row</link>" : Run Last / Action
72
"<link linkend="GtkListItem-undo-selection">undo-selection</link>" : Run Last / Action
73
"<link linkend="GtkListItem-unselect-all">unselect-all</link>" : Run Last / Action
78
<refsect1 role="desc">
79
<title role="desc.title">Description</title>
81
The <link linkend="GtkListItem"><type>GtkListItem</type></link> widget is used for each item in a <link linkend="GtkList"><type>GtkList</type></link>.
84
GtkList has has been deprecated since GTK+ 2.0 and should not be used
85
in newly written code. Use <link linkend="GtkTreeView"><type>GtkTreeView</type></link> instead.
89
<refsect1 role="details">
90
<title role="details.title">Details</title>
92
<title><anchor id="GtkListItem-struct" role="struct"/>GtkListItem</title>
93
<indexterm role="deprecated"><primary>GtkListItem</primary></indexterm><programlisting>typedef struct _GtkListItem GtkListItem;</programlisting>
94
<warning><para><literal>GtkListItem</literal> is deprecated and should not be used in newly-written code.</para></warning>
96
The <link linkend="GtkListItem"><type>GtkListItem</type></link> struct contains private data only, and should
97
only be accessed using the functions below.
100
<title><anchor id="gtk-list-item-new" role="function" condition="deprecated:"/>gtk_list_item_new ()</title>
101
<indexterm role="deprecated"><primary>gtk_list_item_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_list_item_new (void);</programlisting>
102
<warning><para><literal>gtk_list_item_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
104
Creates a new <link linkend="GtkListitem"><type>GtkListitem</type></link>.
105
</para><variablelist role="params">
106
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="GtkListItem"><type>GtkListItem</type></link>.
109
</simpara></listitem></varlistentry>
110
</variablelist></refsect2>
112
<title><anchor id="gtk-list-item-new-with-label" role="function" condition="deprecated:"/>gtk_list_item_new_with_label ()</title>
113
<indexterm role="deprecated"><primary>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>
114
<warning><para><literal>gtk_list_item_new_with_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
116
Creates a new <link linkend="GtkListItem"><type>GtkListItem</type></link> with a child label containing the given string.
117
</para><variablelist role="params">
118
<varlistentry><term><parameter>label</parameter> :</term>
119
<listitem><simpara>the string to use for the child label.
120
</simpara></listitem></varlistentry>
121
<varlistentry><term><emphasis>Returns</emphasis> :</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
122
<parameter>label</parameter>.
125
</simpara></listitem></varlistentry>
126
</variablelist></refsect2>
128
<title><anchor id="gtk-list-item-select" role="function" condition="deprecated:"/>gtk_list_item_select ()</title>
129
<indexterm role="deprecated"><primary>gtk_list_item_select</primary></indexterm><programlisting><link linkend="void">void</link> gtk_list_item_select (<link linkend="GtkListItem">GtkListItem</link> *list_item);</programlisting>
130
<warning><para><literal>gtk_list_item_select</literal> is deprecated and should not be used in newly-written code.</para></warning>
132
Selects the item, by emitting the item's "select" signal.
133
Depending on the selection mode of the list, this may cause other items to
135
</para><variablelist role="params">
136
<varlistentry><term><parameter>list_item</parameter> :</term>
137
<listitem><simpara>a <link linkend="GtkListItem"><type>GtkListItem</type></link>.
140
</simpara></listitem></varlistentry>
141
</variablelist></refsect2>
143
<title><anchor id="gtk-list-item-deselect" role="function" condition="deprecated:"/>gtk_list_item_deselect ()</title>
144
<indexterm role="deprecated"><primary>gtk_list_item_deselect</primary></indexterm><programlisting><link linkend="void">void</link> gtk_list_item_deselect (<link linkend="GtkListItem">GtkListItem</link> *list_item);</programlisting>
145
<warning><para><literal>gtk_list_item_deselect</literal> is deprecated and should not be used in newly-written code.</para></warning>
147
Deselects the item, by emitting the item's "deselect" signal.
148
</para><variablelist role="params">
149
<varlistentry><term><parameter>list_item</parameter> :</term>
150
<listitem><simpara>a <link linkend="GtkListItem"><type>GtkListItem</type></link>.
153
</simpara></listitem></varlistentry>
154
</variablelist></refsect2>
158
<refsect1 role="signals">
159
<title role="signals.title">Signal Details</title>
160
<refsect2><title><anchor id="GtkListItem-end-selection"/>The "end-selection" signal</title>
161
<indexterm><primary>GtkListItem::end-selection</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
162
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
165
</para><variablelist role="params">
166
<varlistentry><term><parameter>listitem</parameter> :</term>
167
<listitem><simpara>the object which received the signal.
169
</simpara></listitem></varlistentry>
170
<varlistentry><term><parameter>user_data</parameter> :</term>
171
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
172
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-extend-selection"/>The "extend-selection" signal</title>
173
<indexterm><primary>GtkListItem::extend-selection</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
174
<link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
175
<link linkend="gfloat">gfloat</link> position,
176
<link linkend="gboolean">gboolean</link> auto_start_selection,
177
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
180
</para><variablelist role="params">
181
<varlistentry><term><parameter>listitem</parameter> :</term>
182
<listitem><simpara>the object which received the signal.
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><parameter>scroll_type</parameter> :</term>
186
</simpara></listitem></varlistentry>
187
<varlistentry><term><parameter>position</parameter> :</term>
189
</simpara></listitem></varlistentry>
190
<varlistentry><term><parameter>auto_start_selection</parameter> :</term>
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>user_data</parameter> :</term>
195
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
196
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-scroll-horizontal"/>The "scroll-horizontal" signal</title>
197
<indexterm><primary>GtkListItem::scroll-horizontal</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
198
<link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
199
<link linkend="gfloat">gfloat</link> position,
200
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
203
</para><variablelist role="params">
204
<varlistentry><term><parameter>listitem</parameter> :</term>
205
<listitem><simpara>the object which received the signal.
206
</simpara></listitem></varlistentry>
207
<varlistentry><term><parameter>scroll_type</parameter> :</term>
209
</simpara></listitem></varlistentry>
210
<varlistentry><term><parameter>position</parameter> :</term>
213
</simpara></listitem></varlistentry>
214
<varlistentry><term><parameter>user_data</parameter> :</term>
215
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
216
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-scroll-vertical"/>The "scroll-vertical" signal</title>
217
<indexterm><primary>GtkListItem::scroll-vertical</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
218
<link linkend="GtkScrollType">GtkScrollType</link> scroll_type,
219
<link linkend="gfloat">gfloat</link> position,
220
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
223
</para><variablelist role="params">
224
<varlistentry><term><parameter>listitem</parameter> :</term>
225
<listitem><simpara>the object which received the signal.
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><parameter>scroll_type</parameter> :</term>
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>position</parameter> :</term>
233
</simpara></listitem></varlistentry>
234
<varlistentry><term><parameter>user_data</parameter> :</term>
235
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
236
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-select-all"/>The "select-all" signal</title>
237
<indexterm><primary>GtkListItem::select-all</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
238
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
241
</para><variablelist role="params">
242
<varlistentry><term><parameter>listitem</parameter> :</term>
243
<listitem><simpara>the object which received the signal.
245
</simpara></listitem></varlistentry>
246
<varlistentry><term><parameter>user_data</parameter> :</term>
247
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
248
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-start-selection"/>The "start-selection" signal</title>
249
<indexterm><primary>GtkListItem::start-selection</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
250
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
253
</para><variablelist role="params">
254
<varlistentry><term><parameter>listitem</parameter> :</term>
255
<listitem><simpara>the object which received the signal.
257
</simpara></listitem></varlistentry>
258
<varlistentry><term><parameter>user_data</parameter> :</term>
259
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
260
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-toggle-add-mode"/>The "toggle-add-mode" signal</title>
261
<indexterm><primary>GtkListItem::toggle-add-mode</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
262
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
265
</para><variablelist role="params">
266
<varlistentry><term><parameter>listitem</parameter> :</term>
267
<listitem><simpara>the object which received the signal.
269
</simpara></listitem></varlistentry>
270
<varlistentry><term><parameter>user_data</parameter> :</term>
271
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
272
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-toggle-focus-row"/>The "toggle-focus-row" signal</title>
273
<indexterm><primary>GtkListItem::toggle-focus-row</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
274
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
277
</para><variablelist role="params">
278
<varlistentry><term><parameter>listitem</parameter> :</term>
279
<listitem><simpara>the object which received the signal.
281
</simpara></listitem></varlistentry>
282
<varlistentry><term><parameter>user_data</parameter> :</term>
283
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
284
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-undo-selection"/>The "undo-selection" signal</title>
285
<indexterm><primary>GtkListItem::undo-selection</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
286
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
289
</para><variablelist role="params">
290
<varlistentry><term><parameter>listitem</parameter> :</term>
291
<listitem><simpara>the object which received the signal.
293
</simpara></listitem></varlistentry>
294
<varlistentry><term><parameter>user_data</parameter> :</term>
295
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
296
</variablelist></refsect2><refsect2><title><anchor id="GtkListItem-unselect-all"/>The "unselect-all" signal</title>
297
<indexterm><primary>GtkListItem::unselect-all</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkListItem">GtkListItem</link> *listitem,
298
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
301
</para><variablelist role="params">
302
<varlistentry><term><parameter>listitem</parameter> :</term>
303
<listitem><simpara>the object which received the signal.
305
</simpara></listitem></varlistentry>
306
<varlistentry><term><parameter>user_data</parameter> :</term>
307
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
308
</variablelist></refsect2>
313
<title>See Also</title>
318
<term><link linkend="GtkList"><type>GtkList</type></link></term>
319
<listitem><para>the parent list widget.</para></listitem>