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

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

214
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpHelpUI</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<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">
@ -33,20 +33,18 @@
<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="#id2563548" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2622709" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2649758" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2663992" 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="id2563548"></a><span class="refentrytitle">GimpHelpUI</span>
<a name="id2622709"></a><span class="refentrytitle">GimpHelpUI</span>
</h2>
<p>GimpHelpUI &#8212; Functions for setting <a
href="../gtk/GtkTooltips.html"
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
<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>
@ -57,83 +55,57 @@ system.</p>
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> 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 <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data">gimp_help_set_help_data</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget);
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer help_data);
#define <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS">GIMP_HELP_ID</a>
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips">gimp_help_enable_tooltips</a> (void);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips">gimp_help_disable_tooltips</a> (void);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func">gimp_standard_help_func</a> (const gchar *help_id,
gpointer help_data);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (GtkWidget *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);
void <a class="link" 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 class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (GtkWidget *widget);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2649758"></a><h2>Description</h2>
<a name="id2663992"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2649773"></a><h2>Details</h2>
<a name="id2664008"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2649784"></a><h3>
<a name="id2664019"></a><h3>
<a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3>
<a class="indexterm" name="id2649797"></a><pre class="programlisting">void (*GimpHelpFunc) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<a class="indexterm" name="id2664031"></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>,
<a href="libgimpwidgets-GimpQueryBox.html#gimp-query-int-box"><code class="function">gimp_query_int_box()</code></a> etc.
various GIMP dialog constructors like <a class="link" href="GimpDialog.html#gimp-dialog-new"><code class="function">gimp_dialog_new()</code></a>,
<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-int-box"><code class="function">gimp_query_int_box()</code></a> etc.
</p>
<p>
Help IDs are textual identifiers the help system uses to figure which
page to display.
</p>
<p>
All these dialog constructors functions call <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><code class="function">gimp_help_connect()</code></a>.
All these dialog constructors functions call <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><code class="function">gimp_help_connect()</code></a>.
</p>
<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
In most cases it will be ok to use <a class="link" 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="../app/app-Gimp-gui.html#gimp-help"
href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.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="../app/app-Gimp-gui.html#gimp-help"
href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
><code class="function">gimp_help()</code></a> to actually display
the help.
</p>
@ -141,12 +113,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><p><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></p></td>
<td>
@ -157,9 +129,9 @@ the help.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2649953"></a><h3>
<a name="id2664234"></a><h3>
<a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3>
<a class="indexterm" name="id2649966"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
<a class="indexterm" name="id2664246"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
Since: GIMP 2.2
@ -167,44 +139,36 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2650802"></a><h3>
<a name="id2664263"></a><h3>
<a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3>
<a class="indexterm" name="id2650813"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<a class="indexterm" name="id2664274"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-enable"
><code class="function">gtk_tooltips_enable()</code></a>.</p>
This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2650846"></a><h3>
<a name="id2664307"></a><h3>
<a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3>
<a class="indexterm" name="id2650858"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<a class="indexterm" name="id2668098"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-disable"
><code class="function">gtk_tooltips_disable()</code></a>.</p>
This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2650891"></a><h3>
<a name="id2668131"></a><h3>
<a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3>
<a class="indexterm" name="id2650902"></a><pre class="programlisting">void gimp_standard_help_func (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<a class="indexterm" name="id2668143"></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="../app/app-Gimp-gui.html#gimp-help"
href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
<p>
@ -213,13 +177,13 @@ href="../app/app-Gimp-gui.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><p><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></p></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> 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><p><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></p></td>
<td> The <em class="parameter"><code>help_data</code></em> passed to <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><code class="function">gimp_help_connect()</code></a>.
</td>
</tr>
</tbody>
@ -227,18 +191,12 @@ href="../app/app-Gimp-gui.html#gimp-help"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2650999"></a><h3>
<a name="id2668240"></a><h3>
<a name="gimp-help-connect"></a>gimp_help_connect ()</h3>
<a class="indexterm" name="id2651012"></a><pre class="programlisting">void gimp_help_connect (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<a class="indexterm" name="id2668252"></a><pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a class="link" 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
@ -250,25 +208,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><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></td>
<td> The widget you want to connect the help accelerator for. Will
be a <a
href="../gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> in most cases.
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><p><span class="term"><em class="parameter"><code>help_func</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></p></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>
@ -277,28 +233,18 @@ href="../gtk/GtkWindow.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2646869"></a><h3>
<a name="id2662924"></a><h3>
<a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3>
<a class="indexterm" name="id2646880"></a><pre class="programlisting">void gimp_help_set_help_data (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre>
<a class="indexterm" name="id2662936"></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 <a
href="../gtk/GtkTooltips.html#gtk-tooltips-set-tip"
><code class="function">gtk_tooltips_set_tip()</code></a> is that it's
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
<em class="parameter"><code>tooltip</code></em>.
</p>
<p>
This function can be called with <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>. Use this feature
This function can be called with <span class="type">NULL</span> for <em class="parameter"><code>tooltip</code></em>. Use this feature
if you want to set a help link for a widget which shouldn't have
a visible tooltip.</p>
<p>
@ -308,24 +254,18 @@ 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> The <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em> and/or <em class="parameter"><code>help_id</code></em> for.
<td><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></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> The text for this widget's tooltip (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></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> The <em class="parameter"><code>help_id</code></em> for the <a
href="../gtk/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
<td><p><span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></p></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <span class="type">GtkTipsQuery</span> tooltips inspector.
</td>
</tr>
</tbody>
@ -333,11 +273,9 @@ href="../gtk/GtkTipsQuery.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647058"></a><h3>
<a name="id2663113"></a><h3>
<a name="gimp-context-help"></a>gimp_context_help ()</h3>
<a class="indexterm" name="id2647070"></a><pre class="programlisting">void gimp_context_help (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget);</pre>
<a class="indexterm" name="id2663126"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<p>
This function invokes the context help inspector.
</p>
@ -347,7 +285,7 @@ click on any widget of the application which started the inspector.
</p>
<p>
If the widget the user clicked on has a <em class="parameter"><code>help_id</code></em> string attached
(see <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data"><code class="function">gimp_help_set_help_data()</code></a>), the corresponding help page will
(see <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data"><code class="function">gimp_help_set_help_data()</code></a>), the corresponding help page will
be displayed. Otherwise the help system will ascend the widget hierarchy
until it finds an attached <em class="parameter"><code>help_id</code></em> string (which should be the
case at least for every window/dialog).</p>
@ -357,10 +295,8 @@ 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> Any <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> on the screen.
<td><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></td>
<td> Any <span class="type">GtkWidget</span> on the screen.
</td>
</tr></tbody>
</table></div>