/usr/share/doc/libmx-doc/html/mx/MxLabel.html is in libmx-doc 1.4.7-0ubuntu3.
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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MxLabel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mx Toolkit Reference Manual">
<link rel="up" href="ch01.html" title="Widgets">
<link rel="prev" href="MxIcon.html" title="MxIcon">
<link rel="next" href="MxMenu.html" title="MxMenu">
<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="2">
<tr valign="middle">
<td><a accesskey="p" href="MxIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Mx Toolkit Reference Manual</th>
<td><a accesskey="n" href="MxMenu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MxLabel.synopsis" class="shortcut">Top</a>
|
<a href="#MxLabel.description" class="shortcut">Description</a>
|
<a href="#MxLabel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#MxLabel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#MxLabel.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="MxLabel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MxLabel.top_of_page"></a>MxLabel</span></h2>
<p>MxLabel — Widget for displaying text</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MxLabel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="MxLabel.html#MxLabel-struct" title="struct MxLabel">MxLabel</a>;
struct <a class="link" href="MxLabel.html#MxLabelClass" title="struct MxLabelClass">MxLabelClass</a>;
<span class="returnvalue">ClutterActor</span> * <a class="link" href="MxLabel.html#mx-label-new" title="mx_label_new ()">mx_label_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="MxLabel.html#mx-label-new-with-text" title="mx_label_new_with_text ()">mx_label_new_with_text</a> (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="MxLabel.html#mx-label-get-text" title="mx_label_get_text ()">mx_label_get_text</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-text" title="mx_label_set_text ()">mx_label_set_text</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="MxLabel.html#mx-label-get-use-markup" title="mx_label_get_use_markup ()">mx_label_get_use_markup</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-use-markup" title="mx_label_set_use_markup ()">mx_label_set_use_markup</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> use_markup</code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="MxLabel.html#mx-label-get-clutter-text" title="mx_label_get_clutter_text ()">mx_label_get_clutter_text</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="returnvalue">MxAlign</span></a> <a class="link" href="MxLabel.html#mx-label-get-x-align" title="mx_label_get_x_align ()">mx_label_get_x_align</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-x-align" title="mx_label_set_x_align ()">mx_label_set_x_align</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> align</code></em>);
<a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="returnvalue">MxAlign</span></a> <a class="link" href="MxLabel.html#mx-label-get-y-align" title="mx_label_get_y_align ()">mx_label_get_y_align</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-y-align" title="mx_label_set_y_align ()">mx_label_set_y_align</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> align</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="MxLabel.html#mx-label-get-line-wrap" title="mx_label_get_line_wrap ()">mx_label_get_line_wrap</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-line-wrap" title="mx_label_set_line_wrap ()">mx_label_set_line_wrap</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxLabel.html#mx-label-set-fade-out" title="mx_label_set_fade_out ()">mx_label_set_fade_out</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> fade</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="MxLabel.html#mx-label-get-fade-out" title="mx_label_get_fade_out ()">mx_label_get_fade_out</a> (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MxLabel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----ClutterActor
+----<a class="link" href="MxWidget.html" title="MxWidget">MxWidget</a>
+----MxLabel
</pre>
</div>
<div class="refsect1">
<a name="MxLabel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MxLabel implements
ClutterContainer, ClutterScriptable, ClutterAnimatable, AtkImplementorIface and <a class="link" href="MxStylable.html" title="MxStylable">MxStylable</a>.</p>
</div>
<div class="refsect1">
<a name="MxLabel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="MxLabel.html#MxLabel--clutter-text" title='The "clutter-text" property'>clutter-text</a>" <span class="type">ClutterText</span>* : Read
"<a class="link" href="MxLabel.html#MxLabel--fade-out" title='The "fade-out" property'>fade-out</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--line-wrap" title='The "line-wrap" property'>line-wrap</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--show-tooltip" title='The "show-tooltip" property'>show-tooltip</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--text" title='The "text" property'>text</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--use-markup" title='The "use-markup" property'>use-markup</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--x-align" title='The "x-align" property'>x-align</a>" <a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> : Read / Write
"<a class="link" href="MxLabel.html#MxLabel--y-align" title='The "y-align" property'>y-align</a>" <a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="MxLabel.description"></a><h2>Description</h2>
<p>
<a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> is a simple widget for displaying one or more lines of text.
It derives from <a class="link" href="MxWidget.html" title="MxWidget"><span class="type">MxWidget</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="MxLabel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MxLabel-struct"></a><h3>struct MxLabel</h3>
<pre class="programlisting">struct MxLabel;</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="MxLabelClass"></a><h3>struct MxLabelClass</h3>
<pre class="programlisting">struct MxLabelClass {
MxWidgetClass parent_class;
/* padding for future expansion */
void (*_padding_0) (void);
void (*_padding_1) (void);
void (*_padding_2) (void);
void (*_padding_3) (void);
void (*_padding_4) (void);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-new"></a><h3>mx_label_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * mx_label_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-new-with-text"></a><h3>mx_label_new_with_text ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * mx_label_new_with_text (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>
Create a new <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> with the specified label
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>text to set the label to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-text"></a><h3>mx_label_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * mx_label_get_text (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
<p>
Get the text displayed on the label
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the text for the label. This must not be freed by the application</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-text"></a><h3>mx_label_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_text (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>text to set the label to</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-use-markup"></a><h3>mx_label_get_use_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> mx_label_get_use_markup (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
<p>
Determines whether the text of the label is being treated as Pango markup.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the text of the label is treated as Pango markup,
<code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-use-markup"></a><h3>mx_label_set_use_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_use_markup (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> use_markup</code></em>);</pre>
<p>
Sets whether the text of the label should be treated as Pango markup.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>use_markup</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> to use Pango markup, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-clutter-text"></a><h3>mx_label_get_clutter_text ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * mx_label_get_clutter_text (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">ClutterText</span> used by <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>. The label
is owned by the <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> and should not be unref'ed by the application. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-x-align"></a><h3>mx_label_get_x_align ()</h3>
<pre class="programlisting"><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="returnvalue">MxAlign</span></a> mx_label_get_x_align (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-x-align"></a><h3>mx_label_set_x_align ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_x_align (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> align</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-y-align"></a><h3>mx_label_get_y_align ()</h3>
<pre class="programlisting"><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="returnvalue">MxAlign</span></a> mx_label_get_y_align (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-y-align"></a><h3>mx_label_set_y_align ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_y_align (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> align</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-line-wrap"></a><h3>mx_label_get_line_wrap ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> mx_label_get_line_wrap (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
<p>
Get the value of the <a class="link" href="MxLabel.html#MxLabel--line-wrap" title='The "line-wrap" property'><span class="type">"line-wrap"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>An <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the "line-wrap" property is set.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-line-wrap"></a><h3>mx_label_set_line_wrap ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_line_wrap (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
<p>
Set the value of the <a class="link" href="MxLabel.html#MxLabel--line-wrap" title='The "line-wrap" property'><span class="type">"line-wrap"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>An <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>line_wrap</code></em> :</span></p></td>
<td>new value of the line-wrap property.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-set-fade-out"></a><h3>mx_label_set_fade_out ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_label_set_fade_out (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> fade</code></em>);</pre>
<p>
Set whether to fade out the end of the label, instead of ellipsizing.
Enabling this mode will also set the <span class="type">"single-line-mode"</span> and
<span class="type">"ellipsize"</span> properties.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fade</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> to fade out, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-label-get-fade-out"></a><h3>mx_label_get_fade_out ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> mx_label_get_fade_out (<em class="parameter"><code><a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a> *label</code></em>);</pre>
<p>
Determines whether the label has been set to fade out when there isn't
enough space allocated to display the entire label.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A <a class="link" href="MxLabel.html" title="MxLabel"><span class="type">MxLabel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the label is set to fade out, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
</div>
<div class="refsect1">
<a name="MxLabel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MxLabel--clutter-text"></a><h3>The <code class="literal">"clutter-text"</code> property</h3>
<pre class="programlisting"> "clutter-text" <span class="type">ClutterText</span>* : Read</pre>
<p>Internal ClutterText actor.</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--fade-out"></a><h3>The <code class="literal">"fade-out"</code> property</h3>
<pre class="programlisting"> "fade-out" <span class="type">gboolean</span> : Read / Write</pre>
<p>Fade out the end of the label, instead of ellipsizing.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--line-wrap"></a><h3>The <code class="literal">"line-wrap"</code> property</h3>
<pre class="programlisting"> "line-wrap" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether to wrap the lines of <a class="link" href="MxLabel.html#MxLabel--text" title='The "text" property'><span class="type">"text"</span></a> if the contents
exceed the available allocation.
</p>
<p>Default value: FALSE</p>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--show-tooltip"></a><h3>The <code class="literal">"show-tooltip"</code> property</h3>
<pre class="programlisting"> "show-tooltip" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Show a tooltip when there is not enough space to display the text. If set
to <code class="literal">TRUE</code>, this will also cause the <span class="type">"reactive"</span> property to be
enabled.
</p>
<p>Default value: FALSE</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--text"></a><h3>The <code class="literal">"text"</code> property</h3>
<pre class="programlisting"> "text" <span class="type">gchar</span>* : Read / Write</pre>
<p>Text of the label.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--use-markup"></a><h3>The <code class="literal">"use-markup"</code> property</h3>
<pre class="programlisting"> "use-markup" <span class="type">gboolean</span> : Read / Write</pre>
<p>Whether the text of the label should be treated as Pango markup.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--x-align"></a><h3>The <code class="literal">"x-align"</code> property</h3>
<pre class="programlisting"> "x-align" <a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> : Read / Write</pre>
<p>Horizontal position of the text layout.</p>
<p>Default value: MX_ALIGN_START</p>
</div>
<hr>
<div class="refsect2">
<a name="MxLabel--y-align"></a><h3>The <code class="literal">"y-align"</code> property</h3>
<pre class="programlisting"> "y-align" <a class="link" href="mx-mx-types.html#MxAlign" title="enum MxAlign"><span class="type">MxAlign</span></a> : Read / Write</pre>
<p>Vertical position of the text layout.</p>
<p>Default value: MX_ALIGN_START</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|