1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimpwidgets-gimpoldwidgets">
7
<refentrytitle>gimpoldwidgets</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
13
<refname>gimpoldwidgets</refname><refpurpose>Old API that is still available but declared as deprecated.</refpurpose>
16
<refsynopsisdiv><title>Synopsis</title>
22
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-option-menu-new">gimp_int_option_menu_new</link> (<link linkend="gboolean">gboolean</link> menu_only,
23
<link linkend="GCallback">GCallback</link> menu_item_callback,
24
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
25
<link linkend="gint">gint</link> initial,
27
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-history">gimp_int_option_menu_set_history</link>
28
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
29
<link linkend="gint">gint</link> item_data);
30
<link linkend="gboolean">gboolean</link> (<link linkend="GimpIntOptionMenuSensitivityCallback">*GimpIntOptionMenuSensitivityCallback</link>)
31
(<link linkend="gint">gint</link> item_data,
32
<link linkend="gpointer">gpointer</link> callback_data);
33
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-sensitive">gimp_int_option_menu_set_sensitive</link>
34
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
35
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
36
<link linkend="gpointer">gpointer</link> callback_data);
37
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new">gimp_option_menu_new</link> (<link linkend="gboolean">gboolean</link> menu_only,
39
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new2">gimp_option_menu_new2</link> (<link linkend="gboolean">gboolean</link> menu_only,
40
<link linkend="GCallback">GCallback</link> menu_item_callback,
41
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
42
<link linkend="gpointer">gpointer</link> initial,
44
<link linkend="void">void</link> <link linkend="gimp-option-menu-set-history">gimp_option_menu_set_history</link> (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
45
<link linkend="gpointer">gpointer</link> item_data);
46
<link linkend="gboolean">gboolean</link> (<link linkend="GimpOptionMenuSensitivityCallback">*GimpOptionMenuSensitivityCallback</link>)
47
(<link linkend="gpointer">gpointer</link> item_data,
48
<link linkend="gpointer">gpointer</link> callback_data);
49
<link linkend="void">void</link> <link linkend="gimp-option-menu-set-sensitive">gimp_option_menu_set_sensitive</link> (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
50
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
51
<link linkend="gpointer">gpointer</link> callback_data);
52
<link linkend="void">void</link> <link linkend="gimp-menu-item-update">gimp_menu_item_update</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
53
<link linkend="gpointer">gpointer</link> data);
66
<title>Description</title>
68
These functions are not defined if you <link linkend="define"><type>define</type></link> GIMP_DISABLE_DEPRECATED.
73
<title>Details</title>
75
<title><anchor id="gimp-int-option-menu-new"/>gimp_int_option_menu_new ()</title>
76
<indexterm role="deprecated"><primary>gimp_int_option_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_option_menu_new (<link linkend="gboolean">gboolean</link> menu_only,
77
<link linkend="GCallback">GCallback</link> menu_item_callback,
78
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
79
<link linkend="gint">gint</link> initial,
80
...);</programlisting>
81
<warning><para><literal>gimp_int_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
83
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>. This
84
function does the same thing as the deprecated function
85
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>, but it takes integers as <parameter>item_data</parameter>
86
instead of pointers, since that is a very common case (mapping an
87
enum to a menu).</para>
90
</para><variablelist role="params">
91
<varlistentry><term><parameter>menu_only</parameter> :</term>
92
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
93
</simpara></listitem></varlistentry>
94
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
95
<listitem><simpara> The callback each menu item's "activate" signal will
97
</simpara></listitem></varlistentry>
98
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
100
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
101
</simpara></listitem></varlistentry>
102
<varlistentry><term><parameter>initial</parameter> :</term>
103
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
104
</simpara></listitem></varlistentry>
105
<varlistentry><term><parameter>...</parameter> :</term>
106
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
107
</simpara></listitem></varlistentry>
108
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
109
</simpara></listitem></varlistentry>
110
</variablelist></refsect2>
112
<title><anchor id="gimp-int-option-menu-set-history"/>gimp_int_option_menu_set_history ()</title>
113
<indexterm role="deprecated"><primary>gimp_int_option_menu_set_history</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_history
114
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
115
<link linkend="gint">gint</link> item_data);</programlisting>
116
<warning><para><literal>gimp_int_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
118
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one with the
119
matching <parameter>item_data</parameter>. Probably only makes sense to use with a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link>
120
that was created using <link linkend="gimp-int-option-menu-new"><function>gimp_int_option_menu_new()</function></link>. This function does the
121
same thing as <link linkend="gimp-option-menu-set-history"><function>gimp_option_menu_set_history()</function></link>, but takes integers as
122
<parameter>item_data</parameter> instead of pointers.</para>
125
</para><variablelist role="params">
126
<varlistentry><term><parameter>option_menu</parameter> :</term>
127
<listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-int-option-menu-new"><function>gimp_int_option_menu_new()</function></link>.
128
</simpara></listitem></varlistentry>
129
<varlistentry><term><parameter>item_data</parameter> :</term>
130
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
131
</simpara></listitem></varlistentry>
132
</variablelist></refsect2>
134
<title><anchor id="GimpIntOptionMenuSensitivityCallback"/>GimpIntOptionMenuSensitivityCallback ()</title>
135
<indexterm role="deprecated"><primary>GimpIntOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpIntOptionMenuSensitivityCallback)
136
(<link linkend="gint">gint</link> item_data,
137
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
138
<warning><para><literal>GimpIntOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
141
</para><variablelist role="params">
142
<varlistentry><term><parameter>item_data</parameter> :</term>
144
</simpara></listitem></varlistentry>
145
<varlistentry><term><parameter>callback_data</parameter> :</term>
147
</simpara></listitem></varlistentry>
148
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
151
</simpara></listitem></varlistentry>
152
</variablelist></refsect2>
154
<title><anchor id="gimp-int-option-menu-set-sensitive"/>gimp_int_option_menu_set_sensitive ()</title>
155
<indexterm role="deprecated"><primary>gimp_int_option_menu_set_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_sensitive
156
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
157
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
158
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
159
<warning><para><literal>gimp_int_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
161
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
162
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
163
according to the return value of this function. This function does the
164
same thing as <link linkend="gimp-option-menu-set-sensitive"><function>gimp_option_menu_set_sensitive()</function></link>, but takes integers as
165
<parameter>item_data</parameter> instead of pointers.</para>
168
</para><variablelist role="params">
169
<varlistentry><term><parameter>option_menu</parameter> :</term>
170
<listitem><simpara> a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
171
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
172
</simpara></listitem></varlistentry>
173
<varlistentry><term><parameter>callback</parameter> :</term>
174
<listitem><simpara> a function called for each item in the menu to determine the
175
the sensitivity state.
176
</simpara></listitem></varlistentry>
177
<varlistentry><term><parameter>callback_data</parameter> :</term>
178
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
179
</simpara></listitem></varlistentry>
180
</variablelist></refsect2>
182
<title><anchor id="gimp-option-menu-new"/>gimp_option_menu_new ()</title>
183
<indexterm role="deprecated"><primary>gimp_option_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_option_menu_new (<link linkend="gboolean">gboolean</link> menu_only,
184
...);</programlisting>
185
<warning><para><literal>gimp_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
187
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
190
</para><variablelist role="params">
191
<varlistentry><term><parameter>menu_only</parameter> :</term>
192
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>...</parameter> :</term>
195
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
196
</simpara></listitem></varlistentry>
197
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
198
</simpara></listitem></varlistentry>
199
</variablelist></refsect2>
201
<title><anchor id="gimp-option-menu-new2"/>gimp_option_menu_new2 ()</title>
202
<indexterm role="deprecated"><primary>gimp_option_menu_new2</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_option_menu_new2 (<link linkend="gboolean">gboolean</link> menu_only,
203
<link linkend="GCallback">GCallback</link> menu_item_callback,
204
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
205
<link linkend="gpointer">gpointer</link> initial,
206
...);</programlisting>
207
<warning><para><literal>gimp_option_menu_new2</literal> is deprecated and should not be used in newly-written code.</para></warning>
209
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
212
</para><variablelist role="params">
213
<varlistentry><term><parameter>menu_only</parameter> :</term>
214
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
215
</simpara></listitem></varlistentry>
216
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
217
<listitem><simpara> The callback each menu item's "activate" signal will
219
</simpara></listitem></varlistentry>
220
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
222
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
223
</simpara></listitem></varlistentry>
224
<varlistentry><term><parameter>initial</parameter> :</term>
225
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><parameter>...</parameter> :</term>
228
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
231
</simpara></listitem></varlistentry>
232
</variablelist></refsect2>
234
<title><anchor id="gimp-option-menu-set-history"/>gimp_option_menu_set_history ()</title>
235
<indexterm role="deprecated"><primary>gimp_option_menu_set_history</primary></indexterm><programlisting><link linkend="void">void</link> gimp_option_menu_set_history (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
236
<link linkend="gpointer">gpointer</link> item_data);</programlisting>
237
<warning><para><literal>gimp_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
239
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one
240
with the matching <parameter>item_data</parameter>. Probably only makes sense to use with
241
a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> that was created using <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
242
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.</para>
245
</para><variablelist role="params">
246
<varlistentry><term><parameter>option_menu</parameter> :</term>
247
<listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
248
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
249
</simpara></listitem></varlistentry>
250
<varlistentry><term><parameter>item_data</parameter> :</term>
251
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
252
</simpara></listitem></varlistentry>
253
</variablelist></refsect2>
255
<title><anchor id="GimpOptionMenuSensitivityCallback"/>GimpOptionMenuSensitivityCallback ()</title>
256
<indexterm role="deprecated"><primary>GimpOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpOptionMenuSensitivityCallback)
257
(<link linkend="gpointer">gpointer</link> item_data,
258
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
259
<warning><para><literal>GimpOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
262
</para><variablelist role="params">
263
<varlistentry><term><parameter>item_data</parameter> :</term>
265
</simpara></listitem></varlistentry>
266
<varlistentry><term><parameter>callback_data</parameter> :</term>
268
</simpara></listitem></varlistentry>
269
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
272
</simpara></listitem></varlistentry>
273
</variablelist></refsect2>
275
<title><anchor id="gimp-option-menu-set-sensitive"/>gimp_option_menu_set_sensitive ()</title>
276
<indexterm role="deprecated"><primary>gimp_option_menu_set_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_option_menu_set_sensitive (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
277
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
278
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
279
<warning><para><literal>gimp_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
281
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
282
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
283
according to the return value of this function.</para>
286
</para><variablelist role="params">
287
<varlistentry><term><parameter>option_menu</parameter> :</term>
288
<listitem><simpara> a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
289
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
290
</simpara></listitem></varlistentry>
291
<varlistentry><term><parameter>callback</parameter> :</term>
292
<listitem><simpara> a function called for each item in the menu to determine the
293
the sensitivity state.
294
</simpara></listitem></varlistentry>
295
<varlistentry><term><parameter>callback_data</parameter> :</term>
296
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
297
</simpara></listitem></varlistentry>
298
</variablelist></refsect2>
300
<title><anchor id="gimp-menu-item-update"/>gimp_menu_item_update ()</title>
301
<indexterm role="deprecated"><primary>gimp_menu_item_update</primary></indexterm><programlisting><link linkend="void">void</link> gimp_menu_item_update (<link linkend="GtkWidget">GtkWidget</link> *widget,
302
<link linkend="gpointer">gpointer</link> data);</programlisting>
303
<warning><para><literal>gimp_menu_item_update</literal> is deprecated and should not be used in newly-written code.</para></warning>
308
</para><variablelist role="params">
309
<varlistentry><term><parameter>widget</parameter> :</term>
310
<listitem><simpara> A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>.
311
</simpara></listitem></varlistentry>
312
<varlistentry><term><parameter>data</parameter> :</term>
313
<listitem><simpara> A pointer to a <link linkend="gint"><type>gint</type></link> variable which will store the value of
314
GPOINTER_TO_INT (g_object_get_data (<parameter>widget</parameter>, "gimp-item-data")).
315
</simpara></listitem></varlistentry>
316
</variablelist></refsect2>
323
<title>See Also</title>