/usr/share/gtk-doc/html/libgwydgets/GwyLayerBasic.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 | <!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 Widgets Library Reference Manual: GwyLayerBasic</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Widgets Library Reference Manual">
<link rel="up" href="DataWindowWidgets.html" title="Data Windows and Views">
<link rel="prev" href="GwyVectorLayer.html" title="GwyVectorLayer">
<link rel="next" href="GwyLayerMask.html" title="GwyLayerMask">
<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="#GwyLayerBasic.description" class="shortcut">Description</a>
|
<a href="#GwyLayerBasic.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwyLayerBasic.properties" class="shortcut">Properties</a>
|
<a href="#GwyLayerBasic.signals" class="shortcut">Signals</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DataWindowWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GwyVectorLayer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyLayerMask.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyLayerBasic"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyLayerBasic.top_of_page"></a>GwyLayerBasic</span></h2>
<p>GwyLayerBasic — Display data colored with a gradient</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyLayerBasic.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="GwyLayerBasic.html#GwyLayerBasic-struct" title="struct GwyLayerBasic">GwyLayerBasic</a>;
struct <a class="link" href="GwyLayerBasic.html#GwyLayerBasicClass" title="struct GwyLayerBasicClass">GwyLayerBasicClass</a>;
<a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="returnvalue">GwyPixmapLayer</span></a> * <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-new" title="gwy_layer_basic_new ()">gwy_layer_basic_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-get-range" title="gwy_layer_basic_get_range ()">gwy_layer_basic_get_range</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *min</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *max</code></em>);
<a class="link" href="libgwydgets-gwydgetenums.html#GwyLayerBasicRangeType" title="enum GwyLayerBasicRangeType"><span class="returnvalue">GwyLayerBasicRangeType</span></a> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-get-range-type" title="gwy_layer_basic_get_range_type ()">gwy_layer_basic_get_range_type</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-gradient-key" title="gwy_layer_basic_set_gradient_key ()">gwy_layer_basic_set_gradient_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</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="GwyLayerBasic.html#gwy-layer-basic-get-gradient-key" title="gwy_layer_basic_get_gradient_key ()">gwy_layer_basic_get_gradient_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-presentation-key" title="gwy_layer_basic_set_presentation_key ()">gwy_layer_basic_set_presentation_key</a>
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</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="GwyLayerBasic.html#gwy-layer-basic-get-presentation-key" title="gwy_layer_basic_get_presentation_key ()">gwy_layer_basic_get_presentation_key</a>
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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="GwyLayerBasic.html#gwy-layer-basic-get-has-presentation" title="gwy_layer_basic_get_has_presentation ()">gwy_layer_basic_get_has_presentation</a>
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-min-max-key" title="gwy_layer_basic_set_min_max_key ()">gwy_layer_basic_set_min_max_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *prefix</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="GwyLayerBasic.html#gwy-layer-basic-get-min-max-key" title="gwy_layer_basic_get_min_max_key ()">gwy_layer_basic_get_min_max_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-range-type-key" title="gwy_layer_basic_set_range_type_key ()">gwy_layer_basic_set_range_type_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</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="GwyLayerBasic.html#gwy-layer-basic-get-range-type-key" title="gwy_layer_basic_get_range_type_key ()">gwy_layer_basic_get_range_type_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.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>
+----<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkObject.html">GtkObject</a>
+----<a class="link" href="GwyDataViewLayer.html" title="GwyDataViewLayer">GwyDataViewLayer</a>
+----<a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer">GwyPixmapLayer</a>
+----GwyLayerBasic
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic--default-range-type" title='The "default-range-type" property'>default-range-type</a>" <a class="link" href="libgwydgets-gwydgetenums.html#GwyLayerBasicRangeType" title="enum GwyLayerBasicRangeType"><span class="type">GwyLayerBasicRangeType</span></a> : Read / Write
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic--gradient-key" title='The "gradient-key" property'>gradient-key</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic--min-max-key" title='The "min-max-key" property'>min-max-key</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic--presentation-key" title='The "presentation-key" property'>presentation-key</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic--range-type-key" title='The "range-type-key" property'>range-type-key</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GwyLayerBasic.html#GwyLayerBasic-presentation-switched" title='The "presentation-switched" signal'>presentation-switched</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> is a data view layer that can paint data with a false color
gradient. It is not normally usable outside a <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a>.
</p>
<p>
The layer takes all infromation from its parent <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a>, therefore you
do not set its properties directly, but you change them in the corresponding
<a href="../libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> and/or use methods like <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-gradient-key" title="gwy_layer_basic_set_gradient_key ()"><code class="function">gwy_layer_basic_set_gradient_key()</code></a> to
make the layer read a different value from the container.
</p>
<p>
Several types of mapping of data to colors are available, see
<a class="link" href="libgwydgets-gwydgetenums.html#GwyLayerBasicRangeType" title="enum GwyLayerBasicRangeType"><span class="type">GwyLayerBasicRangeType</span></a> for their description.
</p>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyLayerBasic-struct"></a><h3>struct GwyLayerBasic</h3>
<pre class="programlisting">struct GwyLayerBasic;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerBasicClass"></a><h3>struct GwyLayerBasicClass</h3>
<pre class="programlisting">struct GwyLayerBasicClass {
GwyPixmapLayerClass parent_class;
/* signals */
void (*presentation_switched)(GwyLayerBasic *basic_layer);
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-new"></a><h3>gwy_layer_basic_new ()</h3>
<pre class="programlisting"><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="returnvalue">GwyPixmapLayer</span></a> * gwy_layer_basic_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new basic data displaying layer.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created layer.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-range"></a><h3>gwy_layer_basic_get_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_basic_get_range (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *min</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> *max</code></em>);</pre>
<p>
Gets the range colors are mapped from in current mode.
</p>
<p>
This function does not take presentations into account. It always returns
ther range corresponding to the underlying data even if a presentation is
shown instead.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td>Location to store range minimum to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>Location to store range maximum to.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-range-type"></a><h3>gwy_layer_basic_get_range_type ()</h3>
<pre class="programlisting"><a class="link" href="libgwydgets-gwydgetenums.html#GwyLayerBasicRangeType" title="enum GwyLayerBasicRangeType"><span class="returnvalue">GwyLayerBasicRangeType</span></a> gwy_layer_basic_get_range_type (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Gets the current color mapping mode.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current color mapping mode.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-set-gradient-key"></a><h3>gwy_layer_basic_set_gradient_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_basic_set_gradient_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</code></em>);</pre>
<p>
Sets the container key of the colour gradient to use to visualize data.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Container string key identifying the color gradient to use.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-gradient-key"></a><h3>gwy_layer_basic_get_gradient_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_layer_basic_get_gradient_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Gets key identifying color gradient.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string key, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it isn't set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-set-presentation-key"></a><h3>gwy_layer_basic_set_presentation_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_basic_set_presentation_key
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</code></em>);</pre>
<p>
Sets the container key of the data field to actually display by a basic
layer.
</p>
<p>
The data field set with <a class="link" href="GwyPixmapLayer.html#gwy-pixmap-layer-get-data-key" title="gwy_pixmap_layer_get_data_key ()"><code class="function">gwy_pixmap_layer_get_data_key()</code></a> is used to obtain
values, it determines physical dimensions, etc. When a data field is set
with this method, it is displayed instead of the actual data.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Container string key identifying the data field to actually display.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-presentation-key"></a><h3>gwy_layer_basic_get_presentation_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_layer_basic_get_presentation_key
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Gets the key identifying data field this pixmap layer actually displays.
</p>
<p>
See <a class="link" href="GwyLayerBasic.html#gwy-layer-basic-set-presentation-key" title="gwy_layer_basic_set_presentation_key ()"><code class="function">gwy_layer_basic_set_presentation_key()</code></a> for details.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string key, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it isn't set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-has-presentation"></a><h3>gwy_layer_basic_get_has_presentation ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_layer_basic_get_has_presentation
(<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Tests whether a basic layer displays a presentation instead of the data.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</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 the layer has a presentation, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> it it displays the
data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-set-min-max-key"></a><h3>gwy_layer_basic_set_min_max_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_basic_set_min_max_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *prefix</code></em>);</pre>
<p>
Sets basic layer fixed range minimum and maximum.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>Prefix of keys identifying minimum and maximum values for fixed
range, "/min" and "/max" is appended to it to get the individual
minimum and maximum keys.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-min-max-key"></a><h3>gwy_layer_basic_get_min_max_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_layer_basic_get_min_max_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Gets prefix identifying fixed range minimum and maximum.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The prefix, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it isn't set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-set-range-type-key"></a><h3>gwy_layer_basic_set_range_type_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_basic_set_range_type_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</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> *key</code></em>);</pre>
<p>
Sets the container key of the color range mapping type to use to visualize
data.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Container string key identifying the range type to use.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-basic-get-range-type-key"></a><h3>gwy_layer_basic_get_range_type_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_layer_basic_get_range_type_key (<em class="parameter"><code><a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *basic_layer</code></em>);</pre>
<p>
Gets key identifying color range mapping type.
</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>basic_layer</code></em> :</span></p></td>
<td>A basic data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string key, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it isn't set.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwyLayerBasic--default-range-type"></a><h3>The <code class="literal">"default-range-type"</code> property</h3>
<pre class="programlisting"> "default-range-type" <a class="link" href="libgwydgets-gwydgetenums.html#GwyLayerBasicRangeType" title="enum GwyLayerBasicRangeType"><span class="type">GwyLayerBasicRangeType</span></a> : Read / Write</pre>
<p>
The :default-range-type-key property determines the color mapping range
type used when the type is unset in the container.
</p>
<p>Default value: GWY_LAYER_BASIC_RANGE_FULL</p>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerBasic--gradient-key"></a><h3>The <code class="literal">"gradient-key"</code> property</h3>
<pre class="programlisting"> "gradient-key" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The :gradient-key property is the container key used to identify
<a href="../libgwydraw/GwyGradient.html"><span class="type">GwyGradient</span></a> data is colored with.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerBasic--min-max-key"></a><h3>The <code class="literal">"min-max-key"</code> property</h3>
<pre class="programlisting"> "min-max-key" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The :min-max-key property is the container key prefix used to identify
fixed range minimum and maximum.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerBasic--presentation-key"></a><h3>The <code class="literal">"presentation-key"</code> property</h3>
<pre class="programlisting"> "presentation-key" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The :presentation-key property is the container key used to identify
presentation data field .
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerBasic--range-type-key"></a><h3>The <code class="literal">"range-type-key"</code> property</h3>
<pre class="programlisting"> "range-type-key" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The :range-type-key property is the container key used to identify
color range type.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwyLayerBasic-presentation-switched"></a><h3>The <code class="literal">"presentation-switched"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> *gwydataview,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
The ::presentation-switched signal is emitted when the presentation
state changes, that is when a layer which displayed data directly
starts displaying a presentation, or conversely when it stops displaying
a presentation.
</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>gwydataview</code></em> :</span></p></td>
<td>The <a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GwyLayerBasic.see-also"></a><h2>See Also</h2>
<a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a> -- data display widget,
<a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> -- display data as color mask,
<a href="../libgwydraw/GwyGradient.html"><span class="type">GwyGradient</span></a> -- color gradient representation
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|