/usr/share/gtk-doc/html/libgwyapp/GwyTool.html is in libgwyddion20-doc 2.34-3ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Application Library Reference Manual: GwyTool</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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="GwyPlainTool.html" title="GwyPlainTool">
<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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GwyTool.description" class="shortcut">Description</a>
|
<a href="#GwyTool.object-hierarchy" class="shortcut">Object Hierarchy</a>
</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="GwyPlainTool.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyTool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyTool.top_of_page"></a>GwyTool</span></h2>
<p>GwyTool — Base class for tools</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyTool.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwyapp.h>
struct <a class="link" href="GwyTool.html#GwyTool-struct" title="struct GwyTool">GwyTool</a>;
struct <a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass">GwyToolClass</a>;
enum <a class="link" href="GwyTool.html#GwyToolResponseType" title="enum GwyToolResponseType">GwyToolResponseType</a>;
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-add-hide-button" title="gwy_tool_add_hide_button ()">gwy_tool_add_hide_button</a> (<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 href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> set_default</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-show" title="gwy_tool_show ()">gwy_tool_show</a> (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-hide" title="gwy_tool_hide ()">gwy_tool_hide</a> (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyTool.html#gwy-tool-is-visible" title="gwy_tool_is_visible ()">gwy_tool_is_visible</a> (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-data-switched" title="gwy_tool_data_switched ()">gwy_tool_data_switched</a> (<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 href="../libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-spectra-switched" title="gwy_tool_spectra_switched ()">gwy_tool_spectra_switched</a> (<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 href="../libgwyprocess/GwySpectra.html"><span class="type">GwySpectra</span></a> *spectra</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyTool.html#gwy-tool-restore-screen-position" title="gwy_tool_restore_screen_position ()">gwy_tool_restore_screen_position</a> (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyTool.html#gwy-tool-class-get-title" title="gwy_tool_class_get_title ()">gwy_tool_class_get_title</a> (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyTool.html#gwy-tool-class-get-stock-id" title="gwy_tool_class_get_stock_id ()">gwy_tool_class_get_stock_id</a> (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyTool.html#gwy-tool-class-get-tooltip" title="gwy_tool_class_get_tooltip ()">gwy_tool_class_get_tooltip</a> (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyTool.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GwyTool
+----<a class="link" href="GwyPlainTool.html" title="GwyPlainTool">GwyPlainTool</a>
</pre>
</div>
<div class="refsect1">
<a name="GwyTool.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GwyTool.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyTool-struct"></a><h3>struct GwyTool</h3>
<pre class="programlisting">struct GwyTool;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyToolClass"></a><h3>struct GwyToolClass</h3>
<pre class="programlisting">struct GwyToolClass {
GObjectClass parent_class;
const gchar *stock_id;
const gchar *tooltip;
const gchar *title;
const gchar *prefix;
gint default_width;
gint default_height;
void (*show)(GwyTool *tool);
void (*hide)(GwyTool *tool);
void (*data_switched)(GwyTool *tool,
GwyDataView *data_view);
void (*response)(GwyTool *tool,
gint response_id);
void (*spectra_switched)(GwyTool *tool,
GwySpectra *spectra);
void (*reserved2)(void);
void (*reserved3)(void);
void *priv;
};
</pre>
<p>
Tool class.
</p>
<p>
The fields <em class="parameter"><code>default_width</code></em> and <em class="parameter"><code>default_height</code></em> should be set only if a tool
dialog requires a different initial size from it would request (due to
shrinkable widgets). Since <a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> keeps dialog sizes stored in settings
and restores them automatically, these values essentially apply only to the
first use of a tool.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GwyToolClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyToolClass.stock-id"></a>stock_id</code></em>;</span></p></td>
<td>Tool icon stock id.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyToolClass.tooltip"></a>tooltip</code></em>;</span></p></td>
<td>Tooltip.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyToolClass.title"></a>title</code></em>;</span></p></td>
<td>Tool dialog title.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyToolClass.prefix"></a>prefix</code></em>;</span></p></td>
<td>Prefix in settings to store automatically remembered tool state
under, should be of the form <code class="literal">"/module/mytool"</code>.</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GwyToolClass.default-width"></a>default_width</code></em>;</span></p></td>
<td>Default initial window width, normally unset.</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GwyToolClass.default-height"></a>default_height</code></em>;</span></p></td>
<td>Default initial window height, normally unset.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.show"></a>show</code></em> ()</span></p></td>
<td>Tool show virtual method. Most tools do not need to override it,
unless they wish to handle lazy updates themselves.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.hide"></a>hide</code></em> ()</span></p></td>
<td>Tool hide virtual method. Most tools do not need to override it.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.data-switched"></a>data_switched</code></em> ()</span></p></td>
<td>Data switched virtual method.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.response"></a>response</code></em> ()</span></p></td>
<td>Dialog response virtual method. Hiding an closing is normally
handled in the base class, particular tools can handle only
responses from their specific buttons.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.spectra-switched"></a>spectra_switched</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.reserved2"></a>reserved2</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyToolClass.reserved3"></a>reserved3</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">void</span> *<em class="structfield"><code><a name="GwyToolClass.priv"></a>priv</code></em>;</span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyToolResponseType"></a><h3>enum GwyToolResponseType</h3>
<pre class="programlisting">typedef enum {
GWY_TOOL_RESPONSE_CLEAR = 1,
GWY_TOOL_RESPONSE_UPDATE = 2,
} GwyToolResponseType;
</pre>
<p>
Common tool dialog responses.
</p>
<p>
They do not have any special meaning for <a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> (yet?), nonetheless you
are encouraged to use them for consistency.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-TOOL-RESPONSE-CLEAR:CAPS"></a><span class="term"><code class="literal">GWY_TOOL_RESPONSE_CLEAR</code></span></p></td>
<td>Clear selection response.
</td>
</tr>
<tr>
<td><p><a name="GWY-TOOL-RESPONSE-UPDATE:CAPS"></a><span class="term"><code class="literal">GWY_TOOL_RESPONSE_UPDATE</code></span></p></td>
<td>Update calculated values (if not instant)
response.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-add-hide-button"></a><h3>gwy_tool_add_hide_button ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_add_hide_button (<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 href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> set_default</code></em>);</pre>
<p>
Adds a Hide button to a tool dialog.
</p>
<p>
All tools should have a Hide button added by this method. The reason why
it is not added automatically is because the usual placement of the Hide
button is next to the execution button (Apply), which is not present
for informational-only tools. In that case Hide should become the default
dialog button.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_default</code></em> :</span></p></td>
<td>Whether hide should become the default tool dialog response.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-show"></a><h3>gwy_tool_show ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_show (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);</pre>
<p>
Shows a tool's dialog.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-hide"></a><h3>gwy_tool_hide ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_hide (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);</pre>
<p>
Hides a tool's dialog.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-is-visible"></a><h3>gwy_tool_is_visible ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_tool_is_visible (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);</pre>
<p>
Checks whether a tool dialog is visible.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if tool dialog is visible, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is hidden.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-data-switched"></a><h3>gwy_tool_data_switched ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_data_switched (<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 href="../libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</code></em>);</pre>
<p>
Instructs a tool to switch to another data view.
</p>
<p>
This involves set up of the top layer of <em class="parameter"><code>data_view</code></em> and/or its selection
to the mode appropriate for <em class="parameter"><code>tool</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_view</code></em> :</span></p></td>
<td>A data view. It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, too.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-spectra-switched"></a><h3>gwy_tool_spectra_switched ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_spectra_switched (<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 href="../libgwyprocess/GwySpectra.html"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Instructs a tool to switch to another spectra object.
</p>
<p>
Bad things may happen when the spectra does not belong to the same container
as the currently active channel.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object. It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, too.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-restore-screen-position"></a><h3>gwy_tool_restore_screen_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_tool_restore_screen_position (<em class="parameter"><code><a class="link" href="GwyTool.html" title="GwyTool"><span class="type">GwyTool</span></a> *tool</code></em>);</pre>
<p>
Restores tool's dialog screen and position.
</p>
<p>
This function must be called when the tool dialog is not mapped yet.
The position is remembered within a session (not in the settings) for each
tool class. In Gwyddion, the program, at most one instance of each tool
exists so there is no abiguity which dialog position should be saved and
restored.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tool</code></em> :</span></p></td>
<td>A tool.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.33</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-class-get-title"></a><h3>gwy_tool_class_get_title ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_tool_class_get_title (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);</pre>
<p>
Gets the title of a tool class (this is a class method).
</p>
<p>
The title is normally used as a tool dialog title.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>A tool class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The title as a string owned by the tool class, untranslated.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-class-get-stock-id"></a><h3>gwy_tool_class_get_stock_id ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_tool_class_get_stock_id (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);</pre>
<p>
Gets the icon stock id of a tool class (this is a class method).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>A tool class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The stock id as a string owned by the tool class.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-class-get-tooltip"></a><h3>gwy_tool_class_get_tooltip ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_tool_class_get_tooltip (<em class="parameter"><code><a class="link" href="GwyTool.html#GwyToolClass" title="struct GwyToolClass"><span class="type">GwyToolClass</span></a> *klass</code></em>);</pre>
<p>
Gets the title of a tool class (this is a class method).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>A tool class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The tooltip as a string owned by the tool class, untranslated.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|