gtklabel.sgml 11.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>

Havoc Pennington's avatar
Havoc Pennington committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
<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
36
  button = gtk_button_new (<!-- -->);
Havoc Pennington's avatar
Havoc Pennington committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
  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
57
  entry = gtk_entry_new (<!-- -->);
Havoc Pennington's avatar
Havoc Pennington committed
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
  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>
86 87 88 89 90
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
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
</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>

Owen Taylor's avatar
Owen Taylor committed
136
<!-- ##### SECTION See_Also ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
137 138
<para>

Owen Taylor's avatar
Owen Taylor committed
139 140
</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
141 142 143
<!-- ##### SECTION Stability_Level ##### -->


Owen Taylor's avatar
Owen Taylor committed
144
<!-- ##### STRUCT GtkLabel ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
145 146 147
<para>
This should not be accessed directly.  Use the accessor functions as
described below.
Owen Taylor's avatar
Owen Taylor committed
148 149 150
</para>


Soeren Sandmann's avatar
Soeren Sandmann committed
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
<!-- ##### 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
176 177 178 179 180
<!-- ##### ARG GtkLabel:angle ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
181 182 183 184 185 186 187 188 189 190
<!-- ##### ARG GtkLabel:attributes ##### -->
<para>

</para>

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

</para>

Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
191 192 193 194 195
<!-- ##### ARG GtkLabel:ellipsize ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
196 197 198 199 200 201 202 203 204 205
<!-- ##### ARG GtkLabel:justify ##### -->
<para>

</para>

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

</para>

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
206 207 208 209 210
<!-- ##### ARG GtkLabel:max-width-chars ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
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
<!-- ##### 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
236 237 238 239 240
<!-- ##### ARG GtkLabel:single-line-mode ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
241 242 243 244 245 246 247 248 249 250
<!-- ##### ARG GtkLabel:use-markup ##### -->
<para>

</para>

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

</para>

251 252 253 254 255
<!-- ##### ARG GtkLabel:width-chars ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
256 257 258 259 260
<!-- ##### ARG GtkLabel:wrap ##### -->
<para>

</para>

Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
261 262 263 264 265
<!-- ##### ARG GtkLabel:wrap-mode ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
266
<!-- ##### FUNCTION gtk_label_new ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
267 268
<para>

Owen Taylor's avatar
Owen Taylor committed
269 270
</para>

Matthias Clasen's avatar
Matthias Clasen committed
271
@str: 
Owen Taylor's avatar
Owen Taylor committed
272
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
273 274


275
<!-- ##### FUNCTION gtk_label_set_text ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
276 277
<para>

278 279
</para>

Matthias Clasen's avatar
Matthias Clasen committed
280 281
@label: 
@str: 
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301


<!-- ##### 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
302 303 304 305 306 307 308 309 310
<!-- ##### FUNCTION gtk_label_set_markup_with_mnemonic ##### -->
<para>

</para>

@label: 
@str: 


Owen Taylor's avatar
Owen Taylor committed
311
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
312 313 314 315 316
<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
317 318 319 320 321 322 323
</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
324 325
<para>

Owen Taylor's avatar
Owen Taylor committed
326 327
</para>

Matthias Clasen's avatar
Matthias Clasen committed
328 329
@label: 
@jtype: 
Owen Taylor's avatar
Owen Taylor committed
330 331


Matthias Clasen's avatar
2.5.1  
Matthias Clasen committed
332 333 334 335 336 337 338 339 340
<!-- ##### FUNCTION gtk_label_set_ellipsize ##### -->
<para>

</para>

@label: 
@mode: 


341 342 343 344 345 346 347 348 349
<!-- ##### FUNCTION gtk_label_set_width_chars ##### -->
<para>

</para>

@label: 
@n_chars: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
350 351 352 353 354 355 356 357 358
<!-- ##### FUNCTION gtk_label_set_max_width_chars ##### -->
<para>

</para>

@label: 
@n_chars: 


Owen Taylor's avatar
Owen Taylor committed
359
<!-- ##### FUNCTION gtk_label_get ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
360 361 362 363
<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
364 365 366 367 368 369 370
</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.


<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
371 372 373 374 375 376
<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
probably only used within the Gtk+ library itself for menu items and such.
Owen Taylor's avatar
Owen Taylor committed
377 378 379 380 381 382 383 384
</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.


<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
385 386
<para>

Owen Taylor's avatar
Owen Taylor committed
387 388
</para>

Matthias Clasen's avatar
Matthias Clasen committed
389 390
@label: 
@wrap: 
Owen Taylor's avatar
Owen Taylor committed
391 392


Matthias Clasen's avatar
2.9.4  
Matthias Clasen committed
393 394 395 396 397 398 399 400 401
<!-- ##### FUNCTION gtk_label_set_line_wrap_mode ##### -->
<para>

</para>

@label: 
@wrap_mode: 


402
<!-- ##### MACRO gtk_label_set ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
403 404 405
<para>
Aliases gtk_label_set_text().  Probably used for backward compatibility with
Gtk+ 1.0.x.
Owen Taylor's avatar
Owen Taylor committed
406 407 408 409
</para>



Havoc Pennington's avatar
Havoc Pennington committed
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
<!-- ##### 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: 


493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
<!-- ##### 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
511 512 513 514 515 516 517 518 519
<!-- ##### FUNCTION gtk_label_get_ellipsize ##### -->
<para>

</para>

@label: 
@Returns: 


520 521 522 523 524 525 526 527 528
<!-- ##### FUNCTION gtk_label_get_width_chars ##### -->
<para>

</para>

@label: 
@Returns: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
529 530 531 532 533 534 535 536 537
<!-- ##### FUNCTION gtk_label_get_max_width_chars ##### -->
<para>

</para>

@label: 
@Returns: 


538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
<!-- ##### 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
565 566 567 568 569 570 571 572 573
<!-- ##### FUNCTION gtk_label_get_line_wrap_mode ##### -->
<para>

</para>

@label: 
@Returns: 


574 575 576 577 578 579 580 581 582 583 584 585 586 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
<!-- ##### 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
612 613 614 615 616 617 618 619 620
<!-- ##### FUNCTION gtk_label_get_single_line_mode ##### -->
<para>

</para>

@label: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
621 622 623 624 625 626 627 628 629
<!-- ##### FUNCTION gtk_label_get_angle ##### -->
<para>

</para>

@label: 
@Returns: 


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
<!-- ##### 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
657 658 659 660 661 662 663 664 665
<!-- ##### FUNCTION gtk_label_set_single_line_mode ##### -->
<para>

</para>

@label: 
@single_line_mode: 


Owen Taylor's avatar
Owen Taylor committed
666 667 668 669 670 671 672 673 674
<!-- ##### FUNCTION gtk_label_set_angle ##### -->
<para>

</para>

@label: 
@angle: