Imported Upstream version 2.2.14

This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions

View File

@ -3,11 +3,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpoldwidgets</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="prev" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
@ -27,21 +27,23 @@
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td>&#160;</td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2591272" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2643897" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpwidgets-gimpoldwidgets"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>gimpoldwidgets</span></h2>
<h2>
<a name="id2591272"></a><span class="refentrytitle">gimpoldwidgets</span>
</h2>
<p>gimpoldwidgets &#8212; Old API that is still available but declared as deprecated.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<h2>Synopsis</h2>
<pre class="synopsis">
@ -81,17 +83,17 @@ void <a href="libgimpwidgets-gimpoldwidgets.html#gimp-menu-item-update">g
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<a name="id2643897"></a><h2>Description</h2>
<p>
These functions are not defined if you <span class="type">define</span> GIMP_DISABLE_DEPRECATED.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<a name="id2643919"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2608754"></a><h3>
<a name="id2643930"></a><h3>
<a name="gimp-int-option-menu-new"></a>gimp_int_option_menu_new ()</h3>
<a class="indexterm" name="id2611322"></a><pre class="programlisting">GtkWidget* gimp_int_option_menu_new (gboolean menu_only,
<a class="indexterm" name="id2643944"></a><pre class="programlisting">GtkWidget* gimp_int_option_menu_new (gboolean menu_only,
GCallback menu_item_callback,
gpointer menu_item_callback_data,
gint initial,
@ -113,40 +115,34 @@ enum to a menu).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the function should return a <span class="type">GtkMenu</span> only.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_item_callback</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_item_callback</code></em>&#160;:</span></td>
<td> The callback each menu item's "activate" signal will
be connected with.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_item_callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_item_callback_data</code></em>&#160;:</span></td>
<td>
The data which will be passed to <code class="function">g_signal_connect()</code>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>initial</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>initial</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>item_data</code></em> of the initially selected menu item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> A <code class="literal">NULL</code>-terminated <em class="parameter"><code>va_list</code></em> describing the menu items.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GtkOptionMenu</span> or a <span class="type">GtkMenu</span> (depending on <em class="parameter"><code>menu_only</code></em>).
</td>
</tr>
@ -155,9 +151,9 @@ enum to a menu).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2598100"></a><h3>
<a name="id2631192"></a><h3>
<a name="gimp-int-option-menu-set-history"></a>gimp_int_option_menu_set_history ()</h3>
<a class="indexterm" name="id2598113"></a><pre class="programlisting">void gimp_int_option_menu_set_history
<a class="indexterm" name="id2631206"></a><pre class="programlisting">void gimp_int_option_menu_set_history
(GtkOptionMenu *option_menu,
gint item_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
@ -177,14 +173,12 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-h
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td> A <span class="type">GtkOptionMenu</span> as returned by <a href="libgimpwidgets-gimpoldwidgets.html#gimp-int-option-menu-new"><code class="function">gimp_int_option_menu_new()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>item_data</code></em> of the menu item you want to select.
</td>
</tr>
@ -193,9 +187,9 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-h
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2598265"></a><h3>
<a name="id2640827"></a><h3>
<a name="GimpIntOptionMenuSensitivityCallback"></a>GimpIntOptionMenuSensitivityCallback ()</h3>
<a class="indexterm" name="id2598281"></a><pre class="programlisting">gboolean (*GimpIntOptionMenuSensitivityCallback)
<a class="indexterm" name="id2640843"></a><pre class="programlisting">gboolean (*GimpIntOptionMenuSensitivityCallback)
(gint item_data,
gpointer callback_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
@ -209,20 +203,17 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-h
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -233,9 +224,9 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-h
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601192"></a><h3>
<a name="id2640935"></a><h3>
<a name="gimp-int-option-menu-set-sensitive"></a>gimp_int_option_menu_set_sensitive ()</h3>
<a class="indexterm" name="id2601208"></a><pre class="programlisting">void gimp_int_option_menu_set_sensitive
<a class="indexterm" name="id2640951"></a><pre class="programlisting">void gimp_int_option_menu_set_sensitive
(GtkOptionMenu *option_menu,
<a href="libgimpwidgets-gimpoldwidgets.html#GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</a> callback,
gpointer callback_data);</pre>
@ -256,22 +247,19 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-s
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td> a <span class="type">GtkOptionMenu</span> as returned by <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new"><code class="function">gimp_option_menu_new()</code></a> or
<a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new2"><code class="function">gimp_option_menu_new2()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a function called for each item in the menu to determine the
the sensitivity state.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em> function.
</td>
</tr>
@ -280,9 +268,9 @@ same thing as <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-set-s
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601378"></a><h3>
<a name="id2641121"></a><h3>
<a name="gimp-option-menu-new"></a>gimp_option_menu_new ()</h3>
<a class="indexterm" name="id2601391"></a><pre class="programlisting">GtkWidget* gimp_option_menu_new (gboolean menu_only,
<a class="indexterm" name="id2641134"></a><pre class="programlisting">GtkWidget* gimp_option_menu_new (gboolean menu_only,
...);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -297,20 +285,17 @@ Convenience function to create a <span class="type">GtkOptionMenu</span> or a <s
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the function should return a <span class="type">GtkMenu</span> only.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> A <code class="literal">NULL</code>-terminated <em class="parameter"><code>va_list</code></em> describing the menu items.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GtkOptionMenu</span> or a <span class="type">GtkMenu</span> (depending on <em class="parameter"><code>menu_only</code></em>).
</td>
</tr>
@ -319,9 +304,9 @@ Convenience function to create a <span class="type">GtkOptionMenu</span> or a <s
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601546"></a><h3>
<a name="id2641290"></a><h3>
<a name="gimp-option-menu-new2"></a>gimp_option_menu_new2 ()</h3>
<a class="indexterm" name="id2601560"></a><pre class="programlisting">GtkWidget* gimp_option_menu_new2 (gboolean menu_only,
<a class="indexterm" name="id2641303"></a><pre class="programlisting">GtkWidget* gimp_option_menu_new2 (gboolean menu_only,
GCallback menu_item_callback,
gpointer menu_item_callback_data,
gpointer initial,
@ -339,40 +324,34 @@ Convenience function to create a <span class="type">GtkOptionMenu</span> or a <s
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_only</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the function should return a <span class="type">GtkMenu</span> only.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_item_callback</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_item_callback</code></em>&#160;:</span></td>
<td> The callback each menu item's "activate" signal will
be connected with.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_item_callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>menu_item_callback_data</code></em>&#160;:</span></td>
<td>
The data which will be passed to <code class="function">g_signal_connect()</code>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>initial</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>initial</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>item_data</code></em> of the initially selected menu item.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> A <code class="literal">NULL</code>-terminated <em class="parameter"><code>va_list</code></em> describing the menu items.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GtkOptionMenu</span> or a <span class="type">GtkMenu</span> (depending on <em class="parameter"><code>menu_only</code></em>).
</td>
</tr>
@ -381,9 +360,9 @@ Convenience function to create a <span class="type">GtkOptionMenu</span> or a <s
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608821"></a><h3>
<a name="id2639740"></a><h3>
<a name="gimp-option-menu-set-history"></a>gimp_option_menu_set_history ()</h3>
<a class="indexterm" name="id2608836"></a><pre class="programlisting">void gimp_option_menu_set_history (GtkOptionMenu *option_menu,
<a class="indexterm" name="id2639754"></a><pre class="programlisting">void gimp_option_menu_set_history (GtkOptionMenu *option_menu,
gpointer item_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -401,15 +380,13 @@ a <span class="type">GtkOptionMenu</span> that was created using <a href="libgim
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td> A <span class="type">GtkOptionMenu</span> as returned by <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new"><code class="function">gimp_option_menu_new()</code></a> or
<a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new2"><code class="function">gimp_option_menu_new2()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>item_data</code></em> of the menu item you want to select.
</td>
</tr>
@ -418,9 +395,9 @@ a <span class="type">GtkOptionMenu</span> that was created using <a href="libgim
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608991"></a><h3>
<a name="id2639910"></a><h3>
<a name="GimpOptionMenuSensitivityCallback"></a>GimpOptionMenuSensitivityCallback ()</h3>
<a class="indexterm" name="id2609007"></a><pre class="programlisting">gboolean (*GimpOptionMenuSensitivityCallback)
<a class="indexterm" name="id2639926"></a><pre class="programlisting">gboolean (*GimpOptionMenuSensitivityCallback)
(gpointer item_data,
gpointer callback_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
@ -434,20 +411,17 @@ a <span class="type">GtkOptionMenu</span> that was created using <a href="libgim
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>item_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -458,9 +432,9 @@ a <span class="type">GtkOptionMenu</span> that was created using <a href="libgim
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609099"></a><h3>
<a name="id2640018"></a><h3>
<a name="gimp-option-menu-set-sensitive"></a>gimp_option_menu_set_sensitive ()</h3>
<a class="indexterm" name="id2609114"></a><pre class="programlisting">void gimp_option_menu_set_sensitive (GtkOptionMenu *option_menu,
<a class="indexterm" name="id2640033"></a><pre class="programlisting">void gimp_option_menu_set_sensitive (GtkOptionMenu *option_menu,
<a href="libgimpwidgets-gimpoldwidgets.html#GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</a> callback,
gpointer callback_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
@ -478,22 +452,19 @@ according to the return value of this function.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>option_menu</code></em>&#160;:</span></td>
<td> a <span class="type">GtkOptionMenu</span> as returned by <a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new"><code class="function">gimp_option_menu_new()</code></a> or
<a href="libgimpwidgets-gimpoldwidgets.html#gimp-option-menu-new2"><code class="function">gimp_option_menu_new2()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> a function called for each item in the menu to determine the
the sensitivity state.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>callback_data</code></em>&#160;:</span></td>
<td> data to pass to the <em class="parameter"><code>callback</code></em> function.
</td>
</tr>
@ -502,9 +473,9 @@ according to the return value of this function.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609268"></a><h3>
<a name="id2640187"></a><h3>
<a name="gimp-menu-item-update"></a>gimp_menu_item_update ()</h3>
<a class="indexterm" name="id2609281"></a><pre class="programlisting">void gimp_menu_item_update (GtkWidget *widget,
<a class="indexterm" name="id2640200"></a><pre class="programlisting">void gimp_menu_item_update (GtkWidget *widget,
gpointer data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -519,14 +490,12 @@ according to the return value of this function.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></td>
<td> A <span class="type">GtkMenuItem</span>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> A pointer to a <span class="type">gint</span> variable which will store the value of
GPOINTER_TO_INT (g_object_get_data (<em class="parameter"><code>widget</code></em>, "gimp-item-data")).
</td>
@ -536,7 +505,7 @@ according to the return value of this function.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2609386"></a><h2>See Also</h2>
<a name="id2640306"></a><h2>See Also</h2>
<p>
GimpIntComboBox
</p>