1
<refentry id="GtkItem">
3
<refentrytitle role="top_of_page">GtkItem</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>GTK Library</refmiscinfo>
9
<refname>GtkItem</refname>
10
<refpurpose>Abstract base class for GtkMenuItem, GtkListItem and GtkTreeItem</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="GtkItem-struct">GtkItem</link>;
23
<link linkend="void">void</link> <link linkend="gtk-item-select">gtk_item_select</link> (<link linkend="GtkItem">GtkItem</link> *item);
24
<link linkend="void">void</link> <link linkend="gtk-item-deselect">gtk_item_deselect</link> (<link linkend="GtkItem">GtkItem</link> *item);
25
<link linkend="void">void</link> <link linkend="gtk-item-toggle">gtk_item_toggle</link> (<link linkend="GtkItem">GtkItem</link> *item);
31
<refsect1 role="object_hierarchy">
32
<title role="object_hierarchy.title">Object Hierarchy</title>
35
<link linkend="GObject">GObject</link>
36
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
37
+----<link linkend="GtkObject">GtkObject</link>
38
+----<link linkend="GtkWidget">GtkWidget</link>
39
+----<link linkend="GtkContainer">GtkContainer</link>
40
+----<link linkend="GtkBin">GtkBin</link>
42
+----<link linkend="GtkMenuItem">GtkMenuItem</link>
43
+----<link linkend="GtkListItem">GtkListItem</link>
44
+----<link linkend="GtkTreeItem">GtkTreeItem</link>
51
<refsect1 role="impl_interfaces">
52
<title role="impl_interfaces.title">Implemented Interfaces</title>
55
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
61
<refsect1 role="signal_proto">
62
<title role="signal_proto.title">Signals</title>
65
"<link linkend="GtkItem-deselect">deselect</link>" : Run First
66
"<link linkend="GtkItem-select">select</link>" : Run First
67
"<link linkend="GtkItem-toggle">toggle</link>" : Run First
72
<refsect1 role="desc">
73
<title role="desc.title">Description</title>
75
The <link linkend="GtkItem"><type>GtkItem</type></link> widget is an abstract base class for <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>, <link linkend="GtkListItem"><type>GtkListItem</type></link>
76
and <link linkend="GtkTreeItem"><type>GtkTreeItem</type></link>.
80
<refsect1 role="details">
81
<title role="details.title">Details</title>
83
<title><anchor id="GtkItem-struct" role="struct"/>GtkItem</title>
84
<indexterm><primary>GtkItem</primary></indexterm><programlisting>typedef struct _GtkItem GtkItem;</programlisting>
86
The <link linkend="GtkItem-struct"><type>GtkItem</type></link> struct contains private data only, and
87
should be accessed using the functions below.
90
<title><anchor id="gtk-item-select" role="function"/>gtk_item_select ()</title>
91
<indexterm><primary>gtk_item_select</primary></indexterm><programlisting><link linkend="void">void</link> gtk_item_select (<link linkend="GtkItem">GtkItem</link> *item);</programlisting>
93
Emits the "select" signal on the given item.
94
</para><variablelist role="params">
95
<varlistentry><term><parameter>item</parameter> :</term>
96
<listitem><simpara>a <link linkend="GtkItem"><type>GtkItem</type></link>.
99
</simpara></listitem></varlistentry>
100
</variablelist></refsect2>
102
<title><anchor id="gtk-item-deselect" role="function"/>gtk_item_deselect ()</title>
103
<indexterm><primary>gtk_item_deselect</primary></indexterm><programlisting><link linkend="void">void</link> gtk_item_deselect (<link linkend="GtkItem">GtkItem</link> *item);</programlisting>
105
Emits the "deselect" signal on the given item.
106
</para><variablelist role="params">
107
<varlistentry><term><parameter>item</parameter> :</term>
108
<listitem><simpara>a <link linkend="GtkItem"><type>GtkItem</type></link>.
111
</simpara></listitem></varlistentry>
112
</variablelist></refsect2>
114
<title><anchor id="gtk-item-toggle" role="function"/>gtk_item_toggle ()</title>
115
<indexterm><primary>gtk_item_toggle</primary></indexterm><programlisting><link linkend="void">void</link> gtk_item_toggle (<link linkend="GtkItem">GtkItem</link> *item);</programlisting>
117
Emits the "toggle" signal on the given item.
118
</para><variablelist role="params">
119
<varlistentry><term><parameter>item</parameter> :</term>
120
<listitem><simpara>a <link linkend="GtkItem"><type>GtkItem</type></link>.
123
</simpara></listitem></varlistentry>
124
</variablelist></refsect2>
128
<refsect1 role="signals">
129
<title role="signals.title">Signal Details</title>
130
<refsect2><title><anchor id="GtkItem-deselect"/>The "deselect" signal</title>
131
<indexterm><primary>GtkItem::deselect</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkItem">GtkItem</link> *item,
132
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
134
Emitted when the item is deselected.
135
</para><variablelist role="params">
136
<varlistentry><term><parameter>item</parameter> :</term>
137
<listitem><simpara>the object which received the signal.
139
</simpara></listitem></varlistentry>
140
<varlistentry><term><parameter>user_data</parameter> :</term>
141
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
142
</variablelist></refsect2><refsect2><title><anchor id="GtkItem-select"/>The "select" signal</title>
143
<indexterm><primary>GtkItem::select</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkItem">GtkItem</link> *item,
144
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
146
Emitted when the item is selected.
147
</para><variablelist role="params">
148
<varlistentry><term><parameter>item</parameter> :</term>
149
<listitem><simpara>the object which received the signal.
151
</simpara></listitem></varlistentry>
152
<varlistentry><term><parameter>user_data</parameter> :</term>
153
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
154
</variablelist></refsect2><refsect2><title><anchor id="GtkItem-toggle"/>The "toggle" signal</title>
155
<indexterm><primary>GtkItem::toggle</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GtkItem">GtkItem</link> *item,
156
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
158
Emitted when the item is toggled.
159
</para><variablelist role="params">
160
<varlistentry><term><parameter>item</parameter> :</term>
161
<listitem><simpara>the object which received the signal.
163
</simpara></listitem></varlistentry>
164
<varlistentry><term><parameter>user_data</parameter> :</term>
165
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
166
</variablelist></refsect2>