Gtk2::TextTag(3pm)

1Gtk2::TextTag(3)      User Contributed Perl Documentation     Gtk2::TextTag(3)
2
3
4

NAME

6       Gtk2::TextTag - wrapper for GtkTextTag
7

HIERARCHY

9         Glib::Object
10         +----Gtk2::TextTag
11

METHODS

13   texttag = Gtk2::TextTag->new ($name=undef)
14       •   $name (string or undef)
15
16   boolean = $tag->event ($event_object, $event, $iter)
17       •   $event_object (Glib::Object)
18
19       •   $event (Gtk2::Gdk::Event)
20
21       •   $iter (Gtk2::TextIter)
22
23   integer = $tag->get_priority
24   $tag->set_priority ($priority)
25       •   $priority (integer)
26

PROPERTIES

28       'accumulative-margin' (boolean : default false : readable / writable /
29       private / static-nick / static-blurb)
30           Whether left and right margins accumulate.
31
32       'background' (string : default undef : writable / private / static-nick
33       / static-blurb)
34           Background color as a string
35
36       'background-full-height' (boolean : default false : readable / writable
37       / private / static-nick / static-blurb)
38           Whether the background color fills the entire line height or only
39           the height of the tagged characters
40
41       'background-full-height-set' (boolean : default false : readable /
42       writable / private / static-nick / static-blurb)
43           Whether this tag affects background height
44
45       'background-gdk' (Gtk2::Gdk::Color : default undef : readable /
46       writable / private / static-nick / static-blurb)
47           Background color as a (possibly unallocated) GdkColor
48
49       'background-set' (boolean : default false : readable / writable /
50       private / static-nick / static-blurb)
51           Whether this tag affects the background color
52
53       'background-stipple' (Gtk2::Gdk::Pixmap : default undef : readable /
54       writable / private / static-nick / static-blurb)
55           Bitmap to use as a mask when drawing the text background
56
57       'background-stipple-set' (boolean : default false : readable / writable
58       / private / static-nick / static-blurb)
59           Whether this tag affects the background stipple
60
61       'direction' (Gtk2::TextDirection : default "none" : readable / writable
62       / private / static-nick / static-blurb)
63           Text direction, e.g. right-to-left or left-to-right
64
65       'editable' (boolean : default true : readable / writable / private /
66       static-nick / static-blurb)
67           Whether the text can be modified by the user
68
69       'editable-set' (boolean : default false : readable / writable / private
70       / static-nick / static-blurb)
71           Whether this tag affects text editability
72
73       'family' (string : default undef : readable / writable / private /
74       static-nick / static-blurb)
75           Name of the font family, e.g. Sans, Helvetica, Times, Monospace
76
77       'family-set' (boolean : default false : readable / writable / private /
78       static-nick / static-blurb)
79           Whether this tag affects the font family
80
81       'font' (string : default undef : readable / writable / private /
82       static-nick / static-blurb)
83           Font description as a string, e.g. "Sans Italic 12"
84
85       'font-desc' (Pango::FontDescription : default undef : readable /
86       writable / private / static-nick / static-blurb)
87           Font description as a PangoFontDescription struct
88
89       'foreground' (string : default undef : writable / private / static-nick
90       / static-blurb)
91           Foreground color as a string
92
93       'foreground-gdk' (Gtk2::Gdk::Color : default undef : readable /
94       writable / private / static-nick / static-blurb)
95           Foreground color as a (possibly unallocated) GdkColor
96
97       'foreground-set' (boolean : default false : readable / writable /
98       private / static-nick / static-blurb)
99           Whether this tag affects the foreground color
100
101       'foreground-stipple' (Gtk2::Gdk::Pixmap : default undef : readable /
102       writable / private / static-nick / static-blurb)
103           Bitmap to use as a mask when drawing the text foreground
104
105       'foreground-stipple-set' (boolean : default false : readable / writable
106       / private / static-nick / static-blurb)
107           Whether this tag affects the foreground stipple
108
109       'indent' (integer : default 0 : readable / writable / private / static-
110       nick / static-blurb)
111           Amount to indent the paragraph, in pixels
112
113       'indent-set' (boolean : default false : readable / writable / private /
114       static-nick / static-blurb)
115           Whether this tag affects indentation
116
117       'invisible' (boolean : default false : readable / writable / private /
118       static-nick / static-blurb)
119           Whether this text is hidden.
120
121       'invisible-set' (boolean : default false : readable / writable /
122       private / static-nick / static-blurb)
123           Whether this tag affects text visibility
124
125       'justification' (Gtk2::Justification : default "left" : readable /
126       writable / private / static-nick / static-blurb)
127           Left, right, or center justification
128
129       'justification-set' (boolean : default false : readable / writable /
130       private / static-nick / static-blurb)
131           Whether this tag affects paragraph justification
132
133       'language' (string : default undef : readable / writable / private /
134       static-nick / static-blurb)
135           The language this text is in, as an ISO code. Pango can use this as
136           a hint when rendering the text. If not set, an appropriate default
137           will be used.
138
139       'language-set' (boolean : default false : readable / writable / private
140       / static-nick / static-blurb)
141           Whether this tag affects the language the text is rendered as
142
143       'left-margin' (integer : default 0 : readable / writable / private /
144       static-nick / static-blurb)
145           Width of the left margin in pixels
146
147       'left-margin-set' (boolean : default false : readable / writable /
148       private / static-nick / static-blurb)
149           Whether this tag affects the left margin
150
151       'name' (string : default undef : readable / writable / construct-only /
152       private / static-nick / static-blurb)
153           Name used to refer to the text tag. NULL for anonymous tags
154
155       'paragraph-background' (string : default undef : writable / private /
156       static-nick / static-blurb)
157           Paragraph background color as a string
158
159       'paragraph-background-gdk' (Gtk2::Gdk::Color : default undef : readable
160       / writable / private / static-nick / static-blurb)
161           Paragraph background color as a (possibly unallocated) GdkColor
162
163       'paragraph-background-set' (boolean : default false : readable /
164       writable / private / static-nick / static-blurb)
165           Whether this tag affects the paragraph background color
166
167       'pixels-above-lines' (integer : default 0 : readable / writable /
168       private / static-nick / static-blurb)
169           Pixels of blank space above paragraphs
170
171       'pixels-above-lines-set' (boolean : default false : readable / writable
172       / private / static-nick / static-blurb)
173           Whether this tag affects the number of pixels above lines
174
175       'pixels-below-lines' (integer : default 0 : readable / writable /
176       private / static-nick / static-blurb)
177           Pixels of blank space below paragraphs
178
179       'pixels-below-lines-set' (boolean : default false : readable / writable
180       / private / static-nick / static-blurb)
181           Whether this tag affects the number of pixels above lines
182
183       'pixels-inside-wrap' (integer : default 0 : readable / writable /
184       private / static-nick / static-blurb)
185           Pixels of blank space between wrapped lines in a paragraph
186
187       'pixels-inside-wrap-set' (boolean : default false : readable / writable
188       / private / static-nick / static-blurb)
189           Whether this tag affects the number of pixels between wrapped lines
190
191       'right-margin' (integer : default 0 : readable / writable / private /
192       static-nick / static-blurb)
193           Width of the right margin in pixels
194
195       'right-margin-set' (boolean : default false : readable / writable /
196       private / static-nick / static-blurb)
197           Whether this tag affects the right margin
198
199       'rise' (integer : default 0 : readable / writable / private / static-
200       nick / static-blurb)
201           Offset of text above the baseline (below the baseline if rise is
202           negative) in Pango units
203
204       'rise-set' (boolean : default false : readable / writable / private /
205       static-nick / static-blurb)
206           Whether this tag affects the rise
207
208       'scale' (double : default 1 : readable / writable / private / static-
209       nick / static-blurb)
210           Font size as a scale factor relative to the default font size. This
211           properly adapts to theme changes etc. so is recommended. Pango
212           predefines some scales such as PANGO_SCALE_X_LARGE
213
214       'scale-set' (boolean : default false : readable / writable / private /
215       static-nick / static-blurb)
216           Whether this tag scales the font size by a factor
217
218       'size' (integer : default 0 : readable / writable / private / static-
219       nick / static-blurb)
220           Font size in Pango units
221
222       'size-points' (double : default 0 : readable / writable / private /
223       static-nick / static-blurb)
224           Font size in points
225
226       'size-set' (boolean : default false : readable / writable / private /
227       static-nick / static-blurb)
228           Whether this tag affects the font size
229
230       'stretch' (Pango::Stretch : default "normal" : readable / writable /
231       private / static-nick / static-blurb)
232           Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED
233
234       'stretch-set' (boolean : default false : readable / writable / private
235       / static-nick / static-blurb)
236           Whether this tag affects the font stretch
237
238       'strikethrough' (boolean : default false : readable / writable /
239       private / static-nick / static-blurb)
240           Whether to strike through the text
241
242       'strikethrough-set' (boolean : default false : readable / writable /
243       private / static-nick / static-blurb)
244           Whether this tag affects strikethrough
245
246       'style' (Pango::Style : default "normal" : readable / writable /
247       private / static-nick / static-blurb)
248           Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC
249
250       'style-set' (boolean : default false : readable / writable / private /
251       static-nick / static-blurb)
252           Whether this tag affects the font style
253
254       'tabs' (Pango::TabArray : default undef : readable / writable / private
255       / static-nick / static-blurb)
256           Custom tabs for this text
257
258       'tabs-set' (boolean : default false : readable / writable / private /
259       static-nick / static-blurb)
260           Whether this tag affects tabs
261
262       'underline' (Pango::Underline : default "none" : readable / writable /
263       private / static-nick / static-blurb)
264           Style of underline for this text
265
266       'underline-set' (boolean : default false : readable / writable /
267       private / static-nick / static-blurb)
268           Whether this tag affects underlining
269
270       'variant' (Pango::Variant : default "normal" : readable / writable /
271       private / static-nick / static-blurb)
272           Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS
273
274       'variant-set' (boolean : default false : readable / writable / private
275       / static-nick / static-blurb)
276           Whether this tag affects the font variant
277
278       'weight' (integer : default 400 : readable / writable / private /
279       static-nick / static-blurb)
280           Font weight as an integer, see predefined values in PangoWeight;
281           for example, PANGO_WEIGHT_BOLD
282
283       'weight-set' (boolean : default false : readable / writable / private /
284       static-nick / static-blurb)
285           Whether this tag affects the font weight
286
287       'wrap-mode' (Gtk2::WrapMode : default "none" : readable / writable /
288       private / static-nick / static-blurb)
289           Whether to wrap lines never, at word boundaries, or at character
290           boundaries
291
292       'wrap-mode-set' (boolean : default false : readable / writable /
293       private / static-nick / static-blurb)
294           Whether this tag affects line wrap mode
295

SIGNALS

297       boolean = event (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event,
298       Gtk2::TextIter)
299

ENUMS AND FLAGS

301   enum Gtk2::Justification
302       •   'left' / 'GTK_JUSTIFY_LEFT'
303
304       •   'right' / 'GTK_JUSTIFY_RIGHT'
305
306       •   'center' / 'GTK_JUSTIFY_CENTER'
307
308       •   'fill' / 'GTK_JUSTIFY_FILL'
309
310   enum Gtk2::TextDirection
311       •   'none' / 'GTK_TEXT_DIR_NONE'
312
313       •   'ltr' / 'GTK_TEXT_DIR_LTR'
314
315       •   'rtl' / 'GTK_TEXT_DIR_RTL'
316
317   enum Gtk2::WrapMode
318       •   'none' / 'GTK_WRAP_NONE'
319
320       •   'char' / 'GTK_WRAP_CHAR'
321
322       •   'word' / 'GTK_WRAP_WORD'
323
324       •   'word-char' / 'GTK_WRAP_WORD_CHAR'
325
326   enum Pango::Stretch
327       •   'ultra-condensed' / 'PANGO_STRETCH_ULTRA_CONDENSED'
328
329       •   'extra-condensed' / 'PANGO_STRETCH_EXTRA_CONDENSED'
330
331       •   'condensed' / 'PANGO_STRETCH_CONDENSED'
332
333       •   'semi-condensed' / 'PANGO_STRETCH_SEMI_CONDENSED'
334
335       •   'normal' / 'PANGO_STRETCH_NORMAL'
336
337       •   'semi-expanded' / 'PANGO_STRETCH_SEMI_EXPANDED'
338
339       •   'expanded' / 'PANGO_STRETCH_EXPANDED'
340
341       •   'extra-expanded' / 'PANGO_STRETCH_EXTRA_EXPANDED'
342
343       •   'ultra-expanded' / 'PANGO_STRETCH_ULTRA_EXPANDED'
344
345   enum Pango::Style
346       •   'normal' / 'PANGO_STYLE_NORMAL'
347
348       •   'oblique' / 'PANGO_STYLE_OBLIQUE'
349
350       •   'italic' / 'PANGO_STYLE_ITALIC'
351
352   enum Pango::Underline
353       •   'none' / 'PANGO_UNDERLINE_NONE'
354
355       •   'single' / 'PANGO_UNDERLINE_SINGLE'
356
357       •   'double' / 'PANGO_UNDERLINE_DOUBLE'
358
359       •   'low' / 'PANGO_UNDERLINE_LOW'
360
361       •   'error' / 'PANGO_UNDERLINE_ERROR'
362
363       •   'single-line' / 'PANGO_UNDERLINE_SINGLE_LINE'
364
365       •   'double-line' / 'PANGO_UNDERLINE_DOUBLE_LINE'
366
367       •   'error-line' / 'PANGO_UNDERLINE_ERROR_LINE'
368
369   enum Pango::Variant
370       •   'normal' / 'PANGO_VARIANT_NORMAL'
371
372       •   'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
373
374       •   'all-small-caps' / 'PANGO_VARIANT_ALL_SMALL_CAPS'
375
376       •   'petite-caps' / 'PANGO_VARIANT_PETITE_CAPS'
377
378       •   'all-petite-caps' / 'PANGO_VARIANT_ALL_PETITE_CAPS'
379
380       •   'unicase' / 'PANGO_VARIANT_UNICASE'
381
382       •   'title-caps' / 'PANGO_VARIANT_TITLE_CAPS'
383

COPYRIGHT

388       Copyright (C) 2003-2011 by the gtk2-perl team.
389
390       This software is licensed under the LGPL.  See Gtk2 for a full notice.
391
392
393
394perl v5.36.0                      2023-01-20                  Gtk2::TextTag(3)