/usr/share/gtk-doc/html/libgwydgets/GwyLayerMask.html is in libgwyddion20-doc 2.26-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyLayerMask</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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="GwyLayerBasic.html" title="GwyLayerBasic">
<link rel="next" href="GwyColorAxis.html" title="GwyColorAxis">
<meta name="generator" content="GTK-Doc V1.8 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GwyLayerBasic.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DataWindowWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GwyColorAxis.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GwyLayerMask.synopsis" class="shortcut">Top</a>
|
<a href="#GwyLayerMask.description" class="shortcut">Description</a>
|
<a href="#GwyLayerMask.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwyLayerMask.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GwyLayerMask"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyLayerMask.top_of_page"></a>GwyLayerMask</span></h2>
<p>GwyLayerMask — Display data as color mask</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyLayerMask.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="GwyLayerMask.html#GwyLayerMask-struct" title="struct GwyLayerMask">GwyLayerMask</a>;
struct <a class="link" href="GwyLayerMask.html#GwyLayerMaskClass" title="struct GwyLayerMaskClass">GwyLayerMaskClass</a>;
<a href="./../libgwydraw/libgwydraw/libgwydraw-GwyRGBA.html#GwyRGBA"><span class="returnvalue">GwyRGBA</span></a> <a class="link" href="GwyLayerMask.html#gwy-layer-mask-get-color" title="gwy_layer_mask_get_color ()">gwy_layer_mask_get_color</a> (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_layer</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="GwyLayerMask.html#gwy-layer-mask-get-color-key" title="gwy_layer_mask_get_color_key ()">gwy_layer_mask_get_color_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_layer</code></em>);
<a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="returnvalue">GwyPixmapLayer</span></a> * <a class="link" href="GwyLayerMask.html#gwy-layer-mask-new" title="gwy_layer_mask_new ()">gwy_layer_mask_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyLayerMask.html#gwy-layer-mask-set-color-key" title="gwy_layer_mask_set_color_key ()">gwy_layer_mask_set_color_key</a> (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_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>);
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerMask.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>
+----GwyLayerMask
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerMask.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwyLayerMask.html#GwyLayerMask--color-key" title='The "color-key" property'>color-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
</pre>
</div>
<div class="refsect1">
<a name="GwyLayerMask.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> is a data view layer that can paint data as a color mask with
varying opacity. 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/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> and/or use methods like <a class="link" href="GwyLayerMask.html#gwy-layer-mask-set-color-key" title="gwy_layer_mask_set_color_key ()"><code class="function">gwy_layer_mask_set_color_key()</code></a> to
make the layer read a different value from the container.
</p>
</div>
<div class="refsect1">
<a name="GwyLayerMask.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyLayerMask-struct"></a><h3>struct GwyLayerMask</h3>
<pre class="programlisting">struct GwyLayerMask;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyLayerMaskClass"></a><h3>struct GwyLayerMaskClass</h3>
<pre class="programlisting">struct GwyLayerMaskClass {
GwyPixmapLayerClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-mask-get-color"></a><h3>gwy_layer_mask_get_color ()</h3>
<pre class="programlisting"><a href="./../libgwydraw/libgwydraw/libgwydraw-GwyRGBA.html#GwyRGBA"><span class="returnvalue">GwyRGBA</span></a> gwy_layer_mask_get_color (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_layer</code></em>);</pre>
<p>
Returns the color used by a mask layer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_layer</code></em> :</span></p></td>
<td>A mask layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The color as <a href="./../libgwydraw/libgwydraw/libgwydraw-GwyRGBA.html#GwyRGBA"><span class="type">GwyRGBA</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-layer-mask-get-color-key"></a><h3>gwy_layer_mask_get_color_key ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_layer_mask_get_color_key (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_layer</code></em>);</pre>
<p>
Gets prefix identifying color components.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_layer</code></em> :</span></p></td>
<td>A mask 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="http://developer.gnome.org/doc/API/2.0/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-mask-new"></a><h3>gwy_layer_mask_new ()</h3>
<pre class="programlisting"><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="returnvalue">GwyPixmapLayer</span></a> * gwy_layer_mask_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new mask layer.
</p>
<p>
By default, is uses a transparent color (thus not displaying anything).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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-mask-set-color-key"></a><h3>gwy_layer_mask_set_color_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_layer_mask_set_color_key (<em class="parameter"><code><a class="link" href="GwyLayerMask.html" title="GwyLayerMask"><span class="type">GwyLayerMask</span></a> *mask_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>);</pre>
<p>
Sets the container key of colour components of a mask layer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_layer</code></em> :</span></p></td>
<td>A mask layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>Prefix of keys identifying mask color components, "/red", "/green",
"/blue", and "/alpha" is appended to it to get the individual
keys.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GwyLayerMask.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwyLayerMask--color-key"></a><h3>The <code class="literal">"color-key"</code> property</h3>
<pre class="programlisting"> "color-key" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The :color-key property is the container key used to identify mask color
in container.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GwyLayerMask.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="GwyLayerBasic.html" title="GwyLayerBasic"><span class="type">GwyLayerBasic</span></a> -- display data colored with a gradient,
<a href="./../libgwydraw/libgwydraw/libgwydraw-GwyRGBA.html#GwyRGBA"><span class="type">GwyRGBA</span></a> -- color representation
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|