/usr/share/gtk-doc/html/libgwydgets/Gwy3DLabel.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwy3DLabel</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="Widgets3D.html" title="3D Widgets">
<link rel="prev" href="Gwy3DSetup.html" title="Gwy3DSetup">
<link rel="next" href="GeneralWidgets.html" title="General Widgets">
<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="Gwy3DSetup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Widgets3D.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="GeneralWidgets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#Gwy3DLabel.synopsis" class="shortcut">Top</a>
|
<a href="#Gwy3DLabel.description" class="shortcut">Description</a>
|
<a href="#Gwy3DLabel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#Gwy3DLabel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#Gwy3DLabel.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="Gwy3DLabel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Gwy3DLabel.top_of_page"></a>Gwy3DLabel</span></h2>
<p>Gwy3DLabel — Label on <a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="Gwy3DLabel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="Gwy3DLabel.html#Gwy3DLabel-struct" title="struct Gwy3DLabel">Gwy3DLabel</a>;
struct <a class="link" href="Gwy3DLabel.html#Gwy3DLabelClass" title="struct Gwy3DLabelClass">Gwy3DLabelClass</a>;
<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="Gwy3DLabel.html#gwy-3d-label-expand-text" title="gwy_3d_label_expand_text ()">gwy_3d_label_expand_text</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *variables</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="Gwy3DLabel.html#gwy-3d-label-get-text" title="gwy_3d_label_get_text ()">gwy_3d_label_get_text</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);
<a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="returnvalue">Gwy3DLabel</span></a> * <a class="link" href="Gwy3DLabel.html#gwy-3d-label-new" title="gwy_3d_label_new ()">gwy_3d_label_new</a> (<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> *default_text</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DLabel.html#gwy-3d-label-reset" title="gwy_3d_label_reset ()">gwy_3d_label_reset</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DLabel.html#gwy-3d-label-reset-text" title="gwy_3d_label_reset_text ()">gwy_3d_label_reset_text</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DLabel.html#gwy-3d-label-set-text" title="gwy_3d_label_set_text ()">gwy_3d_label_set_text</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</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> *text</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="Gwy3DLabel.html#gwy-3d-label-user-size" title="gwy_3d_label_user_size ()">gwy_3d_label_user_size</a> (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</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> user_size</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="Gwy3DLabel.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>
+----Gwy3DLabel
</pre>
</div>
<div class="refsect1">
<a name="Gwy3DLabel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
Gwy3DLabel implements
<a href="./../libgwyddion/libgwyddion/GwySerializable.html">GwySerializable</a>.</p>
</div>
<div class="refsect1">
<a name="Gwy3DLabel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--default-text" title='The "default-text" property'>default-text</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 / Construct Only
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--delta-x" title='The "delta-x" property'>delta-x</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--delta-y" title='The "delta-y" property'>delta-y</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--fixed-size" title='The "fixed-size" property'>fixed-size</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--rotation" title='The "rotation" property'>rotation</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--size" title='The "size" property'>size</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="Gwy3DLabel.html#Gwy3DLabel--text" title='The "text" property'>text</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="Gwy3DLabel.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="Gwy3DLabel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="Gwy3DLabel-struct"></a><h3>struct Gwy3DLabel</h3>
<pre class="programlisting">struct Gwy3DLabel;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabelClass"></a><h3>struct Gwy3DLabelClass</h3>
<pre class="programlisting">struct Gwy3DLabelClass {
GObjectClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-expand-text"></a><h3>gwy_3d_label_expand_text ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_3d_label_expand_text (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *variables</code></em>);</pre>
<p>
Substitutes variables in label text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>variables</code></em> :</span></p></td>
<td>Hash table with variable values.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated string with variables from <em class="parameter"><code>variables</code></em> substituted
with values.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-get-text"></a><h3>gwy_3d_label_get_text ()</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_3d_label_get_text (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);</pre>
<p>
Gets the text of a 3D label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The label text. The returned string is owned by label and must no
be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-new"></a><h3>gwy_3d_label_new ()</h3>
<pre class="programlisting"><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="returnvalue">Gwy3DLabel</span></a> * gwy_3d_label_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *default_text</code></em>);</pre>
<p>
Creates a new 3D view label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_text</code></em> :</span></p></td>
<td>Label default text.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created 3D label.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-reset"></a><h3>gwy_3d_label_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_label_reset (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);</pre>
<p>
Resets all 3D label properties and text to default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-reset-text"></a><h3>gwy_3d_label_reset_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_label_reset_text (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</code></em>);</pre>
<p>
Resets 3D label text to default values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-set-text"></a><h3>gwy_3d_label_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_label_set_text (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</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> *text</code></em>);</pre>
<p>
Sets the text of a 3D label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>New label text.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-label-user-size"></a><h3>gwy_3d_label_user_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_3d_label_user_size (<em class="parameter"><code><a class="link" href="Gwy3DLabel.html" title="Gwy3DLabel"><span class="type">Gwy3DLabel</span></a> *label</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> user_size</code></em>);</pre>
<p>
Eventually sets size of a 3D label.
</p>
<p>
If label size si fixed, it does not change and it is simply returned.
Otherwise label size is changed and <em class="parameter"><code>user_size</code></em> itself is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A 3D label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_size</code></em> :</span></p></td>
<td>Size of the text to be set.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Size of label.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="Gwy3DLabel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="Gwy3DLabel--default-text"></a><h3>The <code class="literal">"default-text"</code> property</h3>
<pre class="programlisting"> "default-text" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
<p>Default label text.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--delta-x"></a><h3>The <code class="literal">"delta-x"</code> property</h3>
<pre class="programlisting"> "delta-x" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
The :delta-x property represents horizontal label offset in pixels
(in screen coordinates after mapping from 3D to 2D).
</p>
<p>Allowed values: [-1000,1000]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--delta-y"></a><h3>The <code class="literal">"delta-y"</code> property</h3>
<pre class="programlisting"> "delta-y" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
The :delta-y property represents vertical label offset in pixels
(in screen coordinates after mapping from 3D to 2D).
</p>
<p>Allowed values: [-1000,1000]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--fixed-size"></a><h3>The <code class="literal">"fixed-size"</code> property</h3>
<pre class="programlisting"> "fixed-size" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
The :fixed-size property controls whether the :size property is kept and
honoured, or conversely ignored and overwritten with automatic size.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--rotation"></a><h3>The <code class="literal">"rotation"</code> property</h3>
<pre class="programlisting"> "rotation" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
The :rotation property represents label rotation in radians,
counterclokwise (on screen, after mapping from 3D to 2D).
</p>
<p>Allowed values: [-3.14159,3.14159]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--size"></a><h3>The <code class="literal">"size"</code> property</h3>
<pre class="programlisting"> "size" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
The :size property represents label size in pixels. When :fixed_size
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, its value is overwritten with automatic size.
</p>
<p>Allowed values: [1,100]</p>
<p>Default value: 14</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DLabel--text"></a><h3>The <code class="literal">"text"</code> property</h3>
<pre class="programlisting"> "text" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>The label text template.</p>
<p>Default value: ""</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|