callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.2.14

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

92
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
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.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-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.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">
@ -28,22 +28,24 @@
<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="#top_of_page" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2562001" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2622421" 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><span class="refentrytitle"><a name="top_of_page"></a>GimpHelpUI</span></h2>
<h2>
<a name="id2562001"></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>
</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">
@ -67,17 +69,17 @@ void <a href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_cont
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<a name="id2622421"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<a name="id2622436"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2591374"></a><h3>
<a name="id2622447"></a><h3>
<a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3>
<a class="indexterm" name="id2591386"></a><pre class="programlisting">void (*GimpHelpFunc) (const gchar *help_id,
<a class="indexterm" name="id2622460"></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
@ -94,11 +96,11 @@ All these dialog constructors functions call <a href="libgimpwidgets-GimpHelpUI.
<p>
In most cases it will be ok to use <a href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func"><code class="function">gimp_standard_help_func()</code></a> which does
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a
href="../libgimp/libgimp-gimphelp.html#gimp-help"
href="../app/app-Gimp-gui.html#gimp-help"
><code class="function">gimp_help()</code></a>. If your
plug-in needs some more sophisticated help handling you can provide
your own <em class="parameter"><code>help_func</code></em> which has to call <a
href="../libgimp/libgimp-gimphelp.html#gimp-help"
href="../app/app-Gimp-gui.html#gimp-help"
><code class="function">gimp_help()</code></a> to actually display
the help.
</p>
@ -106,14 +108,12 @@ the help.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td>
@ -124,9 +124,9 @@ the help.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2591542"></a><h3>
<a name="id2622616"></a><h3>
<a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3>
<a class="indexterm" name="id2591554"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
<a class="indexterm" name="id2622628"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
Since: GIMP 2.2
@ -134,9 +134,9 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2591571"></a><h3>
<a name="id2622645"></a><h3>
<a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3>
<a class="indexterm" name="id2591582"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<a class="indexterm" name="id2622656"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
<p>
@ -145,9 +145,9 @@ This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2591615"></a><h3>
<a name="id2622689"></a><h3>
<a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3>
<a class="indexterm" name="id2591627"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<a class="indexterm" name="id2622701"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
<p>
@ -156,14 +156,14 @@ This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2591660"></a><h3>
<a name="id2622734"></a><h3>
<a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3>
<a class="indexterm" name="id2591671"></a><pre class="programlisting">void gimp_standard_help_func (const gchar *help_id,
<a class="indexterm" name="id2622745"></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
href="../libgimp/libgimp-gimphelp.html#gimp-help"
href="../app/app-Gimp-gui.html#gimp-help"
><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
<p>
@ -172,14 +172,12 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td> A unique help identifier.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>help_data</code></em> passed to <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><code class="function">gimp_help_connect()</code></a>.
</td>
</tr>
@ -188,9 +186,9 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2591768"></a><h3>
<a name="id2622842"></a><h3>
<a name="gimp-help-connect"></a>gimp_help_connect ()</h3>
<a class="indexterm" name="id2593281"></a><pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a class="indexterm" name="id2626477"></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>
@ -205,27 +203,23 @@ constructors. You only have to call it for windows/dialogs you created
<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> The widget you want to connect the help accelerator for. Will
be a <span class="type">GtkWindow</span> in most cases.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_func</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_func</code></em>&#160;:</span></td>
<td> The function which will be called if the user presses "F1".
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>help_id</code></em> which will be passed to <em class="parameter"><code>help_func</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>help_data</code></em> pointer which will be passed to <em class="parameter"><code>help_func</code></em>.
</td>
</tr>
@ -234,9 +228,9 @@ constructors. You only have to call it for windows/dialogs you created
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593428"></a><h3>
<a name="id2626624"></a><h3>
<a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3>
<a class="indexterm" name="id2593439"></a><pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
<a class="indexterm" name="id2626635"></a><pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);</pre>
<p>
@ -255,20 +249,17 @@ a visible tooltip.</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> The <span class="type">GtkWidget</span> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
<td> The text for this widget's tooltip (or <code class="literal">NULL</code>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <span class="type">GtkTipsQuery</span> tooltips inspector.
</td>
</tr>
@ -277,9 +268,9 @@ a visible tooltip.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593616"></a><h3>
<a name="id2626812"></a><h3>
<a name="gimp-context-help"></a>gimp_context_help ()</h3>
<a class="indexterm" name="id2593629"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<a class="indexterm" name="id2626825"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<p>
This function invokes the context help inspector.
</p>
@ -299,8 +290,7 @@ case at least for every window/dialog).</p>
<div class="variablelist"><table border="0">
<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> Any <span class="type">GtkWidget</span> on the screen.
</td>
</tr></tbody>