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

NAME

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

SIGNALS

236       boolean = event (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event,
237       Gtk2::TextIter)
238

ENUMS AND FLAGS

240   enum Gtk2::Justification
241       ·   'left' / 'GTK_JUSTIFY_LEFT'
242
243       ·   'right' / 'GTK_JUSTIFY_RIGHT'
244
245       ·   'center' / 'GTK_JUSTIFY_CENTER'
246
247       ·   'fill' / 'GTK_JUSTIFY_FILL'
248
249   enum Gtk2::Pango::Stretch
250       ·   'ultra-condensed' / 'PANGO_STRETCH_ULTRA_CONDENSED'
251
252       ·   'extra-condensed' / 'PANGO_STRETCH_EXTRA_CONDENSED'
253
254       ·   'condensed' / 'PANGO_STRETCH_CONDENSED'
255
256       ·   'semi-condensed' / 'PANGO_STRETCH_SEMI_CONDENSED'
257
258       ·   'normal' / 'PANGO_STRETCH_NORMAL'
259
260       ·   'semi-expanded' / 'PANGO_STRETCH_SEMI_EXPANDED'
261
262       ·   'expanded' / 'PANGO_STRETCH_EXPANDED'
263
264       ·   'extra-expanded' / 'PANGO_STRETCH_EXTRA_EXPANDED'
265
266       ·   'ultra-expanded' / 'PANGO_STRETCH_ULTRA_EXPANDED'
267
268   enum Gtk2::Pango::Style
269       ·   'normal' / 'PANGO_STYLE_NORMAL'
270
271       ·   'oblique' / 'PANGO_STYLE_OBLIQUE'
272
273       ·   'italic' / 'PANGO_STYLE_ITALIC'
274
275   enum Gtk2::Pango::Underline
276       ·   'none' / 'PANGO_UNDERLINE_NONE'
277
278       ·   'single' / 'PANGO_UNDERLINE_SINGLE'
279
280       ·   'double' / 'PANGO_UNDERLINE_DOUBLE'
281
282       ·   'low' / 'PANGO_UNDERLINE_LOW'
283
284       ·   'error' / 'PANGO_UNDERLINE_ERROR'
285
286   enum Gtk2::Pango::Variant
287       ·   'normal' / 'PANGO_VARIANT_NORMAL'
288
289       ·   'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
290
291   enum Gtk2::TextDirection
292       ·   'none' / 'GTK_TEXT_DIR_NONE'
293
294       ·   'ltr' / 'GTK_TEXT_DIR_LTR'
295
296       ·   'rtl' / 'GTK_TEXT_DIR_RTL'
297
298   enum Gtk2::WrapMode
299       ·   'none' / 'GTK_WRAP_NONE'
300
301       ·   'char' / 'GTK_WRAP_CHAR'
302
303       ·   'word' / 'GTK_WRAP_WORD'
304
305       ·   'word-char' / 'GTK_WRAP_WORD_CHAR'
306

SEE ALSO

308       Gtk2, Glib::Object
309
311       Copyright (C) 2003-2008 by the gtk2-perl team.
312
313       This software is licensed under the LGPL.  See Gtk2 for a full notice.
314
315
316
317perl v5.12.0                      2010-05-02                  Gtk2::TextTag(3)
Impressum