← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gimp/utopic

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-08-29 12:48:19 UTC
  • mfrom: (1.1.29) (0.4.20 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130829124819-r4mliaiddrgv5x4g
Tags: 2.8.6-1ubuntu1
https://launchpad.net/bugs/1207734
* Synchronize with Debian (LP: #1207734). Remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + Update some strings for Ubuntu
  - debian/control:
    + Update description
  - debian/rules:
    + Set gettext domain and update translation templates

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpHelpUI</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
9
9
<link rel="prev" href="libgimpwidgets-GimpCairoUtils.html" title="GimpCairo-utils">
85
85
</p>
86
86
<p>
87
87
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
88
 
does nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a href="/local/head/share/gtk-doc/html/app/app-Gimp-gui.html#gimp-help"><code class="function">gimp_help()</code></a>. If
 
88
does nothing but passing the <em class="parameter"><code>help_id</code></em> string to <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a>. If
89
89
your plug-in needs some more sophisticated help handling you can
90
 
provide your own <em class="parameter"><code>help_func</code></em> which has to call <a href="/local/head/share/gtk-doc/html/app/app-Gimp-gui.html#gimp-help"><code class="function">gimp_help()</code></a> to
 
90
provide your own <em class="parameter"><code>help_func</code></em> which has to call <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a> to
91
91
actually display the help.
92
92
</p>
93
 
<div class="variablelist"><table border="0">
 
93
<div class="variablelist"><table border="0" class="variablelist">
 
94
<colgroup>
94
95
<col align="left" valign="top">
 
96
<col>
 
97
</colgroup>
95
98
<tbody>
96
99
<tr>
97
100
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
149
152
                                                         <em class="parameter"><code><span class="type">gpointer</span> help_data</code></em>);</pre>
150
153
<p>
151
154
This is the standard GIMP help function which does nothing but calling
152
 
<a href="/local/head/share/gtk-doc/html/app/app-Gimp-gui.html#gimp-help"><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.
 
155
<a href="/local/head/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.
153
156
</p>
154
 
<div class="variablelist"><table border="0">
 
157
<div class="variablelist"><table border="0" class="variablelist">
 
158
<colgroup>
155
159
<col align="left" valign="top">
 
160
<col>
 
161
</colgroup>
156
162
<tbody>
157
163
<tr>
158
164
<td><p><span class="term"><em class="parameter"><code>help_id</code></em> :</span></p></td>
177
183
constructors. You only have to call it for windows/dialogs you created
178
184
"manually".
179
185
</p>
180
 
<div class="variablelist"><table border="0">
 
186
<div class="variablelist"><table border="0" class="variablelist">
 
187
<colgroup>
181
188
<col align="left" valign="top">
 
189
<col>
 
190
</colgroup>
182
191
<tbody>
183
192
<tr>
184
193
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
216
225
if you want to set a help link for a widget which shouldn't have
217
226
a visible tooltip.
218
227
</p>
219
 
<div class="variablelist"><table border="0">
 
228
<div class="variablelist"><table border="0" class="variablelist">
 
229
<colgroup>
220
230
<col align="left" valign="top">
 
231
<col>
 
232
</colgroup>
221
233
<tbody>
222
234
<tr>
223
235
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
245
257
is marked up with
246
258
Pango text markup language.
247
259
</p>
248
 
<div class="variablelist"><table border="0">
 
260
<div class="variablelist"><table border="0" class="variablelist">
 
261
<colgroup>
249
262
<col align="left" valign="top">
 
263
<col>
 
264
</colgroup>
250
265
<tbody>
251
266
<tr>
252
267
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
282
297
until it finds an attached <em class="parameter"><code>help_id</code></em> string (which should be the
283
298
case at least for every window/dialog).
284
299
</p>
285
 
<div class="variablelist"><table border="0">
 
300
<div class="variablelist"><table border="0" class="variablelist">
 
301
<colgroup>
286
302
<col align="left" valign="top">
 
303
<col>
 
304
</colgroup>
287
305
<tbody><tr>
288
306
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
289
307
<td>Any <span class="type">GtkWidget</span> on the screen.</td>