/usr/share/gtk-doc/html/libgwydgets/standard-vector-layers.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 | <!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: Standard Vector Layers</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="GwyColorAxis.html" title="GwyColorAxis">
<link rel="next" href="GraphWidgets.html" title="Graphs">
<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"></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="GwyColorAxis.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GraphWidgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="standard-vector-layers"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Standard Vector Layers</span></h2>
<p>Standard Vector Layers —
Vector layers that are distributed with <span class="application">Gwyddion</span>
</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="id-1.3.11.3"></a><h2>Overview</h2>
<p>
Vector layers, implementing means how user can draw on data views, are
provided by <a href="../libgwymodule/libgwymodule-gwymodule-layer.html">layer modules</a>, so that third party tools (implemented by
<a href="../libgwymodule/libgwymodule-gwymodule-tool.html">tool modules</a>)
can define their own means of user interaction.
</p>
<p>
There are several standard layers distributed with <span class="application">Gwyddion</span>,
and their features and interface is the subject of this section.
All layers are subclasses of <a class="link" href="GwyVectorLayer.html" title="GwyVectorLayer">GwyVectorLayer</a>
sharing its basic interface.
Each layer lets the user draw or select different shapes, therefore each module also
defines its own selection object type determining the format of selection data.
All selections are subclasses of <a href="../libgwydraw/GwySelection.html">GwySelection</a>.
By convention, layer type Foo is called GwyLayerFoo and the corresponding selection
type GwySelectionFoo.
</p>
<p>
Layers and selections sometimes have additional object properties not present in the
base classes, these are described here too.
</p>
</div>
<div class="refsect1">
<a name="id-1.3.11.4"></a><h2>GwyLayerAxis, GwySelectionAxis</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#g-object-new">g_object_new</a>(<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerAxis"), NULL);
<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#g-object-new">g_object_new</a>(<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionAxis"), NULL);
</pre>
<p>
Layer allows to select one or more horizontal or vertical (full-width or
full-height) lines, called axes. It can be also viewes as a way to
select separate x or y coordinates.
</p>
<p>
Selection data consists of single coordinates.
More precisely, of y-coordinates for horizontal axes and x-coordinates for vertical
axes. Each coordinate represents a selected axis.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.4.5"></a>GwyLayerAxis properties</h3></div></div></div>
<p>None.</p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.4.6"></a>GwySelectionAxis properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a name="GwySelectionAxis--orientation"></a>"<code class="literal">orientation</code>" (<a href="../libgwyprocess/libgwyprocess-gwyprocessenums.html#GwyOrientation">GwyOrientation</a> : Read / Write)</span></p></td>
<td><p>
Line orientation: horizontal or vertical.
Default orientation is horizontal.
</p></td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="id-1.3.11.5"></a><h2>GwyLayerEllipse, GwySelectionEllipse</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#g-object-new">g_object_new</a>(<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerEllipse"), NULL);
<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#g-object-new">g_object_new</a>(<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionEllipse"), NULL);
</pre>
<p>
Layer allows to select a number of ellipses.
</p>
<p>
Selection data consists of quadruples of coordinates (x<sub>0</sub>,
y<sub>0</sub>, x<sub>1</sub>, y<sub>1</sub>),
each representing one selected ellipse, where
x<sub>0</sub> and y<sub>0</sub> are coordinates of one
bounding box corner and x<sub>1</sub> and y<sub>1</sub>
of the opposite corner. Each one can be any of the four bounding box corners, there
is no guarantee one is for example always top-left.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.5.5"></a>GwyLayerEllipse properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a name="GwyLayerEllipse--draw-reflection"></a>"<code class="literal">draw-reflection</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether central reflection of selection should be drawn too.
The default is to not draw reflection.
</p></td>
</tr>
<tr>
<td><p><span class="term"><a name="GwyLayerEllipse--snap-to-center"></a>"<code class="literal">snap-to-center</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether the selection should snap to the center. Default is to
not snap.
</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.5.6"></a>GwySelectionEllipse properties</h3></div></div></div>
<p>None.</p>
</div>
</div>
<div class="refsect1">
<a name="id-1.3.11.6"></a><h2>GwyLayerLine, GwySelectionLine</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#g-object-new">g_object_new</a>(<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerLine"), NULL);
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionLine"), NULL);
</pre>
<p>
Layer allows to select one or more lines of arbitrary orientation and length,
optionally can display line numbers next to each line.
</p>
<p>
Selection data consists of quadruples of coordinates (x<sub>0</sub>,
y<sub>0</sub>, x<sub>1</sub>, y<sub>1</sub>),
each representing one selected line, where
x<sub>0</sub> and y<sub>0</sub> are
coordinates of one line end and x<sub>1</sub> and y<sub>1</sub>
of the other end.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.6.5"></a>GwyLayerLine properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a name="GwyLayerLine--line-numbers"></a>"<code class="literal">line-numbers</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether line numbers should be displayed next to them.
Default is to show line numbers.
</p></td>
</tr></tbody>
</table></div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.6.6"></a>GwySelectionLine properties</h3></div></div></div>
<p>None.</p>
</div>
</div>
<div class="refsect1">
<a name="id-1.3.11.7"></a><h2>GwyLayerPoint, GwySelectionPoint</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerPoint"), NULL);
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionPoint"), NULL);
</pre>
<p>
Layer allows to select a number of points, either displayed as crosses,
crosses with concentric circles, or with no graphical representation (the
latter mainly useful with only one selected point).
</p>
<p>
Selection data consists of coordinate pairs (x, y) representing selected points.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.7.5"></a>GwyLayerPoint properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a name="GwyLayerPoint--draw-marker"></a>"<code class="literal">draw-marker</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
If set to TRUE, points will be displayed. Otherwise they will be invisible.
</p></td>
</tr>
<tr>
<td><p><span class="term"><a name="GwyLayerPoint--marker-radius"></a>"<code class="literal">marker-radius</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Specifies the radius of the circle to draw around all selected points.
If set to zero and/or if "<code class="literal">draw-marker</code>" is
set to FALSE, no circle will be drawn.
Default is a radius of zero.
</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.7.6"></a>GwySelectionPoint properties</h3></div></div></div>
<p>None.</p>
</div>
</div>
<div class="refsect1">
<a name="id-1.3.11.8"></a><h2>GwyLayerRectangle, GwySelectionRectangle</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerRectangle"), NULL);
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionRectangle"), NULL);
</pre>
<p>
Layer allows to select a number of rectangles, that can be drawn with a couple of
fancy/special styles.
</p>
<p>
Selection data consists of quadruples of coordinates (x<sub>0</sub>,
y<sub>0</sub>, x<sub>1</sub>, y<sub>1</sub>),
each representing one selected rectangle, where
x<sub>0</sub> and y<sub>0</sub> are coordinates of one corner
and x<sub>1</sub> and y<sub>1</sub>
of the opposite corner. Each one can be any of the four rectangle corners, there
is no guarantee one is for example always top-left.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.8.5"></a>GwyLayerRectangle properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a name="GwyLayerRectangle--is-crop"></a>"<code class="literal">is-crop</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether lines should be drawn always from border to border, as in the Crop tool.
The default is to draw just outline of the selected rectangle.
</p></td>
</tr>
<tr>
<td><p><span class="term"><a name="GwyLayerRectangle--draw-reflection"></a>"<code class="literal">draw-reflection</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether central reflection of selection should be drawn too.
The default is to not draw reflection.
</p></td>
</tr>
<tr>
<td><p><span class="term"><a name="GwyLayerRectangle--snap-to-center"></a>"<code class="literal">snap-to-center</code>" (gboolean : Read / Write)</span></p></td>
<td><p>
Whether the selection should snap to the center. Default is to
not snap.
</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.8.6"></a>GwySelectionRectangle properties</h3></div></div></div>
<p>None.</p>
</div>
</div>
<div class="refsect1">
<a name="id-1.3.11.9"></a><h2>GwyLayerLattice, GwySelectionLattice</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwyLayerLattice"), NULL);
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject*</a> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-new">g_object_new</a>(<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#g-type-from-name">g_type_from_name</a>("GwySelectionLattice"), NULL);
</pre>
<p>
Layer allows to select a pair of two-dimensional vectors, that represent a lattice in the plane.
The selection is also visualised as a lattice.
</p>
<p>
Selection data consists of quadruples of coordinates (x<sub>0</sub>,
y<sub>0</sub>, x<sub>1</sub>, y<sub>1</sub>),
each representing the two selected lattice vectors, where
x<sub>0</sub> and y<sub>0</sub> are coordinates of one vector
and x<sub>1</sub> and y<sub>1</sub>
of the other.
</p>
<p>
Although the selection can contain multiple such pairs, the layer ignores all except
the first one.
</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.9.6"></a>GwyLayerLattice properties</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><a name="GwyLayerLattice--n-lines"></a>"<code class="literal">n-lines</code>" (guint : Read / Write)</span></p></td>
<td><p>
The number of grille lines drawn along each vector.
</p></td>
</tr></tbody>
</table></div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="id-1.3.11.9.7"></a>GwySelectionLattice properties</h3></div></div></div>
<p>None.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|