/usr/share/gtk-doc/html/st/st-st-label.html is in gnome-shell-common 3.22.3-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>st-label: St Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="St Reference Manual">
<link rel="up" href="widgets.html" title="Widgets">
<link rel="prev" href="st-st-icon.html" title="st-icon">
<link rel="next" href="containers.html" title="Containers">
<meta name="generator" content="GTK-Doc V1.25.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#st-st-label.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#st-st-label.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#st-st-label.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#st-st-label.properties" class="shortcut">Properties</a></span>
</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="widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="st-st-icon.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="containers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="st-st-label"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="st-st-label.top_of_page"></a>st-label</span></h2>
<p>st-label — Widget for displaying text</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="st-st-label.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-label.html#st-label-new" title="st_label_new ()">st_label_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="st-st-label.html#st-label-get-text" title="st_label_get_text ()">st_label_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="st-st-label.html#st-label-set-text" title="st_label_set_text ()">st_label_set_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="st-st-label.html#st-label-get-clutter-text" title="st_label_get_clutter_text ()">st_label_get_clutter_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="st-st-label.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">ClutterText</span> *</td>
<td class="property_name"><a class="link" href="st-st-label.html#StLabel--clutter-text" title="The “clutter-text” property">clutter-text</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="st-st-label.html#StLabel--text" title="The “text” property">text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="StLabel"></a><div class="refsect1">
<a name="st-st-label.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="st-st-label.html#ST-TYPE-LABEL:CAPS" title="ST_TYPE_LABEL">ST_TYPE_LABEL</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="st-st-label.html#StLabel-struct" title="struct StLabel">StLabel</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="st-st-label.html#StLabelPrivate" title="StLabelPrivate">StLabelPrivate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="st-st-label.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> ClutterActor
<span class="lineart">╰──</span> <a class="link" href="StWidget.html" title="StWidget">StWidget</a>
<span class="lineart">╰──</span> StLabel
</pre>
</div>
<div class="refsect1">
<a name="st-st-label.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
StLabel implements
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="st-st-label.description"></a><h2>Description</h2>
<p><a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> is a simple widget for displaying text. It derives from
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> to add extra style and placement functionality over
<span class="type">ClutterText</span>. The internal <span class="type">ClutterText</span> is publicly accessibly to allow
applications to set further properties.</p>
</div>
<div class="refsect1">
<a name="st-st-label.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="st-label-new"></a><h3>st_label_new ()</h3>
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *
st_label_new (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Create a new <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> with the specified label</p>
<div class="refsect3">
<a name="st-label-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>text to set the label to</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-label-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-label-get-text"></a><h3>st_label_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
st_label_get_text (<em class="parameter"><code><a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> *label</code></em>);</pre>
<p>Get the text displayed on the label</p>
<div class="refsect3">
<a name="st-label-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-label-get-text.returns"></a><h4>Returns</h4>
<p> the text for the label. This must not be freed by the application</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-label-set-text"></a><h3>st_label_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
st_label_set_text (<em class="parameter"><code><a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> *label</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Sets the text displayed on the label</p>
<div class="refsect3">
<a name="st-label-set-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>text to set the label to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-label-get-clutter-text"></a><h3>st_label_get_clutter_text ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
st_label_get_clutter_text (<em class="parameter"><code><a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> *label</code></em>);</pre>
<p>Retrieve the internal <span class="type">ClutterText</span> so that extra parameters can be set</p>
<div class="refsect3">
<a name="st-label-get-clutter-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-label-get-clutter-text.returns"></a><h4>Returns</h4>
<p> ethe <span class="type">ClutterText</span> used by <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a>. The label
is owned by the <a class="link" href="st-st-label.html#StLabel"><span class="type">StLabel</span></a> and should not be unref'ed by the application. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="st-st-label.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ST-TYPE-LABEL:CAPS"></a><h3>ST_TYPE_LABEL</h3>
<pre class="programlisting">#define ST_TYPE_LABEL (st_label_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="StLabel-struct"></a><h3>struct StLabel</h3>
<pre class="programlisting">struct StLabel;</pre>
<p>The contents of this structure is private and should only be accessed using
the provided API.</p>
</div>
<hr>
<div class="refsect2">
<a name="StLabelPrivate"></a><h3>StLabelPrivate</h3>
<pre class="programlisting">typedef struct _StLabelPrivate StLabelPrivate;</pre>
</div>
</div>
<div class="refsect1">
<a name="st-st-label.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="StLabel--clutter-text"></a><h3>The <code class="literal">“clutter-text”</code> property</h3>
<pre class="programlisting"> “clutter-text” <span class="type">ClutterText</span> *</pre>
<p>Internal ClutterText actor.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="StLabel--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting"> “text” <span class="type">gchar</span> *</pre>
<p>Text of the label.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|