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

SIGNALS

271       boolean = event (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event,
272       Gtk2::TextIter)
273

ENUMS AND FLAGS

275   enum Gtk2::Justification
276       ·   'left' / 'GTK_JUSTIFY_LEFT'
277
278       ·   'right' / 'GTK_JUSTIFY_RIGHT'
279
280       ·   'center' / 'GTK_JUSTIFY_CENTER'
281
282       ·   'fill' / 'GTK_JUSTIFY_FILL'
283
284   enum Gtk2::TextDirection
285       ·   'none' / 'GTK_TEXT_DIR_NONE'
286
287       ·   'ltr' / 'GTK_TEXT_DIR_LTR'
288
289       ·   'rtl' / 'GTK_TEXT_DIR_RTL'
290
291   enum Gtk2::WrapMode
292       ·   'none' / 'GTK_WRAP_NONE'
293
294       ·   'char' / 'GTK_WRAP_CHAR'
295
296       ·   'word' / 'GTK_WRAP_WORD'
297
298       ·   'word-char' / 'GTK_WRAP_WORD_CHAR'
299
300   enum Pango::Stretch
301       ·   'ultra-condensed' / 'PANGO_STRETCH_ULTRA_CONDENSED'
302
303       ·   'extra-condensed' / 'PANGO_STRETCH_EXTRA_CONDENSED'
304
305       ·   'condensed' / 'PANGO_STRETCH_CONDENSED'
306
307       ·   'semi-condensed' / 'PANGO_STRETCH_SEMI_CONDENSED'
308
309       ·   'normal' / 'PANGO_STRETCH_NORMAL'
310
311       ·   'semi-expanded' / 'PANGO_STRETCH_SEMI_EXPANDED'
312
313       ·   'expanded' / 'PANGO_STRETCH_EXPANDED'
314
315       ·   'extra-expanded' / 'PANGO_STRETCH_EXTRA_EXPANDED'
316
317       ·   'ultra-expanded' / 'PANGO_STRETCH_ULTRA_EXPANDED'
318
319   enum Pango::Style
320       ·   'normal' / 'PANGO_STYLE_NORMAL'
321
322       ·   'oblique' / 'PANGO_STYLE_OBLIQUE'
323
324       ·   'italic' / 'PANGO_STYLE_ITALIC'
325
326   enum Pango::Underline
327       ·   'none' / 'PANGO_UNDERLINE_NONE'
328
329       ·   'single' / 'PANGO_UNDERLINE_SINGLE'
330
331       ·   'double' / 'PANGO_UNDERLINE_DOUBLE'
332
333       ·   'low' / 'PANGO_UNDERLINE_LOW'
334
335       ·   'error' / 'PANGO_UNDERLINE_ERROR'
336
337   enum Pango::Variant
338       ·   'normal' / 'PANGO_VARIANT_NORMAL'
339
340       ·   'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
341

COPYRIGHT

346       Copyright (C) 2003-2011 by the gtk2-perl team.
347
348       This software is licensed under the LGPL.  See Gtk2 for a full notice.
349
350
351
352perl v5.30.1                      2020-01-30                  Gtk2::TextTag(3)