gtklabel.sgml 13.2 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkLabel

<!-- ##### SECTION Short_Description ##### -->
5
A widget that displays a small to medium amount of text
Owen Taylor's avatar
Owen Taylor committed
6 7

<!-- ##### SECTION Long_Description ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
8
<para>
Havoc Pennington's avatar
Havoc Pennington committed
9 10 11
The #GtkLabel widget displays a small amount of text. As the name
implies, most labels are used to label another widget such as a
#GtkButton, a #GtkMenuItem, or a #GtkOptionMenu.
Owen Taylor's avatar
Owen Taylor committed
12 13
</para>

14 15 16 17 18 19
<refsect2 id="GtkLabel-BUILDER-UI">
<title>GtkLabel as GtkBuildable</title>
<para>
The GtkLabel implementation of the GtkBuildable interface supports a 
custom &lt;attributes&gt; element, which supports any number of &lt;attribute&gt;
elements. the &lt;attribute&gt; element has attributes named name, value,
Matthias Clasen's avatar
Matthias Clasen committed
20
start and end and allows you to specify #PangoAttribute values for this label.
21 22
</para>
<example>
Matthias Clasen's avatar
Matthias Clasen committed
23
<title>A UI definition fragment specifying Pango attributes</title>
24 25 26
<programlisting><![CDATA[
<object class="GtkLabel">
  <attributes>
Matthias Clasen's avatar
Matthias Clasen committed
27 28
    <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
    <attribute name="background" value="red" start="5" end="10"/>"
29 30 31 32
  </attributes>
</object>
]]></programlisting>
</example>
Matthias Clasen's avatar
Matthias Clasen committed
33 34 35 36 37 38
<para>
The start and end attributes specify the range of characters to which the
Pango attribute applies. If start and end are not specified, the attribute is
applied to the whole text. Note that specifying ranges does not make much
sense with translatable attributes. Use markup embedded in the translatable
content instead.
Matthias Clasen's avatar
Matthias Clasen committed
39
</para>
40 41 42
</refsect2>


Havoc Pennington's avatar
Havoc Pennington committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
<refsect2>
<title>Mnemonics</title>

<para>
Labels may contain <firstterm>mnemonics</firstterm>. Mnemonics are
underlined characters in the label, used for keyboard navigation.
Mnemonics are created by providing a string with an underscore before
the mnemonic character, such as <literal>"_File"</literal>, to the
functions gtk_label_new_with_mnemonic() or
gtk_label_set_text_with_mnemonic().
</para>

<para>
Mnemonics automatically activate any activatable widget the label is
inside, such as a #GtkButton; if the label is not inside the
mnemonic's target widget, you have to tell the label about the target
using gtk_label_set_mnemonic_widget(). Here's a simple example where
the label is inside a button:

<informalexample>
<programlisting>
  /* Pressing Alt+H will activate this button */
Matthias Clasen's avatar
Matthias Clasen committed
65
  button = gtk_button_new (<!-- -->);
Havoc Pennington's avatar
Havoc Pennington committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
  label = gtk_label_new_with_mnemonic ("_Hello");
  gtk_container_add (GTK_CONTAINER (button), label);
</programlisting>
</informalexample>
There's a convenience function to create buttons with a mnemonic label 
already inside:

<informalexample>
<programlisting>
  /* Pressing Alt+H will activate this button */
  button = gtk_button_new_with_mnemonic ("_Hello");
</programlisting>
</informalexample>

To create a mnemonic for a widget alongside the label, such as a 
#GtkEntry, you have to point the label at the entry with 
gtk_label_set_mnemonic_widget():
<informalexample>
<programlisting>
  /* Pressing Alt+H will focus the entry */
Matthias Clasen's avatar
Matthias Clasen committed
86
  entry = gtk_entry_new (<!-- -->);
Havoc Pennington's avatar
Havoc Pennington committed
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
  label = gtk_label_new_with_mnemonic ("_Hello");
  gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);
</programlisting>
</informalexample>

</para>

</refsect2>

<refsect2>
<title>Markup (styled text)</title>

<para>
To make it easy to format text in a label (changing colors, fonts,
etc.), label text can be provided in a simple <link
linkend="PangoMarkupFormat">markup format</link>.
Here's how to create a label with a small font:
<informalexample>
<programlisting>
  label = gtk_label_new (NULL);
  gtk_label_set_markup (GTK_LABEL (label), "&lt;small&gt;Small text&lt;/small&gt;");
</programlisting>
</informalexample>
(See <link
linkend="PangoMarkupFormat">complete documentation</link> of available
tags in the Pango manual.)
</para>
<para>
115 116 117 118 119
The markup passed to gtk_label_set_markup() must be valid; for example,
literal &lt;/&gt;/&amp; characters must be escaped as &amp;lt;,
&amp;gt;, and &amp;amp;. If you pass text obtained from the user, file,
or a network to gtk_label_set_markup(), you'll want to escape it with
g_markup_escape_text() or g_markup_printf_escaped().
Havoc Pennington's avatar
Havoc Pennington committed
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
</para>
<para>
Markup strings are just a convenient way to set the #PangoAttrList on
a label; gtk_label_set_attributes() may be a simpler way to set
attributes in some cases. Be careful though; #PangoAttrList tends to
cause internationalization problems, unless you're applying attributes
to the entire string (i.e. unless you set the range of each attribute
to [0, G_MAXINT)). The reason is that specifying the start_index and
end_index for a #PangoAttribute requires knowledge of the exact string
being displayed, so translations will cause problems.
</para>
</refsect2>

<refsect2>
<title>Selectable labels</title>

<para>
Labels can be made selectable with gtk_label_set_selectable(). 
Selectable labels allow the user to copy the label contents to 
the clipboard. Only labels that contain useful-to-copy information
&mdash; such as error messages &mdash; should be made selectable.
</para>
</refsect2>

<refsect2>
<title>Text layout</title>

<para>
A label can contain any number of paragraphs, but will have
performance problems if it contains more than a small number.
Paragraphs are separated by newlines or other paragraph separators
understood by Pango.
</para>
<para>
Labels can automatically wrap text if you call
gtk_label_set_line_wrap().
</para>
<para>
gtk_label_set_justify() sets how the lines in a label align 
with one another. If you want to set how the label as a whole 
aligns in its available space, see gtk_misc_set_alignment().
</para>

</refsect2>
Matthias Clasen's avatar
Matthias Clasen committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

<refsect2>
<title>Links</title>

<para>
Since 2.18, GTK+ supports markup for clickable hyperlinks in addition
to regular Pango markup. The markup for links is borrowed from HTML, using the
<tag>a</tag> with href and title attributes. GTK+ renders links similar to the
way they appear in web browsers, with colored, underlined text. The title
attribute is displayed as a tooltip on the link. An example looks like this:
<informalexample><programlisting>
gtk_label_set_markup (label, "Go to the &lt;a href=\"http://www.gtk.org\" title=\"&amp;lt;i&amp;gt;Our&amp;/i&amp;gt; website\"&gt;GTK+ website</a> for more...");
</programlisting></informalexample>
It is possible to implement custom handling for links with the
#GtkLabel::activate-link signal and the gtk_label_get_current_uri() function.
</para>

</refsect2>
Havoc Pennington's avatar
Havoc Pennington committed
182

Owen Taylor's avatar
Owen Taylor committed
183
<!-- ##### SECTION See_Also ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
184 185
<para>

Owen Taylor's avatar
Owen Taylor committed
186 187
</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
188 189 190
<!-- ##### SECTION Stability_Level ##### -->


Owen Taylor's avatar
Owen Taylor committed
191
<!-- ##### STRUCT GtkLabel ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
192 193 194
<para>
This should not be accessed directly.  Use the accessor functions as
described below.
Owen Taylor's avatar
Owen Taylor committed
195 196 197
</para>


Soeren Sandmann's avatar
Soeren Sandmann committed
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
<!-- ##### SIGNAL GtkLabel::copy-clipboard ##### -->
<para>

</para>

@label: the object which received the signal.

<!-- ##### SIGNAL GtkLabel::move-cursor ##### -->
<para>

</para>

@label: the object which received the signal.
@arg1: 
@arg2: 
@arg3: 

<!-- ##### SIGNAL GtkLabel::populate-popup ##### -->
<para>

</para>

@label: the object which received the signal.
@arg1: 

Owen Taylor's avatar
Owen Taylor committed
223 224 225 226 227
<!-- ##### ARG GtkLabel:angle ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
228 229 230 231 232 233 234 235 236 237
<!-- ##### ARG GtkLabel:attributes ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:cursor-position ##### -->
<para>

</para>

Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
238 239 240 241 242
<!-- ##### ARG GtkLabel:ellipsize ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
243 244 245 246 247 248 249 250 251 252
<!-- ##### ARG GtkLabel:justify ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:label ##### -->
<para>

</para>

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
253 254 255 256 257
<!-- ##### ARG GtkLabel:max-width-chars ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
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
<!-- ##### ARG GtkLabel:mnemonic-keyval ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:mnemonic-widget ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:pattern ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:selectable ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:selection-bound ##### -->
<para>

</para>

Matthias Clasen's avatar
2.5.5  
Matthias Clasen committed
283 284 285 286 287
<!-- ##### ARG GtkLabel:single-line-mode ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
288 289 290 291 292 293 294 295 296 297
<!-- ##### ARG GtkLabel:use-markup ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:use-underline ##### -->
<para>

</para>

298 299 300 301 302
<!-- ##### ARG GtkLabel:width-chars ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
303 304 305 306 307
<!-- ##### ARG GtkLabel:wrap ##### -->
<para>

</para>

Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
308 309 310 311 312
<!-- ##### ARG GtkLabel:wrap-mode ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
313
<!-- ##### FUNCTION gtk_label_new ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
314 315
<para>

Owen Taylor's avatar
Owen Taylor committed
316 317
</para>

Matthias Clasen's avatar
Matthias Clasen committed
318
@str: 
Owen Taylor's avatar
Owen Taylor committed
319
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
320 321


322
<!-- ##### FUNCTION gtk_label_set_text ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
323 324
<para>

325 326
</para>

Matthias Clasen's avatar
Matthias Clasen committed
327 328
@label: 
@str: 
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348


<!-- ##### FUNCTION gtk_label_set_attributes ##### -->
<para>

</para>

@label: 
@attrs: 


<!-- ##### FUNCTION gtk_label_set_markup ##### -->
<para>

</para>

@label: 
@str: 


Havoc Pennington's avatar
Havoc Pennington committed
349 350 351 352 353 354 355 356 357
<!-- ##### FUNCTION gtk_label_set_markup_with_mnemonic ##### -->
<para>

</para>

@label: 
@str: 


Owen Taylor's avatar
Owen Taylor committed
358
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
359 360 361 362 363
<para>
The pattern of underlines you want under the existing text within the
#GtkLabel widget.  For example if the current text of the label says
&quot;FooBarBaz&quot; passing a pattern of &quot;___   ___&quot; will underline
&quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
Owen Taylor's avatar
Owen Taylor committed
364 365 366 367 368 369 370
</para>

@label: The #GtkLabel you want to set the pattern to.
@pattern: The pattern as described above.


<!-- ##### FUNCTION gtk_label_set_justify ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
371 372
<para>

Owen Taylor's avatar
Owen Taylor committed
373 374
</para>

Matthias Clasen's avatar
Matthias Clasen committed
375 376
@label: 
@jtype: 
Owen Taylor's avatar
Owen Taylor committed
377 378


Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
379 380 381 382 383 384 385 386 387
<!-- ##### FUNCTION gtk_label_set_ellipsize ##### -->
<para>

</para>

@label: 
@mode: 


388 389 390 391 392 393 394 395 396
<!-- ##### FUNCTION gtk_label_set_width_chars ##### -->
<para>

</para>

@label: 
@n_chars: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
397 398 399 400 401 402 403 404 405
<!-- ##### FUNCTION gtk_label_set_max_width_chars ##### -->
<para>

</para>

@label: 
@n_chars: 


Owen Taylor's avatar
Owen Taylor committed
406
<!-- ##### FUNCTION gtk_label_get ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
407 408 409 410
<para>
Gets the current string of text within the #GtkLabel and writes it to
the given @str argument.  It does not make a copy of this string so you
must not write to it.
Owen Taylor's avatar
Owen Taylor committed
411 412 413 414
</para>

@label: The #GtkLabel widget you want to get the text from.
@str: The reference to the pointer you want to point to the text.
415
@Deprecated: Use gtk_label_get_text() instead.
Owen Taylor's avatar
Owen Taylor committed
416 417 418


<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
419 420 421 422 423
<para>
Parses the given string for underscores and converts the next
character to an underlined character.  The last character that
was underlined will have its lower-cased accelerator keyval returned  (i.e.
&quot;_File&quot; would return the keyval for &quot;f&quot;.  This is
424
probably only used within the GTK+ library itself for menu items and such.
Owen Taylor's avatar
Owen Taylor committed
425 426 427 428 429
</para>

@label: The #GtkLabel you want to affect.
@string: The string you want to parse for underlines.
@Returns: The lowercase keyval of the last character underlined.
430
@Deprecated: Use gtk_label_set_use_underline() instead.
Owen Taylor's avatar
Owen Taylor committed
431

Matthias Clasen's avatar
2.15.0  
Matthias Clasen committed
432

Owen Taylor's avatar
Owen Taylor committed
433
<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
434 435
<para>

Owen Taylor's avatar
Owen Taylor committed
436 437
</para>

Matthias Clasen's avatar
Matthias Clasen committed
438 439
@label: 
@wrap: 
Owen Taylor's avatar
Owen Taylor committed
440 441


Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
442 443 444 445 446 447 448 449 450
<!-- ##### FUNCTION gtk_label_set_line_wrap_mode ##### -->
<para>

</para>

@label: 
@wrap_mode: 


451
<!-- ##### MACRO gtk_label_set ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
452
<para>
453
Sets the text within the GtkLabel widget.
Owen Taylor's avatar
Owen Taylor committed
454 455
</para>

456
@Deprecated: Use gtk_label_set_text() instead.
Owen Taylor's avatar
Owen Taylor committed
457 458


Havoc Pennington's avatar
Havoc Pennington committed
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 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
<!-- ##### FUNCTION gtk_label_get_layout_offsets ##### -->
<para>

</para>

@label: 
@x: 
@y: 


<!-- ##### FUNCTION gtk_label_get_mnemonic_keyval ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_selectable ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_text ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_new_with_mnemonic ##### -->
<para>

</para>

@str: 
@Returns: 


<!-- ##### FUNCTION gtk_label_select_region ##### -->
<para>

</para>

@label: 
@start_offset: 
@end_offset: 


<!-- ##### FUNCTION gtk_label_set_mnemonic_widget ##### -->
<para>

</para>

@label: 
@widget: 


<!-- ##### FUNCTION gtk_label_set_selectable ##### -->
<para>

</para>

@label: 
@setting: 


<!-- ##### FUNCTION gtk_label_set_text_with_mnemonic ##### -->
<para>

</para>

@label: 
@str: 


542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
<!-- ##### FUNCTION gtk_label_get_attributes ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_justify ##### -->
<para>

</para>

@label: 
@Returns: 


Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
560 561 562 563 564 565 566 567 568
<!-- ##### FUNCTION gtk_label_get_ellipsize ##### -->
<para>

</para>

@label: 
@Returns: 


569 570 571 572 573 574 575 576 577
<!-- ##### FUNCTION gtk_label_get_width_chars ##### -->
<para>

</para>

@label: 
@Returns: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
578 579 580 581 582 583 584 585 586
<!-- ##### FUNCTION gtk_label_get_max_width_chars ##### -->
<para>

</para>

@label: 
@Returns: 


587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
<!-- ##### FUNCTION gtk_label_get_label ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_layout ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_line_wrap ##### -->
<para>

</para>

@label: 
@Returns: 


Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
614 615 616 617 618 619 620 621 622
<!-- ##### FUNCTION gtk_label_get_line_wrap_mode ##### -->
<para>

</para>

@label: 
@Returns: 


623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
<!-- ##### FUNCTION gtk_label_get_mnemonic_widget ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_selection_bounds ##### -->
<para>

</para>

@label: 
@start: 
@end: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_use_markup ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### FUNCTION gtk_label_get_use_underline ##### -->
<para>

</para>

@label: 
@Returns: 


Matthias Clasen's avatar
2.5.5  
Matthias Clasen committed
661 662 663 664 665 666 667 668 669
<!-- ##### FUNCTION gtk_label_get_single_line_mode ##### -->
<para>

</para>

@label: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
670 671 672 673 674 675 676 677 678
<!-- ##### FUNCTION gtk_label_get_angle ##### -->
<para>

</para>

@label: 
@Returns: 


679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
<!-- ##### FUNCTION gtk_label_set_label ##### -->
<para>

</para>

@label: 
@str: 


<!-- ##### FUNCTION gtk_label_set_use_markup ##### -->
<para>

</para>

@label: 
@setting: 


<!-- ##### FUNCTION gtk_label_set_use_underline ##### -->
<para>

</para>

@label: 
@setting: 


Matthias Clasen's avatar
2.5.5  
Matthias Clasen committed
706 707 708 709 710 711 712 713 714
<!-- ##### FUNCTION gtk_label_set_single_line_mode ##### -->
<para>

</para>

@label: 
@single_line_mode: 


Owen Taylor's avatar
Owen Taylor committed
715 716 717 718 719 720 721 722 723
<!-- ##### FUNCTION gtk_label_set_angle ##### -->
<para>

</para>

@label: 
@angle: