Gtk2::TextTag(3pm)

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
15           * $name (string or undef)
16
17       boolean = $tag->event ($event_object, $event, $iter)
18
19           * $event_object (Glib::Object)
20           * $event (Gtk2::Gdk::Event)
21           * $iter (Gtk2::TextIter)
22
23       integer = $tag->get_priority
24
25       $tag->set_priority ($priority)
26
27           * $priority (integer)
28

PROPERTIES

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

SIGNALS

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

ENUMS AND FLAGS

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

COPYRIGHT

294       Copyright (C) 2003-2007 by the gtk2-perl team.
295
296       This software is licensed under the LGPL.  See Gtk2 for a full notice.
297
298
299
300perl v5.8.8                       2007-03-18                  Gtk2::TextTag(3)