Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtklabel.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkLabel
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget that displays a small to medium amount of text.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkLabel widget is usually used directly by the programmer to display
  10 word(s) describing an adjacent widget or its use.  It is also used internally
  11 by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
  12 use text.
  13 </para>
  14
  15 <!-- ##### SECTION See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20 <!-- ##### STRUCT GtkLabel ##### -->
  21 <para>
  22 This should not be accessed directly.  Use the accessor functions as
  23 described below.
  24 </para>
  25
  26
  27 <!-- ##### FUNCTION gtk_label_new ##### -->
  28 <para>
  29
  30 </para>
  31
  32 @str:
  33 @Returns:
  34
  35
  36 <!-- ##### FUNCTION gtk_label_set_text ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @label:
  42 @str:
  43
  44
  45 <!-- ##### FUNCTION gtk_label_set_attributes ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @label:
  51 @attrs:
  52
  53
  54 <!-- ##### FUNCTION gtk_label_set_markup ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @label:
  60 @str:
  61
  62
  63 <!-- ##### FUNCTION gtk_label_set_markup_with_mnemonic ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @label:
  69 @str:
  70
  71
  72 <!-- ##### FUNCTION gtk_label_set_pattern ##### -->
  73 <para>
  74 The pattern of underlines you want under the existing text within the
  75 #GtkLabel widget.  For example if the current text of the label says
  76 &quot;FooBarBaz&quot; passing a pattern of &quot;___   ___&quot; will underline
  77 &quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
  78 </para>
  79
  80 @label: The #GtkLabel you want to set the pattern to.
  81 @pattern: The pattern as described above.
  82
  83
  84 <!-- ##### FUNCTION gtk_label_set_justify ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @label:
  90 @jtype:
  91
  92
  93 <!-- ##### FUNCTION gtk_label_get ##### -->
  94 <para>
  95 Gets the current string of text within the #GtkLabel and writes it to
  96 the given @str argument.  It does not make a copy of this string so you
  97 must not write to it.
  98 </para>
  99
 100 @label: The #GtkLabel widget you want to get the text from.
 101 @str: The reference to the pointer you want to point to the text.
 102
 103
 104 <!-- ##### FUNCTION gtk_label_parse_uline ##### -->
 105 <para>
 106 Parses the given string for underscores and converts the next
 107 character to an underlined character.  The last character that
 108 was underlined will have its lower-cased accelerator keyval returned  (i.e.
 109 &quot;_File&quot; would return the keyval for &quot;f&quot;.  This is
 110 probably only used within the Gtk+ library itself for menu items and such.
 111 </para>
 112
 113 @label: The #GtkLabel you want to affect.
 114 @string: The string you want to parse for underlines.
 115 @Returns: The lowercase keyval of the last character underlined.
 116
 117
 118 <!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @label:
 124 @wrap:
 125
 126
 127 <!-- ##### MACRO gtk_label_set ##### -->
 128 <para>
 129 Aliases gtk_label_set_text().  Probably used for backward compatibility with
 130 Gtk+ 1.0.x.
 131 </para>
 132
 133
 134
 135 <!-- ##### FUNCTION gtk_label_get_layout_offsets ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @label:
 141 @x:
 142 @y:
 143
 144
 145 <!-- ##### FUNCTION gtk_label_get_mnemonic_keyval ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @label:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION gtk_label_get_selectable ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @label:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gtk_label_get_text ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @label:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION gtk_label_new_with_mnemonic ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @str:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gtk_label_select_region ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @label:
 187 @start_offset:
 188 @end_offset:
 189
 190
 191 <!-- ##### FUNCTION gtk_label_set_mnemonic_widget ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @label:
 197 @widget:
 198
 199
 200 <!-- ##### FUNCTION gtk_label_set_selectable ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @label:
 206 @setting:
 207
 208
 209 <!-- ##### FUNCTION gtk_label_set_text_with_mnemonic ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @label:
 215 @str:
 216
 217
 218 <!-- ##### FUNCTION gtk_label_get_attributes ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @label:
 224 @Returns:
 225
 226
 227 <!-- ##### FUNCTION gtk_label_get_justify ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @label:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION gtk_label_get_label ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @label:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION gtk_label_get_layout ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @label:
 251 @Returns:
 252
 253
 254 <!-- ##### FUNCTION gtk_label_get_line_wrap ##### -->
 255 <para>
 256
 257 </para>
 258
 259 @label:
 260 @Returns:
 261
 262
 263 <!-- ##### FUNCTION gtk_label_get_mnemonic_widget ##### -->
 264 <para>
 265
 266 </para>
 267
 268 @label:
 269 @Returns:
 270
 271
 272 <!-- ##### FUNCTION gtk_label_get_selection_bounds ##### -->
 273 <para>
 274
 275 </para>
 276
 277 @label:
 278 @start:
 279 @end:
 280 @Returns:
 281
 282
 283 <!-- ##### FUNCTION gtk_label_get_use_markup ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @label:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gtk_label_get_use_underline ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @label:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION gtk_label_set_label ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @label:
 307 @str:
 308
 309
 310 <!-- ##### FUNCTION gtk_label_set_use_markup ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @label:
 316 @setting:
 317
 318
 319 <!-- ##### FUNCTION gtk_label_set_use_underline ##### -->
 320 <para>
 321
 322 </para>
 323
 324 @label:
 325 @setting:
 326
 327
 328 <!-- ##### SIGNAL GtkLabel::copy-clipboard ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @label: the object which received the signal.
 334
 335 <!-- ##### SIGNAL GtkLabel::move-cursor ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @label: the object which received the signal.
 341 @arg1:
 342 @arg2:
 343 @arg3:
 344
 345 <!-- ##### SIGNAL GtkLabel::populate-popup ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @label: the object which received the signal.
 351 @arg1:
 352
 353 <!-- ##### ARG GtkLabel:label ##### -->
 354 <para>
 355 The actual label text.  Do not write to this pointer, it is not copied.
 356 </para>
 357
 358 <!-- ##### ARG GtkLabel:attributes ##### -->
 359 <para>
 360
 361 </para>
 362
 363 <!-- ##### ARG GtkLabel:use-markup ##### -->
 364 <para>
 365
 366 </para>
 367
 368 <!-- ##### ARG GtkLabel:use-underline ##### -->
 369 <para>
 370
 371 </para>
 372
 373 <!-- ##### ARG GtkLabel:justify ##### -->
 374 <para>
 375 The #GtkJustification setting.  See gtk_label_set_justify() for more info.
 376 </para>
 377
 378 <!-- ##### ARG GtkLabel:pattern ##### -->
 379 <para>
 380 The pattern of underlines under the existing text.  Do not change the
 381 pointer, it isn't copied.
 382 </para>
 383
 384 <!-- ##### ARG GtkLabel:wrap ##### -->
 385 <para>
 386
 387 </para>
 388
 389 <!-- ##### ARG GtkLabel:selectable ##### -->
 390 <para>
 391
 392 </para>
 393
 394 <!-- ##### ARG GtkLabel:mnemonic-keyval ##### -->
 395 <para>
 396
 397 </para>
 398
 399 <!-- ##### ARG GtkLabel:mnemonic-widget ##### -->
 400 <para>
 401
 402 </para>
 403
 404 <!-- ##### ARG GtkLabel:cursor-position ##### -->
 405 <para>
 406
 407 </para>
 408
 409 <!-- ##### ARG GtkLabel:selection-bound ##### -->
 410 <para>
 411
 412 </para>
 413