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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTextTag
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A tag that can be applied to text in a GtkTextBuffer
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 You may wish to begin by reading the <link linkend="TextWidget">text widget
  10 conceptual overview</link> which gives an overview of all the objects and data
  11 types related to the text widget and how they work together.
  12 </para>
  13
  14 <para>
  15 Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer
  16 before using them with that buffer.
  17 </para>
  18
  19 <para>
  20 gtk_text_buffer_create_tag() is the best way to create tags.
  21 See <application>gtk-demo</application> for numerous examples.
  22 </para>
  23
  24 <para>
  25 The "invisible" property was not implemented for GTK+ 2.0.
  26 It is working (with minor issues) since 2.8.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31
  32 </para>
  33
  34 <!-- ##### SECTION Stability_Level ##### -->
  35
  36
  37 <!-- ##### SECTION Image ##### -->
  38
  39
  40 <!-- ##### STRUCT GtkTextTag ##### -->
  41 <para>
  42
  43 </para>
  44
  45
  46 <!-- ##### SIGNAL GtkTextTag::event ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @texttag: the object which received the signal.
  52 @arg1:
  53 @event:
  54 @arg2:
  55 @Returns:
  56
  57 <!-- ##### ARG GtkTextTag:accumulative-margin ##### -->
  58 <para>
  59
  60 </para>
  61
  62 <!-- ##### ARG GtkTextTag:background ##### -->
  63 <para>
  64
  65 </para>
  66
  67 <!-- ##### ARG GtkTextTag:background-full-height ##### -->
  68 <para>
  69
  70 </para>
  71
  72 <!-- ##### ARG GtkTextTag:background-full-height-set ##### -->
  73 <para>
  74
  75 </para>
  76
  77 <!-- ##### ARG GtkTextTag:background-gdk ##### -->
  78 <para>
  79
  80 </para>
  81
  82 <!-- ##### ARG GtkTextTag:background-set ##### -->
  83 <para>
  84
  85 </para>
  86
  87 <!-- ##### ARG GtkTextTag:background-stipple ##### -->
  88 <para>
  89
  90 </para>
  91
  92 <!-- ##### ARG GtkTextTag:background-stipple-set ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG GtkTextTag:direction ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG GtkTextTag:editable ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkTextTag:editable-set ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkTextTag:family ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkTextTag:family-set ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkTextTag:font ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### ARG GtkTextTag:font-desc ##### -->
 128 <para>
 129
 130 </para>
 131
 132 <!-- ##### ARG GtkTextTag:foreground ##### -->
 133 <para>
 134
 135 </para>
 136
 137 <!-- ##### ARG GtkTextTag:foreground-gdk ##### -->
 138 <para>
 139
 140 </para>
 141
 142 <!-- ##### ARG GtkTextTag:foreground-set ##### -->
 143 <para>
 144
 145 </para>
 146
 147 <!-- ##### ARG GtkTextTag:foreground-stipple ##### -->
 148 <para>
 149
 150 </para>
 151
 152 <!-- ##### ARG GtkTextTag:foreground-stipple-set ##### -->
 153 <para>
 154
 155 </para>
 156
 157 <!-- ##### ARG GtkTextTag:indent ##### -->
 158 <para>
 159
 160 </para>
 161
 162 <!-- ##### ARG GtkTextTag:indent-set ##### -->
 163 <para>
 164
 165 </para>
 166
 167 <!-- ##### ARG GtkTextTag:invisible ##### -->
 168 <para>
 169
 170 </para>
 171
 172 <!-- ##### ARG GtkTextTag:invisible-set ##### -->
 173 <para>
 174
 175 </para>
 176
 177 <!-- ##### ARG GtkTextTag:justification ##### -->
 178 <para>
 179
 180 </para>
 181
 182 <!-- ##### ARG GtkTextTag:justification-set ##### -->
 183 <para>
 184
 185 </para>
 186
 187 <!-- ##### ARG GtkTextTag:language ##### -->
 188 <para>
 189
 190 </para>
 191
 192 <!-- ##### ARG GtkTextTag:language-set ##### -->
 193 <para>
 194
 195 </para>
 196
 197 <!-- ##### ARG GtkTextTag:left-margin ##### -->
 198 <para>
 199
 200 </para>
 201
 202 <!-- ##### ARG GtkTextTag:left-margin-set ##### -->
 203 <para>
 204
 205 </para>
 206
 207 <!-- ##### ARG GtkTextTag:name ##### -->
 208 <para>
 209
 210 </para>
 211
 212 <!-- ##### ARG GtkTextTag:paragraph-background ##### -->
 213 <para>
 214
 215 </para>
 216
 217 <!-- ##### ARG GtkTextTag:paragraph-background-gdk ##### -->
 218 <para>
 219
 220 </para>
 221
 222 <!-- ##### ARG GtkTextTag:paragraph-background-set ##### -->
 223 <para>
 224
 225 </para>
 226
 227 <!-- ##### ARG GtkTextTag:pixels-above-lines ##### -->
 228 <para>
 229
 230 </para>
 231
 232 <!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### -->
 233 <para>
 234
 235 </para>
 236
 237 <!-- ##### ARG GtkTextTag:pixels-below-lines ##### -->
 238 <para>
 239
 240 </para>
 241
 242 <!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### -->
 243 <para>
 244
 245 </para>
 246
 247 <!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### -->
 248 <para>
 249
 250 </para>
 251
 252 <!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### -->
 253 <para>
 254
 255 </para>
 256
 257 <!-- ##### ARG GtkTextTag:right-margin ##### -->
 258 <para>
 259
 260 </para>
 261
 262 <!-- ##### ARG GtkTextTag:right-margin-set ##### -->
 263 <para>
 264
 265 </para>
 266
 267 <!-- ##### ARG GtkTextTag:rise ##### -->
 268 <para>
 269
 270 </para>
 271
 272 <!-- ##### ARG GtkTextTag:rise-set ##### -->
 273 <para>
 274
 275 </para>
 276
 277 <!-- ##### ARG GtkTextTag:scale ##### -->
 278 <para>
 279
 280 </para>
 281
 282 <!-- ##### ARG GtkTextTag:scale-set ##### -->
 283 <para>
 284
 285 </para>
 286
 287 <!-- ##### ARG GtkTextTag:size ##### -->
 288 <para>
 289
 290 </para>
 291
 292 <!-- ##### ARG GtkTextTag:size-points ##### -->
 293 <para>
 294
 295 </para>
 296
 297 <!-- ##### ARG GtkTextTag:size-set ##### -->
 298 <para>
 299
 300 </para>
 301
 302 <!-- ##### ARG GtkTextTag:stretch ##### -->
 303 <para>
 304
 305 </para>
 306
 307 <!-- ##### ARG GtkTextTag:stretch-set ##### -->
 308 <para>
 309
 310 </para>
 311
 312 <!-- ##### ARG GtkTextTag:strikethrough ##### -->
 313 <para>
 314
 315 </para>
 316
 317 <!-- ##### ARG GtkTextTag:strikethrough-set ##### -->
 318 <para>
 319
 320 </para>
 321
 322 <!-- ##### ARG GtkTextTag:style ##### -->
 323 <para>
 324
 325 </para>
 326
 327 <!-- ##### ARG GtkTextTag:style-set ##### -->
 328 <para>
 329
 330 </para>
 331
 332 <!-- ##### ARG GtkTextTag:tabs ##### -->
 333 <para>
 334
 335 </para>
 336
 337 <!-- ##### ARG GtkTextTag:tabs-set ##### -->
 338 <para>
 339
 340 </para>
 341
 342 <!-- ##### ARG GtkTextTag:underline ##### -->
 343 <para>
 344
 345 </para>
 346
 347 <!-- ##### ARG GtkTextTag:underline-set ##### -->
 348 <para>
 349
 350 </para>
 351
 352 <!-- ##### ARG GtkTextTag:variant ##### -->
 353 <para>
 354
 355 </para>
 356
 357 <!-- ##### ARG GtkTextTag:variant-set ##### -->
 358 <para>
 359
 360 </para>
 361
 362 <!-- ##### ARG GtkTextTag:weight ##### -->
 363 <para>
 364
 365 </para>
 366
 367 <!-- ##### ARG GtkTextTag:weight-set ##### -->
 368 <para>
 369
 370 </para>
 371
 372 <!-- ##### ARG GtkTextTag:wrap-mode ##### -->
 373 <para>
 374
 375 </para>
 376
 377 <!-- ##### ARG GtkTextTag:wrap-mode-set ##### -->
 378 <para>
 379
 380 </para>
 381
 382 <!-- ##### ENUM GtkWrapMode ##### -->
 383 <para>
 384 Describes a type of line wrapping.
 385 </para>
 386
 387 @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
 388 @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
 389                 appear (between characters, usually - if you want to
 390                 be technical, between graphemes, see
 391                 pango_get_log_attrs())
 392 @GTK_WRAP_WORD: wrap text, breaking lines in between words
 393 @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
 394                 that is not enough, also between graphemes.
 395
 396 <!-- ##### STRUCT GtkTextAttributes ##### -->
 397 <para>
 398 Using #GtkTextAttributes directly should rarely be necessary. It's
 399 primarily useful with gtk_text_iter_get_attributes(). As with most
 400 GTK+ structs, the fields in this struct should only be read, never
 401 modified directly.
 402 </para>
 403
 404 @appearance: pointer to sub-struct containing certain attributes
 405 @justification:
 406 @direction:
 407 @font:
 408 @font_scale:
 409 @left_margin:
 410 @indent:
 411 @right_margin:
 412 @pixels_above_lines:
 413 @pixels_below_lines:
 414 @pixels_inside_wrap:
 415 @tabs:
 416 @wrap_mode:
 417 @language:
 418 @invisible:
 419 @bg_full_height:
 420 @editable:
 421 @realized:
 422
 423 <!-- ##### FUNCTION gtk_text_tag_new ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @name:
 429 @Returns:
 430
 431
 432 <!-- ##### FUNCTION gtk_text_tag_get_priority ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @tag:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION gtk_text_tag_set_priority ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @tag:
 447 @priority:
 448
 449
 450 <!-- ##### FUNCTION gtk_text_tag_event ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @tag:
 456 @event_object:
 457 @event:
 458 @iter:
 459 @Returns:
 460
 461
 462 <!-- ##### STRUCT GtkTextAppearance ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @bg_color:
 468 @fg_color:
 469 @bg_stipple:
 470 @fg_stipple:
 471 @rise:
 472 @underline:
 473 @strikethrough:
 474 @draw_bg:
 475 @inside_selection:
 476 @is_text:
 477
 478 <!-- ##### FUNCTION gtk_text_attributes_new ##### -->
 479 <para>
 480
 481 </para>
 482
 483 @void:
 484 @Returns:
 485
 486
 487 <!-- ##### FUNCTION gtk_text_attributes_copy ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @src:
 493 @Returns:
 494
 495
 496 <!-- ##### FUNCTION gtk_text_attributes_copy_values ##### -->
 497 <para>
 498
 499 </para>
 500
 501 @src:
 502 @dest:
 503
 504
 505 <!-- ##### FUNCTION gtk_text_attributes_unref ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @values:
 511
 512
 513 <!-- ##### FUNCTION gtk_text_attributes_ref ##### -->
 514 <para>
 515
 516 </para>
 517
 518 @values:
 519 @Returns:
 520
 521