42
42
<div class="refnamediv"><table width="100%"><tr>
44
44
<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpHelpUI.top_of_page"></a>GimpHelpUI</span></h2>
45
<p>GimpHelpUI — Functions for setting <a
46
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html"
47
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
45
<p>GimpHelpUI — Functions for setting <span class="type">GtkTooltips</span> and help identifier used by GIMP help
50
48
<td valign="top" align="right"></td>
52
50
<div class="refsynopsisdiv">
53
51
<a name="libgimpwidgets-GimpHelpUI.synopsis"></a><h2>Synopsis</h2>
54
52
<pre class="synopsis">
55
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>) (const <a
56
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
59
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
60
>gpointer</a> help_data);
53
void (<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">*GimpHelpFunc</a>) (const gchar *help_id,
61
55
#define <a class="link" href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID:CAPS" title="GIMP_HELP_ID">GIMP_HELP_ID</a>
62
56
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips" title="gimp_help_enable_tooltips ()">gimp_help_enable_tooltips</a> (void);
63
57
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips" title="gimp_help_disable_tooltips ()">gimp_help_disable_tooltips</a> (void);
64
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()">gimp_standard_help_func</a> (const <a
65
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
68
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
69
>gpointer</a> help_data);
70
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a> (<a
71
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
72
>GtkWidget</a> *widget,
58
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,
60
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()">gimp_help_connect</a> (GtkWidget *widget,
73
61
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
75
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
78
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
79
>gpointer</a> help_data);
80
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
81
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
82
>GtkWidget</a> *widget,
84
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
87
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
89
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a> (<a
90
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
91
>GtkWidget</a> *widget);
64
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,
66
const gchar *help_id);
67
void <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-context-help" title="gimp_context_help ()">gimp_context_help</a> (GtkWidget *widget);
94
70
<div class="refsect1" lang="en">
101
77
<a name="libgimpwidgets-GimpHelpUI.details"></a><h2>Details</h2>
102
78
<div class="refsect2" lang="en">
103
79
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
104
<pre class="programlisting">void (*GimpHelpFunc) (const <a
105
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
108
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
109
>gpointer</a> help_data);</pre>
80
<pre class="programlisting">void (*GimpHelpFunc) (const gchar *help_id,
81
gpointer help_data);</pre>
111
83
This is the prototype for all functions you pass as <em class="parameter"><code>help_func</code></em> to the
112
84
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>,
123
95
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
124
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a
125
href="/usr/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
126
><code class="function">gimp_help()</code></a>. If your
96
nothing but passing the <em class="parameter"><code>help_id</code></em> string to <code class="function">gimp_help()</code>. If your
127
97
plug-in needs some more sophisticated help handling you can provide
128
your own <em class="parameter"><code>help_func</code></em> which has to call <a
129
href="/usr/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
130
><code class="function">gimp_help()</code></a> to actually display
98
your own <em class="parameter"><code>help_func</code></em> which has to call <code class="function">gimp_help()</code> to actually display
133
101
<div class="variablelist"><table border="0">
162
130
<a name="gimp-help-enable-tooltips"></a><h3>gimp_help_enable_tooltips ()</h3>
163
131
<pre class="programlisting">void gimp_help_enable_tooltips (void);</pre>
165
This function calls <a
166
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-enable"
167
><code class="function">gtk_tooltips_enable()</code></a>.</p>
133
This function calls <code class="function">gtk_tooltips_enable()</code>.</p>
174
140
<a name="gimp-help-disable-tooltips"></a><h3>gimp_help_disable_tooltips ()</h3>
175
141
<pre class="programlisting">void gimp_help_disable_tooltips (void);</pre>
177
This function calls <a
178
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-disable"
179
><code class="function">gtk_tooltips_disable()</code></a>.</p>
143
This function calls <code class="function">gtk_tooltips_disable()</code>.</p>
185
149
<div class="refsect2" lang="en">
186
150
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
187
<pre class="programlisting">void gimp_standard_help_func (const <a
188
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
191
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
192
>gpointer</a> help_data);</pre>
151
<pre class="programlisting">void gimp_standard_help_func (const gchar *help_id,
152
gpointer help_data);</pre>
194
154
This is the standard GIMP help function which does nothing but calling
196
href="/usr/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"
197
><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
155
<code class="function">gimp_help()</code>. It is the right function to use in almost all cases.</p>
218
176
<div class="refsect2" lang="en">
219
177
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
220
<pre class="programlisting">void gimp_help_connect (<a
221
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
222
>GtkWidget</a> *widget,
178
<pre class="programlisting">void gimp_help_connect (GtkWidget *widget,
223
179
<a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()">GimpHelpFunc</a> help_func,
225
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
228
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
229
>gpointer</a> help_data);</pre>
180
const gchar *help_id,
181
gpointer help_data);</pre>
231
183
Note that this function is automatically called by all libgimp dialog
232
184
constructors. You only have to call it for windows/dialogs you created
241
193
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
242
194
<td> The widget you want to connect the help accelerator for. Will
244
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
245
><span class="type">GtkWindow</span></a> in most cases.
195
be a <span class="type">GtkWindow</span> in most cases.
267
217
<div class="refsect2" lang="en">
268
218
<a name="gimp-help-set-help-data"></a><h3>gimp_help_set_help_data ()</h3>
269
<pre class="programlisting">void gimp_help_set_help_data (<a
270
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
271
>GtkWidget</a> *widget,
273
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
276
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
277
>gchar</a> *help_id);</pre>
219
<pre class="programlisting">void gimp_help_set_help_data (GtkWidget *widget,
220
const gchar *tooltip,
221
const gchar *help_id);</pre>
279
The reason why we don't use <a
280
href="/usr/share/gtk-doc/html/gtk/GtkTooltips.html#gtk-tooltips-set-tip"
281
><code class="function">gtk_tooltips_set_tip()</code></a> is that it's
223
The reason why we don't use <code class="function">gtk_tooltips_set_tip()</code> is that it's
282
224
impossible to set a <em class="parameter"><code>private_tip</code></em> (aka <em class="parameter"><code>help_id</code></em>) without a visible
283
225
<em class="parameter"><code>tooltip</code></em>.
286
This function can be called with <a
287
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
288
><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>. Use this feature
228
This function can be called with <span class="type">NULL</span> for <em class="parameter"><code>tooltip</code></em>. Use this feature
289
229
if you want to set a help link for a widget which shouldn't have
290
230
a visible tooltip.</p>
298
238
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
300
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
301
><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.
239
<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.
305
243
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
306
<td> The text for this widget's tooltip (or <a
307
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
308
><code class="literal">NULL</code></a>).
244
<td> The text for this widget's tooltip (or <code class="literal">NULL</code>).
312
248
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
313
<td> The <em class="parameter"><code>help_id</code></em> for the <a
314
href="/usr/share/gtk-doc/html/gtk/GtkTipsQuery.html"
315
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
249
<td> The <em class="parameter"><code>help_id</code></em> for the <span class="type">GtkTipsQuery</span> tooltips inspector.
322
256
<div class="refsect2" lang="en">
323
257
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
324
<pre class="programlisting">void gimp_context_help (<a
325
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
326
>GtkWidget</a> *widget);</pre>
258
<pre class="programlisting">void gimp_context_help (GtkWidget *widget);</pre>
328
260
This function invokes the context help inspector.
344
276
<col align="left" valign="top">
346
278
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
348
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
349
><span class="type">GtkWidget</span></a> on the screen.
279
<td> Any <span class="type">GtkWidget</span> on the screen.
added
removed
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
