1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimpwidgets-gimpoldwidgets">
<refmeta>
<refentrytitle id="top_of_page">gimpoldwidgets</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpoldwidgets</refname>
<refpurpose>Old API that is still available but declared as deprecated.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<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,
<link linkend="GCallback">GCallback</link> menu_item_callback,
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
<link linkend="gint">gint</link> initial,
...);
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-history">gimp_int_option_menu_set_history</link>
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
<link linkend="gint">gint</link> item_data);
<link linkend="gboolean">gboolean</link> (<link linkend="GimpIntOptionMenuSensitivityCallback">*GimpIntOptionMenuSensitivityCallback</link>)
(<link linkend="gint">gint</link> item_data,
<link linkend="gpointer">gpointer</link> callback_data);
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-sensitive">gimp_int_option_menu_set_sensitive</link>
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
<link linkend="gpointer">gpointer</link> callback_data);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new">gimp_option_menu_new</link> (<link linkend="gboolean">gboolean</link> menu_only,
...);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new2">gimp_option_menu_new2</link> (<link linkend="gboolean">gboolean</link> menu_only,
<link linkend="GCallback">GCallback</link> menu_item_callback,
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
<link linkend="gpointer">gpointer</link> initial,
...);
<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,
<link linkend="gpointer">gpointer</link> item_data);
<link linkend="gboolean">gboolean</link> (<link linkend="GimpOptionMenuSensitivityCallback">*GimpOptionMenuSensitivityCallback</link>)
(<link linkend="gpointer">gpointer</link> item_data,
<link linkend="gpointer">gpointer</link> callback_data);
<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,
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
<link linkend="gpointer">gpointer</link> callback_data);
<link linkend="void">void</link> <link linkend="gimp-menu-item-update">gimp_menu_item_update</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> data);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
These functions are not defined if you <link linkend="define"><type>define</type></link> GIMP_DISABLE_DEPRECATED.
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-int-option-menu-new" role="function" condition="deprecated:"/>gimp_int_option_menu_new ()</title>
<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,
<link linkend="GCallback">GCallback</link> menu_item_callback,
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
<link linkend="gint">gint</link> initial,
...);</programlisting>
<warning><para><literal>gimp_int_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>. This
function does the same thing as the deprecated function
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>, but it takes integers as <parameter>item_data</parameter>
instead of pointers, since that is a very common case (mapping an
enum to a menu).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>menu_only</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
<listitem><simpara> The callback each menu item's "activate" signal will
be connected with.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
<listitem><simpara>
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>initial</parameter> :</term>
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> describing the menu items.
</simpara></listitem></varlistentry>
<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>).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-int-option-menu-set-history" role="function" condition="deprecated:"/>gimp_int_option_menu_set_history ()</title>
<indexterm role="deprecated"><primary>gimp_int_option_menu_set_history</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_history
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
<link linkend="gint">gint</link> item_data);</programlisting>
<warning><para><literal>gimp_int_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one with the
matching <parameter>item_data</parameter>. Probably only makes sense to use with a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link>
that was created using <link linkend="gimp-int-option-menu-new"><function>gimp_int_option_menu_new()</function></link>. This function does the
same thing as <link linkend="gimp-option-menu-set-history"><function>gimp_option_menu_set_history()</function></link>, but takes integers as
<parameter>item_data</parameter> instead of pointers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>option_menu</parameter> :</term>
<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>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item_data</parameter> :</term>
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GimpIntOptionMenuSensitivityCallback" role="function" condition="deprecated:"/>GimpIntOptionMenuSensitivityCallback ()</title>
<indexterm role="deprecated"><primary>GimpIntOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpIntOptionMenuSensitivityCallback)
(<link linkend="gint">gint</link> item_data,
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
<warning><para><literal>GimpIntOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>item_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-int-option-menu-set-sensitive" role="function" condition="deprecated:"/>gimp_int_option_menu_set_sensitive ()</title>
<indexterm role="deprecated"><primary>gimp_int_option_menu_set_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_sensitive
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
<warning><para><literal>gimp_int_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
according to the return value of this function. This function does the
same thing as <link linkend="gimp-option-menu-set-sensitive"><function>gimp_option_menu_set_sensitive()</function></link>, but takes integers as
<parameter>item_data</parameter> instead of pointers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>option_menu</parameter> :</term>
<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
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> a function called for each item in the menu to determine the
the sensitivity state.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback_data</parameter> :</term>
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-option-menu-new" role="function" condition="deprecated:"/>gimp_option_menu_new ()</title>
<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,
...);</programlisting>
<warning><para><literal>gimp_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>menu_only</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> describing the menu items.
</simpara></listitem></varlistentry>
<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>).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-option-menu-new2" role="function" condition="deprecated:"/>gimp_option_menu_new2 ()</title>
<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,
<link linkend="GCallback">GCallback</link> menu_item_callback,
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
<link linkend="gpointer">gpointer</link> initial,
...);</programlisting>
<warning><para><literal>gimp_option_menu_new2</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>menu_only</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
<listitem><simpara> The callback each menu item's "activate" signal will
be connected with.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
<listitem><simpara>
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>initial</parameter> :</term>
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> describing the menu items.
</simpara></listitem></varlistentry>
<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>).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-option-menu-set-history" role="function" condition="deprecated:"/>gimp_option_menu_set_history ()</title>
<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,
<link linkend="gpointer">gpointer</link> item_data);</programlisting>
<warning><para><literal>gimp_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one
with the matching <parameter>item_data</parameter>. Probably only makes sense to use with
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
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>option_menu</parameter> :</term>
<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
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item_data</parameter> :</term>
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GimpOptionMenuSensitivityCallback" role="function" condition="deprecated:"/>GimpOptionMenuSensitivityCallback ()</title>
<indexterm role="deprecated"><primary>GimpOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpOptionMenuSensitivityCallback)
(<link linkend="gpointer">gpointer</link> item_data,
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
<warning><para><literal>GimpOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>item_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-option-menu-set-sensitive" role="function" condition="deprecated:"/>gimp_option_menu_set_sensitive ()</title>
<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,
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
<warning><para><literal>gimp_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
according to the return value of this function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>option_menu</parameter> :</term>
<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
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> a function called for each item in the menu to determine the
the sensitivity state.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback_data</parameter> :</term>
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-menu-item-update" role="function" condition="deprecated:"/>gimp_menu_item_update ()</title>
<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,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<warning><para><literal>gimp_menu_item_update</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> A pointer to a <link linkend="gint"><type>gint</type></link> variable which will store the value of
GPOINTER_TO_INT (g_object_get_data (<parameter>widget</parameter>, "gimp-item-data")).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
GimpIntComboBox
</para>
</refsect1>
</refentry>
|
