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

Imported Upstream version 2.6.10

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:28:26 -04:00
parent d302c2222c
commit 04341c96c0
875 changed files with 164198 additions and 146469 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,22 +8,8 @@
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="prev" href="libgimpwidgets-GimpCairoUtils.html" title="gimpcairo-utils">
<link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<meta name="generator" content="GTK-Doc V1.15 (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-gallery.html" title="Widget Gallery">
<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">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
@ -36,8 +22,8 @@
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimpwidgets-GimpHelpUI.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a>
 | 
<a href="#libgimpwidgets-GimpHelpUI.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="GimpHelpUI">
@ -45,62 +31,31 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpHelpUI.top_of_page"></a>GimpHelpUI</span></h2>
<p>GimpHelpUI — Functions for setting <a
href="http://library.gnome.org/devel/gtk/unstable/GtkTooltips.html"
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
<p>GimpHelpUI — Functions for setting <a href="/usr/share/gtk-doc/html/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" title="Synopsis">
<a name="libgimpwidgets-GimpHelpUI.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>) (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
#define <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID--CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a> (void);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a> (void);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()">gimp_standard_help_func</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()">gimp_help_set_help_data</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data-with-markup" title="gimp_help_set_help_data_with_markup ()">gimp_help_set_help_data_with_markup</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget);
<pre class="synopsis"><span class="returnvalue">void</span> (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>) (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
#define <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()">gimp_standard_help_func</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()">gimp_help_set_help_data</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data-with-markup" title="gimp_help_set_help_data_with_markup ()">gimp_help_set_help_data_with_markup</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
@ -112,12 +67,8 @@ href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
<a name="libgimpwidgets-GimpHelpUI.details"></a><h2>Details</h2>
<div class="refsect2" title="GimpHelpFunc ()">
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
<pre class="programlisting">void (*GimpHelpFunc) (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> (*GimpHelpFunc) (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</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 class="link" href="GimpDialog.html#gimp-dialog-new" title="gimp_dialog_new ()"><code class="function">gimp_dialog_new()</code></a>,
@ -132,13 +83,9 @@ All these dialog constructors functions call <a class="link" href="libgimpwidget
</p>
<p>
In most cases it will be ok to use <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="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
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
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">
@ -159,7 +106,7 @@ the help.
</div>
<hr>
<div class="refsect2" title="GIMP_HELP_ID">
<a name="GIMP-HELP-ID--CAPS"></a><h3>GIMP_HELP_ID</h3>
<a name="GIMP-HELP-ID:CAPS"></a><h3>GIMP_HELP_ID</h3>
<pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
@ -169,64 +116,51 @@ Since: GIMP 2.2
<hr>
<div class="refsect2" title="gimp_help_enable_tooltips ()">
<a name="gimp-help-enable-tooltips"></a><h3>gimp_help_enable_tooltips ()</h3>
<pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_help_enable_tooltips (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Enable tooltips to be shown in the GIMP user interface.
</p>
<p>
As a plug-in author, you don't need to care about this as this
function is called for you from <a
href="../libgimp/libgimp-gimpui.html#gimp-ui-init"
><code class="function">gimp_ui_init()</code></a>. This ensures that
function is called for you from <a href="../libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
the user setting from the GIMP preferences dialog is respected in
all plug-in dialogs.</p>
<p>
all plug-in dialogs.
</p>
</div>
<hr>
<div class="refsect2" title="gimp_help_disable_tooltips ()">
<a name="gimp-help-disable-tooltips"></a><h3>gimp_help_disable_tooltips ()</h3>
<pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_help_disable_tooltips (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Disable tooltips to be shown in the GIMP user interface.
</p>
<p>
As a plug-in author, you don't need to care about this as this
function is called for you from <a
href="../libgimp/libgimp-gimpui.html#gimp-ui-init"
><code class="function">gimp_ui_init()</code></a>. This ensures that
function is called for you from <a href="../libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
the user setting from the GIMP preferences dialog is respected in
all plug-in dialogs.</p>
<p>
all plug-in dialogs.
</p>
</div>
<hr>
<div class="refsect2" title="gimp_standard_help_func ()">
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
<pre class="programlisting">void gimp_standard_help_func (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_standard_help_func (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</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>
<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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
<td> A unique help identifier.
<td>A unique help identifier.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_data</code></em> :</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" title="gimp_help_connect ()"><code class="function">gimp_help_connect()</code></a>.
<td>The <em class="parameter"><code>help_data</code></em> passed to <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()"><code class="function">gimp_help_connect()</code></a>.
</td>
</tr>
</tbody>
@ -235,46 +169,37 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
<hr>
<div class="refsect2" title="gimp_help_connect ()">
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
<pre class="programlisting">void gimp_help_connect (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_help_connect (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</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>
"manually".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td> The widget you want to connect the help accelerator for. Will
be a <a
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
><span class="type">GtkWindow</span></a> in most cases.
<td>The widget you want to connect the help accelerator for. Will
be a <a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> in most cases.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_func</code></em> :</span></p></td>
<td> The function which will be called if the user presses "F1".
<td>The function which will be called if the user presses "F1".
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</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>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><p><span class="term"><em class="parameter"><code>help_data</code></em> :</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>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>
@ -283,52 +208,35 @@ href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
<hr>
<div class="refsect2" title="gimp_help_set_help_data ()">
<a name="gimp-help-set-help-data"></a><h3>gimp_help_set_help_data ()</h3>
<pre class="programlisting">void gimp_help_set_help_data (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_help_set_help_data (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
<p>
The reason why we don't use <a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html#gtk-widget-set-tooltip-text"
><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
The reason why we don't use <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
elements in the GIMP user interface should, if possible, also have
a <em class="parameter"><code>help_id</code></em> set for context-sensitive help.
</p>
<p>
This function can be called with <a
href="http://library.gnome.org/devel/glib/unstable/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 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> 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>
a visible tooltip.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td> The <a
href="http://library.gnome.org/devel/gtk/unstable/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>The <a href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td> The text for this widget's tooltip (or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>).
<td>The text for this widget's tooltip (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <a
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
<td>The <em class="parameter"><code>help_id</code></em> for the <a href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.
</td>
</tr>
</tbody>
@ -337,45 +245,30 @@ href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
<hr>
<div class="refsect2" title="gimp_help_set_help_data_with_markup ()">
<a name="gimp-help-set-help-data-with-markup"></a><h3>gimp_help_set_help_data_with_markup ()</h3>
<pre class="programlisting">void gimp_help_set_help_data_with_markup (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_help_set_help_data_with_markup (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
<p>
Just like <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()"><code class="function">gimp_help_set_help_data()</code></a>, but it allows to pass text which
is marked up with
<a
href="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html"
>Pango text markup language</a>.</p>
<p>
<a href="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html">Pango text markup language</a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td> The <a
href="http://library.gnome.org/devel/gtk/unstable/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>The <a href="/usr/share/gtk-doc/html/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><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td> The markup for this widget's tooltip (or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>).
<td>The markup for this widget's tooltip (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <a
href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
<td>The <em class="parameter"><code>help_id</code></em> for the <a href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.
</td>
</tr>
</tbody>
@ -385,9 +278,7 @@ href="http://library.gnome.org/devel/gtk/unstable/GtkTipsQuery.html"
<hr>
<div class="refsect2" title="gimp_context_help ()">
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
<pre class="programlisting">void gimp_context_help (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_context_help (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>
This function invokes the context help inspector.
</p>
@ -400,16 +291,13 @@ If the widget the user clicked on has a <em class="parameter"><code>help_id</cod
(see <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="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>
case at least for every window/dialog).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td> Any <a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
><span class="type">GtkWidget</span></a> on the screen.
<td>Any <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> on the screen.
</td>
</tr></tbody>
</table></div>
@ -418,6 +306,6 @@ href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
Generated by GTK-Doc V1.15</div>
</body>
</html>
</html>