167 lines
14 KiB
HTML
167 lines
14 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpHelpUI</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities"><link rel="prev" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities"><link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimpwidgets-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><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></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">GimpHelpUI</span></h2><p>GimpHelpUI — Functions for setting <a
|
||
href="../gtk/GtkTooltips.html"
|
||
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
|
||
system.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
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);
|
||
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2604346"></a><h2>Description</h2><p>
|
||
|
||
</p></div><div class="refsect1" lang="en"><a name="id2607354"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2607360"></a><h3><a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3><a class="indexterm" name="id2607368"></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><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.
|
||
</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>.
|
||
</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
|
||
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a
|
||
href="../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="../libgimp/libgimp-gimphelp.html#gimp-help"
|
||
><code class="function">gimp_help()</code></a> to actually display
|
||
the help.
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>help_id</code></em> :</span></td><td>
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_data</code></em> :</span></td><td>
|
||
|
||
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2607483"></a><h3><a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3><a class="indexterm" name="id2610147"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
|
||
</pre><p>
|
||
Since: GIMP 2.2
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2610158"></a><h3><a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3><a class="indexterm" name="id2610166"></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><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2610190"></a><h3><a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3><a class="indexterm" name="id2610198"></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><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2610223"></a><h3><a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3><a class="indexterm" name="id2610231"></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><p>
|
||
This is the standard GIMP help function which does nothing but calling
|
||
<a
|
||
href="../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>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>help_id</code></em> :</span></td><td> A unique help identifier.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_data</code></em> :</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></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2610304"></a><h3><a name="gimp-help-connect"></a>gimp_help_connect ()</h3><a class="indexterm" name="id2610312"></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><p>
|
||
Note that this function is automatically called by all libgimp dialog
|
||
constructors. You only have to call it for windows/dialogs you created
|
||
"manually".</p><p>
|
||
|
||
</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> :</span></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.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_func</code></em> :</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> :</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> :</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></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2605730"></a><h3><a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3><a class="indexterm" name="id2605738"></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><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
|
||
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 <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>
|
||
|
||
</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> :</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></tr><tr><td><span class="term"><em class="parameter"><code>tooltip</code></em> :</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> :</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></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2605865"></a><h3><a name="gimp-context-help"></a>gimp_context_help ()</h3><a class="indexterm" name="id2605873"></a><pre class="programlisting">void gimp_context_help (<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a> *widget);</pre><p>
|
||
This function invokes the context help inspector.
|
||
</p><p>
|
||
The mouse cursor will turn turn into a question mark and the user can
|
||
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
|
||
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><p>
|
||
|
||
</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> :</span></td><td> Any <a
|
||
href="../gtk/GtkWidget.html"
|
||
><span class="type">GtkWidget</span></a> on the screen.
|
||
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpwidgets-utils.html"><b><< Part V. GIMP Widgets Utilities</b></a></td><td align="right"><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><b>GimpQueryBox >></b></a></td></tr></table></body></html>
|