/usr/share/gtk-doc/html/libgwyapp/libgwyapp-help.html is in libgwyddion20-doc 2.50-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>help: Gwyddion Application Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="prev" href="libgwyapp-undo.html" title="undo">
<link rel="next" href="libgwyapp-log.html" title="log">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgwyapp-help.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyapp-undo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyapp-log.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyapp-help"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-help.top_of_page"></a>help</span></h2>
<p>help — User guide access</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgwyapp-help.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-proc-dialog" title="gwy_help_add_to_proc_dialog ()">gwy_help_add_to_proc_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-graph-dialog" title="gwy_help_add_to_graph_dialog ()">gwy_help_add_to_graph_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-volume-dialog" title="gwy_help_add_to_volume_dialog ()">gwy_help_add_to_volume_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-xyz-dialog" title="gwy_help_add_to_xyz_dialog ()">gwy_help_add_to_xyz_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-file-dialog" title="gwy_help_add_to_file_dialog ()">gwy_help_add_to_file_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-tool-dialog" title="gwy_help_add_to_tool_dialog ()">gwy_help_add_to_tool_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-window" title="gwy_help_add_to_window ()">gwy_help_add_to_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-add-to-window-uri" title="gwy_help_add_to_window_uri ()">gwy_help_add_to_window_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-show" title="gwy_help_show ()">gwy_help_show</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwyapp-help.html#gwy-help-is-available" title="gwy_help_is_available ()">gwy_help_is_available</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyapp-help.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags">GwyHelpFlags</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyapp-help.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <app/gwyapp.h>
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-help.description"></a><h2>Description</h2>
<p>Help functions add a Help button to dialogs and install a key press handler
responding to Help and F1 keys to all windows. For built-in modules,
invoking the help opens a web browser (using some generic and
system-specific means) pointing to the corresponding location in the user
guide. Third-party modules can use <a class="link" href="libgwyapp-help.html#gwy-help-add-to-window-uri" title="gwy_help_add_to_window_uri ()"><code class="function">gwy_help_add_to_window_uri()</code></a> to open a
web browser at an arbitrary URI.</p>
</div>
<div class="refsect1">
<a name="libgwyapp-help.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-help-add-to-proc-dialog"></a><h3>gwy_help_add_to_proc_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_proc_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a data processing function dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-proc-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a data processing function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-graph-dialog"></a><h3>gwy_help_add_to_graph_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_graph_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a graph function dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-graph-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a graph function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-volume-dialog"></a><h3>gwy_help_add_to_volume_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_volume_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a volume data processing function dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-volume-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a volume data processing function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-xyz-dialog"></a><h3>gwy_help_add_to_xyz_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_xyz_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a XYZ data processing function dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-xyz-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a XYZ data processing function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-45.html#api-index-2.45">2.45</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-file-dialog"></a><h3>gwy_help_add_to_file_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_file_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a file function dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-file-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a file function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-tool-dialog"></a><h3>gwy_help_add_to_tool_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_tool_dialog (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> *dialog</code></em>,
<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a tool dialog.</p>
<p>Note the help button will not be added if no help URI is found for the
currently running function or help is not available.</p>
<div class="refsect3">
<a name="gwy-help-add-to-tool-dialog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dialog</p></td>
<td class="parameter_description"><p>Main dialog for a tool function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tool</p></td>
<td class="parameter_description"><p>The tool.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-window"></a><h3>gwy_help_add_to_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_window (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fragment</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a window pointing to the user guide.</p>
<p>If the window is a <a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> a help button will be added by default (this
can be modified with <em class="parameter"><code>flags</code></em>
). Normal windows do not get help buttons.
No help may be added if help is not available.</p>
<p>This is a relatively low-level function and should not be necessary in
modules. An exception may be modules with multiple user interfaces
described in different parts of the guide – but this should be rare.</p>
<p>It is a suitable functions for adding help to base application windows,
such as channel or volume windows.</p>
<div class="refsect3">
<a name="gwy-help-add-to-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>A window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>Base file name in the user guide without any path or extensions,
for instance "statistical-analysis".</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fragment</p></td>
<td class="parameter_description"><p>Fragment identifier (without "#"), or possibly <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-add-to-window-uri"></a><h3>gwy_help_add_to_window_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_add_to_window_uri (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-help.html#GwyHelpFlags" title="enum GwyHelpFlags"><span class="type">GwyHelpFlags</span></a> flags</code></em>);</pre>
<p>Adds help to a window pointing to an arbitrary URI.</p>
<p>If the window is a <a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> a help button will be added by default (this
can be modified with <em class="parameter"><code>flags</code></em>
). Normal windows do not get help buttons.
No help may be added if help is not available.</p>
<p>This function should not be necessary anywhere within Gwyddion itself.
Use the functions pointing to the user guide instead as they can handle
language versions or changing the user guide base location.</p>
<p>It may be useful for third-party modules if they wish to add a help facility
behaving similarly to built-in modules.</p>
<div class="refsect3">
<a name="gwy-help-add-to-window-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>A window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>Full URI pointing to the help for <em class="parameter"><code>window</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Flags allowing to modify the help setup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-show"></a><h3>gwy_help_show ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_help_show (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fragment</code></em>);</pre>
<p>Immediately shows a specific help location.</p>
<p>This function should be rarely needed. It may fail if help is not
available.</p>
<div class="refsect3">
<a name="gwy-help-show.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>Base file name in the user guide without any path or extensions,
for instance "statistical-analysis".</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fragment</p></td>
<td class="parameter_description"><p>Fragment identifier (without "#"), or possibly <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-help-is-available"></a><h3>gwy_help_is_available ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gwy_help_is_available (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Check whether help is available.</p>
<p>This is a weak check that finds if we have any help-showing backend that
might work at all, have the user guide module map, and if the user guide
locations is a local directory it checks whether it exists. If it returns
<a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> it does not guarantee help will work. If it returns <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, however,
it means help will not work.</p>
<div class="refsect3">
<a name="gwy-help-is-available.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if help seems available, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
</div>
<div class="refsect1">
<a name="libgwyapp-help.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwyHelpFlags"></a><h3>enum GwyHelpFlags</h3>
<p>Flags controlling help setup and behaviour.</p>
<div class="refsect3">
<a name="GwyHelpFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GWY-HELP-DEFAULT:CAPS"></a>GWY_HELP_DEFAULT</p></td>
<td class="enum_member_description">
<p>No flags, the default behaviour.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GWY-HELP-NO-BUTTON:CAPS"></a>GWY_HELP_NO_BUTTON</p></td>
<td class="enum_member_description">
<p>Do not add a Help button, even to windows that are
dialogs.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-38.html#api-index-2.38">2.38</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|