summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtktexttag.sgml
blob: a138f63333036c0494f507f249186daaadd32be1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
86
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
115
116
117
118
119
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
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
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
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
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
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
<!-- ##### SECTION Title ##### -->
GtkTextTag

<!-- ##### SECTION Short_Description ##### -->

A tag that can be applied to text in a <link linkend="GtkTextBuffer">GtkTextBuffer</link>

<!-- ##### SECTION Long_Description ##### -->
<para>
You may wish to begin by reading the <link linkend="TextWidget">text widget
conceptual overview</link> which gives an overview of all the objects and data
types related to the text widget and how they work together.
</para>

<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT GtkTextTag ##### -->
<para>

</para>

@parent_instance: 
@table: 
@name: 
@priority: 
@values: 
@bg_color_set: 
@bg_stipple_set: 
@fg_color_set: 
@family_set: 
@style_set: 
@variant_set: 
@weight_set: 
@stretch_set: 
@size_set: 
@fg_stipple_set: 
@justification_set: 
@left_margin_set: 
@indent_set: 
@rise_set: 
@strikethrough_set: 
@right_margin_set: 
@pixels_above_lines_set: 
@pixels_below_lines_set: 
@pixels_inside_wrap_set: 
@tabs_set: 
@underline_set: 
@wrap_mode_set: 
@bg_full_height_set: 
@invisible_set: 
@editable_set: 
@language_set: 
@pad1: 
@pad2: 
@pad3: 

<!-- ##### STRUCT GtkTextBTreeNode ##### -->
<para>

</para>


<!-- ##### STRUCT GtkTextTagTable ##### -->
<para>

</para>

@parent_instance: 
@hash: 
@anonymous: 
@anon_count: 

<!-- ##### ENUM GtkWrapMode ##### -->
<para>
Describes a type of line wrapping.
</para>

@GTK_WRAP_NONE: 
@GTK_WRAP_CHAR: 
@GTK_WRAP_WORD: 

<!-- ##### STRUCT GtkTextAttributes ##### -->
<para>

</para>

@refcount: 
@appearance: 
@justification: 
@direction: 
@font: 
@left_margin: 
@indent: 
@right_margin: 
@pixels_above_lines: 
@pixels_below_lines: 
@pixels_inside_wrap: 
@tabs: 
@wrap_mode: 
@language: 
@invisible: 
@bg_full_height: 
@editable: 
@realized: 
@pad1: 
@pad2: 
@pad3: 
@pad4: 

<!-- ##### FUNCTION gtk_text_tag_new ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gtk_text_tag_get_priority ##### -->
<para>

</para>

@tag: 
@Returns: 


<!-- ##### FUNCTION gtk_text_tag_set_priority ##### -->
<para>

</para>

@tag: 
@priority: 


<!-- ##### FUNCTION gtk_text_tag_event ##### -->
<para>

</para>

@tag: 
@event_object: 
@event: 
@iter: 
@Returns: 


<!-- ##### STRUCT GtkTextAppearance ##### -->
<para>

</para>

@bg_color: 
@fg_color: 
@bg_stipple: 
@fg_stipple: 
@rise: 
@underline: 
@strikethrough: 
@draw_bg: 
@inside_selection: 
@is_text: 

<!-- ##### FUNCTION gtk_text_attributes_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_text_attributes_copy ##### -->
<para>

</para>

@src: 
@Returns: 
<!-- # Unused Parameters # -->
@dest: 


<!-- ##### FUNCTION gtk_text_attributes_copy_values ##### -->
<para>

</para>

@src: 
@dest: 


<!-- ##### FUNCTION gtk_text_attributes_unref ##### -->
<para>

</para>

@values: 


<!-- ##### FUNCTION gtk_text_attributes_ref ##### -->
<para>

</para>

@values: 


<!-- ##### SIGNAL GtkTextTag::event ##### -->
<para>

</para>

@texttag: the object which received the signal.
@arg1: 
@event: 
@arg2: 
@Returns: 

<!-- ##### ARG GtkTextTag:name ##### -->
<para>
Name of the tag, or NULL for anonymous tags. Can only be set
when the tag is created.
</para>

<!-- ##### ARG GtkTextTag:background ##### -->
<para>
Background color, as a string such as "red" or "#FFFFFF"
</para>

<!-- ##### ARG GtkTextTag:background-gdk ##### -->
<para>
Background color, as a #GdkColor.
</para>

<!-- ##### ARG GtkTextTag:background-full-height ##### -->
<para>
Whether to make the background color for each character the height of
the highest font used on the current line, or the height of the font 
used for the current character.
</para>

<!-- ##### ARG GtkTextTag:background-stipple ##### -->
<para>
A #GdkBitmap to use for stippling the background color.
</para>

<!-- ##### ARG GtkTextTag:foreground ##### -->
<para>
Foreground color as a string such as "red" or "#FFFFFF".
</para>

<!-- ##### ARG GtkTextTag:foreground-gdk ##### -->
<para>
Foreground color as a #GdkColor.
</para>

<!-- ##### ARG GtkTextTag:foreground-stipple ##### -->
<para>
A #GdkBitmap to use as a stipple pattern for the foreground.
</para>

<!-- ##### ARG GtkTextTag:direction ##### -->
<para>
The #GtkTextDirection for the tagged text.
</para>

<!-- ##### ARG GtkTextTag:editable ##### -->
<para>
Whether the user can modify the tagged text.
</para>

<!-- ##### ARG GtkTextTag:font ##### -->
<para>
Font as a Pango font name, e.g. "Sans Italic 12"
</para>

<!-- ##### ARG GtkTextTag:font-desc ##### -->
<para>
Font as a #PangoFontDescription.
</para>

<!-- ##### ARG GtkTextTag:family ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:style ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:variant ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:weight ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:stretch ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:size ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:size-points ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:justification ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:language ##### -->
<para>
The language this text is in, as an ISO code. Pango can use this as a
hint when rendering the text. If you don't understand this argument, 
you probably don't need it.
</para>

<!-- ##### ARG GtkTextTag:left-margin ##### -->
<para>
Pixel width of left margin of the text.
</para>

<!-- ##### ARG GtkTextTag:right-margin ##### -->
<para>
Pixel width of right margin.
</para>

<!-- ##### ARG GtkTextTag:indent ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:rise ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:pixels-above-lines ##### -->
<para>
Pixels of blank space to leave above each newline-terminated line.
</para>

<!-- ##### ARG GtkTextTag:pixels-below-lines ##### -->
<para>
Pixels of blank space to leave below each newline-terminated line.
</para>

<!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### -->
<para>
Pixels of blank space to leave between wrapped lines inside the same
newline-terminated line (paragraph).
</para>

<!-- ##### ARG GtkTextTag:strikethrough ##### -->
<para>
%TRUE to draw a line through the text.
</para>

<!-- ##### ARG GtkTextTag:underline ##### -->
<para>
A #PangoUnderline value.
</para>

<!-- ##### ARG GtkTextTag:wrap-mode ##### -->
<para>
A #GtkWrapMode value. Only used if the tag applies to the first
character in a paragraph.
</para>

<!-- ##### ARG GtkTextTag:tabs ##### -->
<para>
A #PangoTabArray indicating tabs for this text.  Only used if the tag
applies to the first character in a paragraph.
</para>

<!-- ##### ARG GtkTextTag:invisible ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:background-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:background-full-height-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:background-stipple-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:foreground-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:foreground-stipple-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:editable-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:family-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:style-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:variant-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:weight-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:stretch-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:size-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:justification-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:language-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:left-margin-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:indent-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:rise-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:strikethrough-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:right-margin-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:underline-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:wrap-mode-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:tabs-set ##### -->
<para>

</para>

<!-- ##### ARG GtkTextTag:invisible-set ##### -->
<para>

</para>