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

<!-- ##### SECTION Short_Description ##### -->
A widget that displays a small to medium amount of text.

<!-- ##### SECTION Long_Description ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
8 9 10 11 12
<para>
The #GtkLabel widget is usually used directly by the programmer to display
word(s) describing an adjacent widget or its use.  It is also used internally
by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
use text.
Owen Taylor's avatar
Owen Taylor committed
13 14 15
</para>

<!-- ##### SECTION See_Also ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
16 17
<para>

Owen Taylor's avatar
Owen Taylor committed
18 19 20
</para>

<!-- ##### STRUCT GtkLabel ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
21 22 23
<para>
This should not be accessed directly.  Use the accessor functions as
described below.
Owen Taylor's avatar
Owen Taylor committed
24 25 26 27
</para>


<!-- ##### FUNCTION gtk_label_new ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
28 29
<para>

Owen Taylor's avatar
Owen Taylor committed
30 31
</para>

Matthias Clasen's avatar
Matthias Clasen committed
32 33
@str: 
@Returns:
Owen Taylor's avatar
Owen Taylor committed
34 35


36
<!-- ##### FUNCTION gtk_label_set_text ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
37 38
<para>

39 40
</para>

Matthias Clasen's avatar
Matthias Clasen committed
41 42
@label: 
@str: 
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62


<!-- ##### 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
63 64 65 66 67 68 69 70 71
<!-- ##### FUNCTION gtk_label_set_markup_with_mnemonic ##### -->
<para>

</para>

@label: 
@str: 


Owen Taylor's avatar
Owen Taylor committed
72
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
73 74 75 76 77
<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
78 79 80 81 82 83 84
</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
85 86
<para>

Owen Taylor's avatar
Owen Taylor committed
87 88
</para>

Matthias Clasen's avatar
Matthias Clasen committed
89 90
@label: 
@jtype: 
Owen Taylor's avatar
Owen Taylor committed
91 92 93


<!-- ##### FUNCTION gtk_label_get ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
94 95 96 97
<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
98 99 100 101 102 103 104
</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
105 106 107 108 109 110
<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
111 112 113 114 115 116 117 118
</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
119 120
<para>

Owen Taylor's avatar
Owen Taylor committed
121 122
</para>

Matthias Clasen's avatar
Matthias Clasen committed
123 124
@label: 
@wrap: 
Owen Taylor's avatar
Owen Taylor committed
125 126


127
<!-- ##### MACRO gtk_label_set ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
128 129 130
<para>
Aliases gtk_label_set_text().  Probably used for backward compatibility with
Gtk+ 1.0.x.
Owen Taylor's avatar
Owen Taylor committed
131 132 133 134
</para>



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


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
<!-- ##### FUNCTION gtk_label_get_attributes ##### -->
<para>

</para>

@label: 
@Returns: 


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

</para>

@label: 
@Returns: 


<!-- ##### 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: 


<!-- ##### 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: 


<!-- ##### 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: 


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
<!-- ##### 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
353
<!-- ##### ARG GtkLabel:label ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
354 355
<para>
The actual label text.  Do not write to this pointer, it is not copied.
Owen Taylor's avatar
Owen Taylor committed
356 357
</para>

Tim Janik's avatar
Tim Janik committed
358 359 360 361 362 363 364 365 366 367 368 369 370
<!-- ##### ARG GtkLabel:attributes ##### -->
<para>

</para>

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

</para>

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

Owen Taylor's avatar
Owen Taylor committed
371 372 373
</para>

<!-- ##### ARG GtkLabel:justify ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
374 375
<para>
The #GtkJustification setting.  See gtk_label_set_justify() for more info.
Owen Taylor's avatar
Owen Taylor committed
376 377
</para>

Tim Janik's avatar
Tim Janik committed
378
<!-- ##### ARG GtkLabel:pattern ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
379 380 381
<para>
The pattern of underlines under the existing text.  Do not change the
pointer, it isn't copied.
Tim Janik's avatar
Tim Janik committed
382 383
</para>

384 385 386 387 388
<!-- ##### ARG GtkLabel:wrap ##### -->
<para>

</para>

Tim Janik's avatar
Tim Janik committed
389 390 391 392 393
<!-- ##### ARG GtkLabel:selectable ##### -->
<para>

</para>

394 395 396 397 398 399
<!-- ##### ARG GtkLabel:mnemonic-keyval ##### -->
<para>

</para>

<!-- ##### ARG GtkLabel:mnemonic-widget ##### -->
Tim Janik's avatar
Tim Janik committed
400 401 402 403
<para>

</para>

404 405 406 407 408 409 410 411 412 413
<!-- ##### ARG GtkLabel:cursor-position ##### -->
<para>

</para>

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

</para>