Imported Upstream version 2.3.16

This commit is contained in:
Ari Pollak
2010-08-11 01:21:23 -04:00
parent d694295a3e
commit 2e1d89b96f
944 changed files with 103935 additions and 69090 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpHelpUI</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<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-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="prev" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<meta name="generator" content="GTK-Doc V1.8 (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">
@ -33,16 +33,16 @@
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2582947" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2623903" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2636347" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2641017" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpwidgets-GimpHelpUI"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2582947"></a><span class="refentrytitle">GimpHelpUI</span>
<a name="id2623903"></a><span class="refentrytitle">GimpHelpUI</span>
</h2>
<p>GimpHelpUI &#8212; Functions for setting <span class="type">GtkTooltips</span> and help identifier used by GIMP help
system.</p>
@ -55,37 +55,37 @@ system.</p>
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer help_data);
#define <a href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS">GIMP_HELP_ID</a>
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips">gimp_help_enable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips">gimp_help_disable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func">gimp_standard_help_func</a> (const gchar *help_id,
gpointer help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data">gimp_help_set_help_data</a> (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (GtkWidget *widget);
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer help_data);
#define <a href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS">GIMP_HELP_ID</a>
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips">gimp_help_enable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips">gimp_help_disable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func">gimp_standard_help_func</a> (const gchar *help_id,
gpointer help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data">gimp_help_set_help_data</a> (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (GtkWidget *widget);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2636347"></a><h2>Description</h2>
<a name="id2641017"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2636363"></a><h2>Details</h2>
<a name="id2641033"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2636374"></a><h3>
<a name="id2641044"></a><h3>
<a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3>
<a class="indexterm" name="id2636386"></a><pre class="programlisting">void (*GimpHelpFunc) (const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2641056"></a><pre class="programlisting">void (*GimpHelpFunc) (const gchar *help_id,
gpointer help_data);</pre>
<p>
This is the prototype for all functions you pass as <em class="parameter"><code>help_func</code></em> to the
various GIMP dialog constructors like <a href="GimpDialog.html#gimp-dialog-new"><code class="function">gimp_dialog_new()</code></a>,
@ -129,9 +129,9 @@ the help.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637362"></a><h3>
<a name="id2645465"></a><h3>
<a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3>
<a class="indexterm" name="id2637374"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
<a class="indexterm" name="id2645477"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
Since: GIMP 2.2
@ -139,9 +139,9 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637391"></a><h3>
<a name="id2645494"></a><h3>
<a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3>
<a class="indexterm" name="id2637402"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<a class="indexterm" name="id2645505"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
<p>
@ -150,9 +150,9 @@ This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637435"></a><h3>
<a name="id2645538"></a><h3>
<a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3>
<a class="indexterm" name="id2637447"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<a class="indexterm" name="id2645550"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
<p>
@ -161,10 +161,10 @@ This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637480"></a><h3>
<a name="id2645583"></a><h3>
<a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3>
<a class="indexterm" name="id2637491"></a><pre class="programlisting">void gimp_standard_help_func (const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2645594"></a><pre class="programlisting">void gimp_standard_help_func (const gchar *help_id,
gpointer help_data);</pre>
<p>
This is the standard GIMP help function which does nothing but calling
<a
@ -191,12 +191,12 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2637588"></a><h3>
<a name="id2641394"></a><h3>
<a name="gimp-help-connect"></a>gimp_help_connect ()</h3>
<a class="indexterm" name="id2634509"></a><pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2641406"></a><pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);</pre>
<p>
Note that this function is automatically called by all libgimp dialog
constructors. You only have to call it for windows/dialogs you created
@ -233,11 +233,11 @@ constructors. You only have to call it for windows/dialogs you created
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2634656"></a><h3>
<a name="id2641555"></a><h3>
<a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3>
<a class="indexterm" name="id2634667"></a><pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);</pre>
<a class="indexterm" name="id2641566"></a><pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);</pre>
<p>
The reason why we don't use <code class="function">gtk_tooltips_set_tip()</code> is that it's
impossible to set a <em class="parameter"><code>private_tip</code></em> (aka <em class="parameter"><code>help_id</code></em>) without a visible
@ -273,9 +273,9 @@ a visible tooltip.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2634844"></a><h3>
<a name="id2644384"></a><h3>
<a name="gimp-context-help"></a>gimp_context_help ()</h3>
<a class="indexterm" name="id2634856"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<a class="indexterm" name="id2644396"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<p>
This function invokes the context help inspector.
</p>