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

Imported Upstream version 2.4.7

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:25:24 -04:00
parent 478f5ecc84
commit 826f4b0313
398 changed files with 34802 additions and 57532 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -42,9 +42,7 @@
<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="/usr/share/gtk-doc/html/gtk/GtkTooltips.html"
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
<p>GimpHelpUI — Functions for setting <span class="type">GtkTooltips</span> and help identifier used by GIMP help
system.</p>
</td>
<td valign="top" align="right"></td>
@ -52,43 +50,21 @@ system.</p>
<div class="refsynopsisdiv">
<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer 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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
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" title="gimp_help_connect ()">gimp_help_connect</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="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" title="gimp_help_connect ()">gimp_help_connect</a> (GtkWidget *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
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" title="gimp_help_set_help_data ()">gimp_help_set_help_data</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
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" title="gimp_context_help ()">gimp_context_help</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget);
const gchar *help_id,
gpointer 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> (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a> (GtkWidget *widget);
</pre>
</div>
<div class="refsect1" lang="en">
@ -101,12 +77,8 @@ href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
<a name="libgimpwidgets-GimpHelpUI.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<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 class="link" href="GimpDialog.html#gimp-dialog-new" title="gimp_dialog_new ()"><code class="function">gimp_dialog_new()</code></a>,
@ -121,13 +93,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="/usr/share/gtk-doc/html/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 <code class="function">gimp_help()</code>. 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="/usr/share/gtk-doc/html/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 <code class="function">gimp_help()</code> to actually display
the help.
</p>
<div class="variablelist"><table border="0">
@ -162,9 +130,7 @@ Since: GIMP 2.2
<a name="gimp-help-enable-tooltips"></a><h3>gimp_help_enable_tooltips ()</h3>
<pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <a
href="/usr/share/gtk-doc/html/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>
@ -174,9 +140,7 @@ href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-enable"
<a name="gimp-help-disable-tooltips"></a><h3>gimp_help_disable_tooltips ()</h3>
<pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <a
href="/usr/share/gtk-doc/html/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>
@ -184,17 +148,11 @@ href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-disable"
<hr>
<div class="refsect2" lang="en">
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
<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="/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>
<code class="function">gimp_help()</code>. It is the right function to use in almost all cases.</p>
<p>
</p>
@ -217,16 +175,10 @@ href="/usr/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
<hr>
<div class="refsect2" lang="en">
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
<pre class="programlisting">void gimp_help_connect (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre>
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
@ -240,9 +192,7 @@ constructors. You only have to call it for windows/dialogs you created
<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="/usr/share/gtk-doc/html/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>
@ -266,26 +216,16 @@ href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
<hr>
<div class="refsect2" lang="en">
<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="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre>
<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="/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
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="/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
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>
@ -296,23 +236,17 @@ a visible tooltip.</p>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<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> 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><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="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>).
<td> The text for this widget's tooltip (or <code class="literal">NULL</code>).
</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="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
<td> The <em class="parameter"><code>help_id</code></em> for the <span class="type">GtkTipsQuery</span> tooltips inspector.
</td>
</tr>
</tbody>
@ -321,9 +255,7 @@ href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
<hr>
<div class="refsect2" lang="en">
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
<pre class="programlisting">void gimp_context_help (<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a> *widget);</pre>
<pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<p>
This function invokes the context help inspector.
</p>
@ -344,9 +276,7 @@ case at least for every window/dialog).</p>
<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="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> on the screen.
<td> Any <span class="type">GtkWidget</span> on the screen.
</td>
</tr></tbody>
</table></div>