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

Imported Upstream version 2.3.6

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:18:19 -04:00
parent 7802c3a9cb
commit de5dc4f4c2
3129 changed files with 762016 additions and 525609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,45 +1,44 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<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.68.1">
<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">
<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.4 (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">
<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&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.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">
<tr valign="middle">
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2580534" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2623072" class="shortcut">Description</a></nobr></td></tr>
</table>
</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="id2580534"></a><span class="refentrytitle">GimpHelpUI</span>
</h2>
<p>GimpHelpUI &#8212; Functions for setting <span class="type">GtkTooltips</span> and help identifier used by GIMP help
<h2><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
system.</p>
</td>
<td valign="top" align="right"></td>
@ -50,37 +49,43 @@ system.</p>
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer 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 gchar *help_id,
gpointer help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);
void <a 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 href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (GtkWidget *widget);
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const gchar *help_id,
gpointer 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 gchar *help_id,
gpointer 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 gchar *help_id,
gpointer 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 gchar *tooltip,
const gchar *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="id2623072"></a><h2>Description</h2>
<a name="id2599076"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2623087"></a><h2>Details</h2>
<a name="id2599087"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2623098"></a><h3>
<a name="id2599093"></a><h3>
<a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3>
<a class="indexterm" name="id2623111"></a><pre class="programlisting">void (*GimpHelpFunc) (const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2599103"></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>,
@ -108,12 +113,14 @@ 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>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</span></td>
<td>
@ -124,9 +131,9 @@ the help.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627807"></a><h3>
<a name="id2599259"></a><h3>
<a name="GIMP-HELP-ID:CAPS"></a>GIMP_HELP_ID</h3>
<a class="indexterm" name="id2627819"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
<a class="indexterm" name="id2599270"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>
Since: GIMP 2.2
@ -134,32 +141,36 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627836"></a><h3>
<a name="id2599286"></a><h3>
<a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3>
<a class="indexterm" name="id2627847"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<a class="indexterm" name="id2599295"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_enable()</code>.</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="id2627880"></a><h3>
<a name="id2596979"></a><h3>
<a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3>
<a class="indexterm" name="id2627892"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<a class="indexterm" name="id2596988"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
<p>
This function calls <code class="function">gtk_tooltips_disable()</code>.</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="id2627925"></a><h3>
<a name="id2597021"></a><h3>
<a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3>
<a class="indexterm" name="id2627936"></a><pre class="programlisting">void gimp_standard_help_func (const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2597030"></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
@ -172,12 +183,14 @@ href="../libgimp/libgimp-gimphelp.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>
<span class="term"><em class="parameter"><code>help_id</code></em>&#160;:</span></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>
<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>
</tr>
@ -186,12 +199,14 @@ href="../libgimp/libgimp-gimphelp.html#gimp-help"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622243"></a><h3>
<a name="id2597127"></a><h3>
<a name="gimp-help-connect"></a>gimp_help_connect ()</h3>
<a class="indexterm" name="id2622256"></a><pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const gchar *help_id,
gpointer help_data);</pre>
<a class="indexterm" name="id2597137"></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 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
@ -203,23 +218,29 @@ 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>
<span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></td>
<td> The widget you want to connect the help accelerator for. Will
be a <span class="type">GtkWindow</span> in most cases.
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>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>help_func</code></em>&#160;:</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>&#160;:</span></td>
<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> 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>
<span class="term"><em class="parameter"><code>help_data</code></em>&#160;:</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>
@ -228,13 +249,17 @@ constructors. You only have to call it for windows/dialogs you created
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622404"></a><h3>
<a name="id2595790"></a><h3>
<a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3>
<a class="indexterm" name="id2622416"></a><pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
const gchar *tooltip,
const gchar *help_id);</pre>
<a class="indexterm" name="id2595799"></a><pre class="programlisting">void gimp_help_set_help_data (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const gchar *tooltip,
const gchar *help_id);</pre>
<p>
The reason why we don't use <code class="function">gtk_tooltips_set_tip()</code> is that it's
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>
@ -249,18 +274,25 @@ 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 <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>
<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>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</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>&#160;:</span></td>
<td> The <em class="parameter"><code>help_id</code></em> for the <span class="type">GtkTipsQuery</span> tooltips inspector.
<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>
</tr>
</tbody>
@ -268,9 +300,11 @@ a visible tooltip.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626763"></a><h3>
<a name="id2595972"></a><h3>
<a name="gimp-context-help"></a>gimp_context_help ()</h3>
<a class="indexterm" name="id2626776"></a><pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
<a class="indexterm" name="id2595982"></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>
@ -290,13 +324,20 @@ 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 <span class="type">GtkWidget</span> on the screen.
<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>
</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>&lt;&lt;&#160;Part&#160;V.&#160;GIMP Widgets Utilities</b></a></td>
<td align="right"><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><b>GimpQueryBox&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>