/usr/share/gtk-doc/html/libgwyapp/GwyPlainTool.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 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 549 550 | <!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: GwyPlainTool</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="GwyTool.html" title="GwyTool">
<link rel="next" href="libgwyapp-module-utils.html" title="module utils">
<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="#GwyPlainTool.description" class="shortcut">Description</a>
|
<a href="#GwyPlainTool.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="GwyTool.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyapp-module-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyPlainTool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyPlainTool.top_of_page"></a>GwyPlainTool</span></h2>
<p>GwyPlainTool — Base class for simple tools</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyPlainTool.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwyapp.h>
struct <a class="link" href="GwyPlainTool.html#GwyPlainTool-struct" title="struct GwyPlainTool">GwyPlainTool</a>;
struct <a class="link" href="GwyPlainTool.html#GwyPlainToolClass" title="struct GwyPlainToolClass">GwyPlainToolClass</a>;
enum <a class="link" href="GwyPlainTool.html#GwyPlainToolChanged" title="enum GwyPlainToolChanged">GwyPlainToolChanged</a>;
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="GwyPlainTool.html#gwy-plain-tool-check-layer-type" title="gwy_plain_tool_check_layer_type ()">gwy_plain_tool_check_layer_type</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPlainTool.html#gwy-plain-tool-connect-selection" title="gwy_plain_tool_connect_selection ()">gwy_plain_tool_connect_selection</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> layer_type</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *bname</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPlainTool.html#gwy-plain-tool-ensure-layer" title="gwy_plain_tool_ensure_layer ()">gwy_plain_tool_ensure_layer</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> layer_type</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="GwyPlainTool.html#gwy-plain-tool-set-selection-key" title="gwy_plain_tool_set_selection_key ()">gwy_plain_tool_set_selection_key</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *bname</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GwyPlainTool.html#gwy-plain-tool-add-clear-button" title="gwy_plain_tool_add_clear_button ()">gwy_plain_tool_add_clear_button</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="GwyPlainTool.html#gwy-plain-tool-get-z-average" title="gwy_plain_tool_get_z_average ()">gwy_plain_tool_get_z_average</a> (<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *point</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> radius</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPlainTool.html#gwy-plain-tool-enable-object-deletion" title="gwy_plain_tool_enable_object_deletion ()">gwy_plain_tool_enable_object_deletion</a>
(<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkTreeView.html"><span class="type">GtkTreeView</span></a> *treeview</code></em>);
<a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="returnvalue">GwyRectSelectionLabels</span></a> * <a class="link" href="GwyPlainTool.html#gwy-rect-selection-labels-new" title="gwy_rect_selection_labels_new ()">gwy_rect_selection_labels_new</a> (<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> none_is_full</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GwyPlainTool.html#gwy-rect-selection-labels-get-table" title="gwy_rect_selection_labels_get_table ()">gwy_rect_selection_labels_get_table</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPlainTool.html#gwy-rect-selection-labels-select" title="gwy_rect_selection_labels_select ()">gwy_rect_selection_labels_select</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>,
<em class="parameter"><code><a href="../libgwydraw/GwySelection.html"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyPlainTool.html#gwy-rect-selection-labels-fill" title="gwy_rect_selection_labels_fill ()">gwy_rect_selection_labels_fill</a> (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>,
<em class="parameter"><code><a href="../libgwydraw/GwySelection.html"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *selreal</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *selpix</code></em>);
<a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels">GwyRectSelectionLabels</a>;
</pre>
</div>
<div class="refsect1">
<a name="GwyPlainTool.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GwyTool.html" title="GwyTool">GwyTool</a>
+----GwyPlainTool
</pre>
</div>
<div class="refsect1">
<a name="GwyPlainTool.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GwyPlainTool.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyPlainTool-struct"></a><h3>struct GwyPlainTool</h3>
<pre class="programlisting">struct GwyPlainTool;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyPlainToolClass"></a><h3>struct GwyPlainToolClass</h3>
<pre class="programlisting">struct GwyPlainToolClass {
GwyToolClass parent_class;
void (*data_changed)(GwyPlainTool *plain_tool);
void (*mask_changed)(GwyPlainTool *plain_tool);
void (*show_changed)(GwyPlainTool *plain_tool);
void (*selection_changed)(GwyPlainTool *plain_tool,
gint hint);
void (*selection_finished)(GwyPlainTool *plain_tool);
void (*reserved1)(void);
void (*reserved2)(void);
void (*reserved3)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyPlainToolChanged"></a><h3>enum GwyPlainToolChanged</h3>
<pre class="programlisting">typedef enum {
GWY_PLAIN_TOOL_CHANGED_DATA = 1 << 0,
GWY_PLAIN_TOOL_CHANGED_MASK = 1 << 1,
GWY_PLAIN_TOOL_CHANGED_SHOW = 1 << 2,
GWY_PLAIN_TOOL_CHANGED_SELECTION = 1 << 3,
GWY_PLAIN_TOOL_FINISHED_SELECTION = 1 << 4,
} GwyPlainToolChanged;
</pre>
<p>
The type of pending changes that accumulated during tool inactivity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-PLAIN-TOOL-CHANGED-DATA:CAPS"></a><span class="term"><code class="literal">GWY_PLAIN_TOOL_CHANGED_DATA</code></span></p></td>
<td>Channel data field was changed.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLAIN-TOOL-CHANGED-MASK:CAPS"></a><span class="term"><code class="literal">GWY_PLAIN_TOOL_CHANGED_MASK</code></span></p></td>
<td>Mask data field was changed.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLAIN-TOOL-CHANGED-SHOW:CAPS"></a><span class="term"><code class="literal">GWY_PLAIN_TOOL_CHANGED_SHOW</code></span></p></td>
<td>Presentation data field was changed.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLAIN-TOOL-CHANGED-SELECTION:CAPS"></a><span class="term"><code class="literal">GWY_PLAIN_TOOL_CHANGED_SELECTION</code></span></p></td>
<td>Selection was changed.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLAIN-TOOL-FINISHED-SELECTION:CAPS"></a><span class="term"><code class="literal">GWY_PLAIN_TOOL_FINISHED_SELECTION</code></span></p></td>
<td>Selection was finished (that is emitted
<a href="../libgwydraw/GwySelection.html#GwySelection-finished"><span class="type">"finished"</span></a>).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-check-layer-type"></a><h3>gwy_plain_tool_check_layer_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> gwy_plain_tool_check_layer_type (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Checks for a required layer type.
</p>
<p>
If the layer exists, its <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> is returned. If it does not exist, zero
is returned and a warning message is added to the tool dialog. In addition,
it sets <em class="parameter"><code>init_failed</code></em> to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</p>
<p>
Therefore, this function should be called early in tool instance
initialization and it should not be called again once it fails.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Layer type name (e.g. <code class="literal">"GwyLayerPoint"</code>).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The type of the layer, or 0 on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-connect-selection"></a><h3>gwy_plain_tool_connect_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_plain_tool_connect_selection (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> layer_type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *bname</code></em>);</pre>
<p>
Sets up a plain tool to automatically manage layer selection.
</p>
<p>
When <em class="parameter"><code>layer_type</code></em> is 0 and <em class="parameter"><code>bname</code></em> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, plain tool stops automatically
managing selection (hopefully).
</p>
<p>
This method performs <a class="link" href="GwyPlainTool.html#gwy-plain-tool-ensure-layer" title="gwy_plain_tool_ensure_layer ()"><code class="function">gwy_plain_tool_ensure_layer()</code></a> and
<a class="link" href="GwyPlainTool.html#gwy-plain-tool-set-selection-key" title="gwy_plain_tool_set_selection_key ()"><code class="function">gwy_plain_tool_set_selection_key()</code></a>, connecting to the selection and making
sure the <em class="parameter"><code>selection</code></em> field always points to the correct selection object
(or is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).
</p>
<p>
The <em class="parameter"><code>selection_changed</code></em> method of <a class="link" href="GwyPlainTool.html#GwyPlainToolClass" title="struct GwyPlainToolClass"><span class="type">GwyPlainToolClass</span></a> is only invoked for a
tool instance once this method was called to set up the selection tracking.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_type</code></em> :</span></p></td>
<td>Layer type. Use <a class="link" href="GwyPlainTool.html#gwy-plain-tool-check-layer-type" title="gwy_plain_tool_check_layer_type ()"><code class="function">gwy_plain_tool_check_layer_type()</code></a> in tool
instance initialization to check for layer types.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bname</code></em> :</span></p></td>
<td>Selection key base name, for example <code class="literal">"line"</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-ensure-layer"></a><h3>gwy_plain_tool_ensure_layer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_plain_tool_ensure_layer (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> layer_type</code></em>);</pre>
<p>
Makes sure a plain tool's layer is of the correct type.
</p>
<p>
This is a low-level function, normally you would use
<a class="link" href="GwyPlainTool.html#gwy-plain-tool-connect-selection" title="gwy_plain_tool_connect_selection ()"><code class="function">gwy_plain_tool_connect_selection()</code></a>.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer_type</code></em> :</span></p></td>
<td>Layer type. Use <a class="link" href="GwyPlainTool.html#gwy-plain-tool-check-layer-type" title="gwy_plain_tool_check_layer_type ()"><code class="function">gwy_plain_tool_check_layer_type()</code></a> in
tool instance initialization to check for layer types.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-set-selection-key"></a><h3>gwy_plain_tool_set_selection_key ()</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_plain_tool_set_selection_key (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *bname</code></em>);</pre>
<p>
Constructs selection key from data key and sets it on the vector layer.
</p>
<p>
This is a low-level function, normally you would use
<a class="link" href="GwyPlainTool.html#gwy-plain-tool-connect-selection" title="gwy_plain_tool_connect_selection ()"><code class="function">gwy_plain_tool_connect_selection()</code></a>.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bname</code></em> :</span></p></td>
<td>Selection key base name, for example <code class="literal">"line"</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The full key (as a layer-owned string).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-add-clear-button"></a><h3>gwy_plain_tool_add_clear_button ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_plain_tool_add_clear_button (<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>);</pre>
<p>
Adds a `Clear' button to a plain tool.
</p>
<p>
This button works with automatically managed selection (see
<a class="link" href="GwyPlainTool.html#gwy-plain-tool-connect-selection" title="gwy_plain_tool_connect_selection ()"><code class="function">gwy_plain_tool_connect_selection()</code></a>). If you want to manage selection
yourself add the button with <a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html#gtk-dialog-add-button"><code class="function">gtk_dialog_add_button()</code></a>.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The button widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-get-z-average"></a><h3>gwy_plain_tool_get_z_average ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_plain_tool_get_z_average (<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *point</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> radius</code></em>);</pre>
<p>
Computes average value over a part of data field <em class="parameter"><code>dfield</code></em>.
</p>
<p>
It is not an error if part of it lies outside the data field borders
(it is simply not counted in), however the intersection have to be nonempty.
</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>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>point</code></em> :</span></p></td>
<td>Real X and Y-coordinate of area center in physical units.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Area radius in pixels, 1 means a signle pixel. The actual radius
passed to <a href="../libgwyprocess/libgwyprocess-elliptic.html#gwy-data-field-circular-area-extract"><code class="function">gwy_data_field_circular_area_extract()</code></a> is <em class="parameter"><code>radius</code></em>-0.5.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The average value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plain-tool-enable-object-deletion"></a><h3>gwy_plain_tool_enable_object_deletion ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_plain_tool_enable_object_deletion
(<em class="parameter"><code><a class="link" href="GwyPlainTool.html" title="GwyPlainTool"><span class="type">GwyPlainTool</span></a> *plain_tool</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeView.html"><span class="type">GtkTreeView</span></a> *treeview</code></em>);</pre>
<p>
Enables deletion of selection objects by presssing Delete in a tree view
diplaying them.
</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>plain_tool</code></em> :</span></p></td>
<td>A plain tool.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>treeview</code></em> :</span></p></td>
<td>A tree view that displays selection objects in order, each row
corresponding to one selection object.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rect-selection-labels-new"></a><h3>gwy_rect_selection_labels_new ()</h3>
<pre class="programlisting"><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="returnvalue">GwyRectSelectionLabels</span></a> * gwy_rect_selection_labels_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> none_is_full</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>);</pre>
<p>
Creates a table displaying rectangular selection information.
</p>
<p>
The returned object will destroy itself when the table is destroyed.
</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>none_is_full</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to tread unselected state as full data selected.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>Callback to call when the selection is edited.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cbdata</code></em> :</span></p></td>
<td>Data to pass to <em class="parameter"><code>callback</code></em> (as the first argument).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created rectangular selection information, as an opaque
pointer. The table widget can be obtained with
<a class="link" href="GwyPlainTool.html#gwy-rect-selection-labels-get-table" title="gwy_rect_selection_labels_get_table ()"><code class="function">gwy_rect_selection_labels_get_table()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rect-selection-labels-get-table"></a><h3>gwy_rect_selection_labels_get_table ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_rect_selection_labels_get_table (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>);</pre>
<p>
Gets the table widget of a rectangular selection information.
</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>rlabels</code></em> :</span></p></td>
<td>Rectangular selection information table.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The table as a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rect-selection-labels-select"></a><h3>gwy_rect_selection_labels_select ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_rect_selection_labels_select (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>,
<em class="parameter"><code><a href="../libgwydraw/GwySelection.html"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-rect-selection-labels-fill"></a><h3>gwy_rect_selection_labels_fill ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_rect_selection_labels_fill (<em class="parameter"><code><a class="link" href="GwyPlainTool.html#GwyRectSelectionLabels" title="GwyRectSelectionLabels"><span class="type">GwyRectSelectionLabels</span></a> *rlabels</code></em>,
<em class="parameter"><code><a href="../libgwydraw/GwySelection.html"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="../libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *selreal</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *selpix</code></em>);</pre>
<p>
Updates rectangular selection info display.
</p>
<p>
It is possible to pass <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>dfield</code></em> but non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>selection</code></em>. This can
lead to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> return value (if the selection is non-empty), but the labels
will be still cleared as there is no way to convert between real and
pixel coordinates.
</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>rlabels</code></em> :</span></p></td>
<td>Rectangular selection info table.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>A rectangular selection to fill information from. It can
be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to clear the labels.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dfield</code></em> :</span></p></td>
<td>A data field to use for real/pixel coordinate transforms.
It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to clear the labels.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selreal</code></em> :</span></p></td>
<td>If not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, must be an array of size at least 4 and will be
filled with selection data xmin, ymin, xmax, ymax in physical
units.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selpix</code></em> :</span></p></td>
<td>If not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, must be an array of size at least 4 and will be
filled with selection data xmin, ymin, xmax, ymax in pixels.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a selection is present, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyRectSelectionLabels"></a><h3>GwyRectSelectionLabels</h3>
<pre class="programlisting">typedef struct _GwyRectSelectionLabels GwyRectSelectionLabels;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|