/usr/share/gtk-doc/html/libgwydgets/GwyPixmapLayer.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyPixmapLayer</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="GwyDataViewLayer.html" title="GwyDataViewLayer">
<link rel="next" href="GwyVectorLayer.html" title="GwyVectorLayer">
<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="GwyDataViewLayer.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="GwyVectorLayer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GwyPixmapLayer.synopsis" class="shortcut">Top</a>
|
<a href="#GwyPixmapLayer.description" class="shortcut">Description</a>
|
<a href="#GwyPixmapLayer.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwyPixmapLayer.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GwyPixmapLayer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyPixmapLayer.top_of_page"></a>GwyPixmapLayer</span></h2>
<p>GwyPixmapLayer — Base class for <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a> pixmap layers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyPixmapLayer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="GwyPixmapLayer.html#GwyPixmapLayer-struct" title="struct GwyPixmapLayer">GwyPixmapLayer</a>;
struct <a class="link" href="GwyPixmapLayer.html#GwyPixmapLayerClass" title="struct GwyPixmapLayerClass">GwyPixmapLayerClass</a>;
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="GwyPixmapLayer.html#gwy-pixmap-layer-get-data-key" title="gwy_pixmap_layer_get_data_key ()">gwy_pixmap_layer_get_data_key</a> (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPixmapLayer.html#gwy-pixmap-layer-make-pixbuf" title="gwy_pixmap_layer_make_pixbuf ()">gwy_pixmap_layer_make_pixbuf</a> (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="GwyPixmapLayer.html#gwy-pixmap-layer-paint" title="gwy_pixmap_layer_paint ()">gwy_pixmap_layer_paint</a> (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyPixmapLayer.html#gwy-pixmap-layer-set-data-key" title="gwy_pixmap_layer_set_data_key ()">gwy_pixmap_layer_set_data_key</a> (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_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>);
<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="GwyPixmapLayer.html#gwy-pixmap-layer-wants-repaint" title="gwy_pixmap_layer_wants_repaint ()">gwy_pixmap_layer_wants_repaint</a> (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyPixmapLayer.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>
+----GwyPixmapLayer
+----<a class="link" href="GwyLayerBasic.html" title="GwyLayerBasic">GwyLayerBasic</a>
+----<a class="link" href="GwyLayerMask.html" title="GwyLayerMask">GwyLayerMask</a>
</pre>
</div>
<div class="refsect1">
<a name="GwyPixmapLayer.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwyPixmapLayer.html#GwyPixmapLayer--data-key" title='The "data-key" property'>data-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="GwyPixmapLayer.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> is a base class for data field displaying
<a class="link" href="GwyDataViewLayer.html" title="GwyDataViewLayer"><span class="type">GwyDataViewLayer</span></a>'s. It is a <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a> component and it is not normally
usable outside of it.
</p>
<p>
The layer takes the data field to display from its parent <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a>.
The key under which the data field is found must be set with
<a class="link" href="GwyPixmapLayer.html#gwy-pixmap-layer-set-data-key" title="gwy_pixmap_layer_set_data_key ()"><code class="function">gwy_pixmap_layer_set_data_key()</code></a>.
</p>
<p>
The other methods are only rarely needed outside <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a>
implementation.
</p>
</div>
<div class="refsect1">
<a name="GwyPixmapLayer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyPixmapLayer-struct"></a><h3>struct GwyPixmapLayer</h3>
<pre class="programlisting">struct GwyPixmapLayer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyPixmapLayerClass"></a><h3>struct GwyPixmapLayerClass</h3>
<pre class="programlisting">struct GwyPixmapLayerClass {
GwyDataViewLayerClass parent_class;
GdkPixbuf* (*paint)(GwyPixmapLayer *layer);
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixmap-layer-get-data-key"></a><h3>gwy_pixmap_layer_get_data_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_pixmap_layer_get_data_key (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);</pre>
<p>
Gets the key identifying data field this pixmap layer displays.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap_layer</code></em> :</span></p></td>
<td>A pixmap 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="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-pixmap-layer-make-pixbuf"></a><h3>gwy_pixmap_layer_make_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_pixmap_layer_make_pixbuf (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>);</pre>
<p>
Creates or resizes pixmap layer <a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> to match its data field.
</p>
<p>
This method is intended for pixmap layer implementation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap_layer</code></em> :</span></p></td>
<td>A pixmap layer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>has_alpha</code></em> :</span></p></td>
<td>Whether pixbuf should have alpha channel.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixmap-layer-paint"></a><h3>gwy_pixmap_layer_paint ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gwy_pixmap_layer_paint (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);</pre>
<p>
Returns a pixbuf with painted pixmap layer.
</p>
<p>
This method does not enforce repaint. If the layer doesn't think it needs
to repaint the pixbuf, it simply returns the current one. To enforce
update, emit "data-changed" signal on corresponding data field.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap_layer</code></em> :</span></p></td>
<td>A pixmap data view layer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The pixbuf. It should not be modified or freed. If the data field
to draw is not present in the container, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixmap-layer-set-data-key"></a><h3>gwy_pixmap_layer_set_data_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_pixmap_layer_set_data_key (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_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>);</pre>
<p>
Sets the data field to display by a pixmap layer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap_layer</code></em> :</span></p></td>
<td>A pixmap 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 display.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixmap-layer-wants-repaint"></a><h3>gwy_pixmap_layer_wants_repaint ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_pixmap_layer_wants_repaint (<em class="parameter"><code><a class="link" href="GwyPixmapLayer.html" title="GwyPixmapLayer"><span class="type">GwyPixmapLayer</span></a> *pixmap_layer</code></em>);</pre>
<p>
Checks whether a pixmap layer wants repaint.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap_layer</code></em> :</span></p></td>
<td>A pixmap 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 the layer wants repaint itself, <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>
</div>
<div class="refsect1">
<a name="GwyPixmapLayer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwyPixmapLayer--data-key"></a><h3>The <code class="literal">"data-key"</code> property</h3>
<pre class="programlisting"> "data-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 :data-key property is the container key used to identify
displayed <a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> in container.
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|