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

Imported Upstream version 2.4.0

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:23:21 -04:00
parent f35d8506c6
commit 258b1471f0
781 changed files with 98804 additions and 57910 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,7 @@
<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.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.9 (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,19 +33,19 @@
<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="#id2586112" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2638288" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2665517" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2662924" 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="id2586112"></a><span class="refentrytitle">GimpHelpUI</span>
<a name="id2638288"></a><span class="refentrytitle">GimpHelpUI</span>
</h2>
<p>GimpHelpUI &#8212; Functions for setting <a
href="../gtk/GtkTooltips.html"
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>
@ -58,61 +58,61 @@ system.</p>
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> 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 <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (<a
href="../gtk/GtkWidget.html"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data">gimp_help_set_help_data</a> (<a
href="../gtk/GtkWidget.html"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (<a
href="../gtk/GtkWidget.html"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2665517"></a><h2>Description</h2>
<a name="id2662924"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2668298"></a><h2>Details</h2>
<a name="id2665198"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2668308"></a><h3>
<a name="id2665208"></a><h3>
<a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3>
<a class="indexterm" name="id2668320"></a><pre class="programlisting">void (*GimpHelpFunc) (const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2665220"></a><pre class="programlisting">void (*GimpHelpFunc) (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/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
@ -129,11 +129,11 @@ All these dialog constructors functions call <a class="link" href="libgimpwidget
<p>
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="../libgimp/libgimp-gimphelp.html#gimp-help"
href="/usr/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="../libgimp/libgimp-gimphelp.html#gimp-help"
href="/usr/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
><code class="function">gimp_help()</code></a> to actually display
the help.
</p>
@ -157,9 +157,9 @@ the help.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2668477"></a><h3>
<a name="id2665377"></a><h3>
<a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3>
<a class="indexterm" name="id2668489"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
<a class="indexterm" name="id2665389"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
Since: GIMP 2.2
@ -167,12 +167,12 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2668506"></a><h3>
<a name="id2665406"></a><h3>
<a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3>
<a class="indexterm" name="id2668517"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<a class="indexterm" name="id2665417"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-enable"
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-enable"
><code class="function">gtk_tooltips_enable()</code></a>.</p>
<p>
@ -180,12 +180,12 @@ href="../gtk/GtkTooltips.html#gtk-tooltips-enable"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2667168"></a><h3>
<a name="id2665450"></a><h3>
<a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3>
<a class="indexterm" name="id2667179"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<a class="indexterm" name="id2665462"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-disable"
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-disable"
><code class="function">gtk_tooltips_disable()</code></a>.</p>
<p>
@ -193,18 +193,18 @@ href="../gtk/GtkTooltips.html#gtk-tooltips-disable"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2667212"></a><h3>
<a name="id2665495"></a><h3>
<a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3>
<a class="indexterm" name="id2667223"></a><pre class="programlisting">void gimp_standard_help_func (const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2665506"></a><pre class="programlisting">void gimp_standard_help_func (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/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"
href="/usr/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>
@ -227,17 +227,17 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2667320"></a><h3>
<a name="id2665603"></a><h3>
<a name="gimp-help-connect"></a>gimp_help_connect ()</h3>
<a class="indexterm" name="id2667333"></a><pre class="programlisting">void gimp_help_connect (<a
href="../gtk/GtkWidget.html"
<a class="indexterm" name="id2667713"></a><pre class="programlisting">void gimp_help_connect (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<p>
Note that this function is automatically called by all libgimp dialog
@ -253,7 +253,7 @@ constructors. You only have to call it for windows/dialogs you created
<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"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> in most cases.
</td>
</tr>
@ -277,27 +277,27 @@ href="../gtk/GtkWindow.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2664157"></a><h3>
<a name="id2667862"></a><h3>
<a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3>
<a class="indexterm" name="id2664168"></a><pre class="programlisting">void gimp_help_set_help_data (<a
href="../gtk/GtkWidget.html"
<a class="indexterm" name="id2667873"></a><pre class="programlisting">void gimp_help_set_help_data (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/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"
href="/usr/share/gtk-doc/html/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 <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
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>
@ -310,21 +310,21 @@ a visible tooltip.</p>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></td>
<td> The <a
href="../gtk/GtkWidget.html"
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>&#160;:</span></p></td>
<td> The text for this widget's tooltip (or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
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>&#160;:</span></p></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <a
href="../gtk/GtkTipsQuery.html"
href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
</td>
</tr>
@ -333,10 +333,10 @@ href="../gtk/GtkTipsQuery.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2664346"></a><h3>
<a name="id2668051"></a><h3>
<a name="gimp-context-help"></a>gimp_context_help ()</h3>
<a class="indexterm" name="id2664358"></a><pre class="programlisting">void gimp_context_help (<a
href="../gtk/GtkWidget.html"
<a class="indexterm" name="id2668063"></a><pre class="programlisting">void gimp_context_help (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget);</pre>
<p>
This function invokes the context help inspector.
@ -359,13 +359,18 @@ case at least for every window/dialog).</p>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></p></td>
<td> Any <a
href="../gtk/GtkWidget.html"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> on the screen.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2668155"></a><div class="refsect2" lang="en"><a name="id2668156"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2668157"></a></div>
</div>
</div>
</body>
</html>