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

NAME

6       Gtk2::TextIter
7

HIERARCHY

9         Glib::Boxed
10         +----Gtk2::TextIter
11

METHODS

13       textattributes = $iter->get_attributes
14
15       boolean = $iter->backward_char
16
17       boolean = $iter->backward_chars ($count)
18
19           * $count (integer)
20
21       boolean = $iter->backward_cursor_position
22
23       boolean = $iter->backward_cursor_positions ($count)
24
25           * $count (integer)
26
27       boolean = $iter->backward_find_char ($pred, $user_data=undef,
28       $limit=undef)
29
30           * $pred (scalar)
31           * $user_data (scalar)
32           * $limit (Gtk2::TextIter or undef)
33
34       boolean = $iter->backward_line
35
36       boolean = $iter->backward_lines ($count)
37
38           * $count (integer)
39
40       (match_start, match_end) = $iter->forward_search ($str, $flags,
41       $limit=NULL)
42
43           * $str (string)
44           * $flags (Gtk2::TextSearchFlags)
45           * $limit (Gtk2::TextIter or undef)
46
47       boolean = $iter->backward_sentence_start
48
49       boolean = $iter->backward_sentence_starts ($count)
50
51           * $count (integer)
52
53       boolean = $iter->backward_to_tag_toggle ($tag)
54
55           * $tag (Gtk2::TextTag or undef)
56
57       boolean = $iter->backward_visible_cursor_position
58
59       boolean = $iter->backward_visible_cursor_positions ($count)
60
61           * $count (integer)
62
63       boolean = $iter->backward_visible_line
64
65       boolean = $iter->backward_visible_lines ($count)
66
67           * $count (integer)
68
69       boolean = $iter->backward_visible_word_start
70
71       boolean = $iter->backward_visible_word_starts ($count)
72
73           * $count (integer)
74
75       boolean = $iter->backward_word_start
76
77       boolean = $iter->backward_word_starts ($count)
78
79           * $count (integer)
80
81       boolean = $iter->begins_tag ($tag)
82
83           * $tag (Gtk2::TextTag or undef)
84
85       textbuffer = $iter->get_buffer
86
87       integer = $iter->get_bytes_in_line
88
89       boolean = $iter->can_insert ($default_editability)
90
91           * $default_editability (boolean)
92
93       character = $iter->get_char
94
95       integer = $iter->get_chars_in_line
96
97       textchildanchor or undef = $iter->get_child_anchor
98
99       integer = $lhs->compare ($rhs)
100
101           * $rhs (Gtk2::TextIter)
102
103       boolean = $iter->editable ($default_setting)
104
105           * $default_setting (boolean)
106
107       boolean = $iter->ends_line
108
109       boolean = $iter->ends_sentence
110
111       boolean = $iter->ends_tag ($tag)
112
113           * $tag (Gtk2::TextTag or undef)
114
115       boolean = $iter->ends_word
116
117       boolean = $lhs->equal ($rhs)
118
119           * $rhs (Gtk2::TextIter)
120
121       boolean = $iter->forward_char
122
123       boolean = $iter->forward_chars ($count)
124
125           * $count (integer)
126
127       boolean = $iter->forward_cursor_position
128
129       boolean = $iter->forward_cursor_positions ($count)
130
131           * $count (integer)
132
133       boolean = $iter->forward_find_char ($pred, $user_data=undef,
134       $limit=undef)
135
136           * $pred (scalar)
137           * $user_data (scalar)
138           * $limit (Gtk2::TextIter or undef)
139
140       boolean = $iter->forward_line
141
142       boolean = $iter->forward_lines ($count)
143
144           * $count (integer)
145
146       (match_start, match_end) = $iter->forward_search ($str, $flags,
147       $limit=NULL)
148
149           * $str (string)
150           * $flags (Gtk2::TextSearchFlags)
151           * $limit (Gtk2::TextIter or undef)
152
153       boolean = $iter->forward_sentence_end
154
155       boolean = $iter->forward_sentence_ends ($count)
156
157           * $count (integer)
158
159       $iter->forward_to_end
160
161       boolean = $iter->forward_to_line_end
162
163       boolean = $iter->forward_to_tag_toggle ($tag)
164
165           * $tag (Gtk2::TextTag or undef)
166
167       boolean = $iter->forward_visible_cursor_position
168
169       boolean = $iter->forward_visible_cursor_positions ($count)
170
171           * $count (integer)
172
173       boolean = $iter->forward_visible_line
174
175       boolean = $iter->forward_visible_lines ($count)
176
177           * $count (integer)
178
179       boolean = $iter->forward_visible_word_end
180
181       boolean = $iter->forward_visible_word_ends ($count)
182
183           * $count (integer)
184
185       boolean = $iter->forward_word_end
186
187       boolean = $iter->forward_word_ends ($count)
188
189           * $count (integer)
190
191       boolean = $iter->has_tag ($tag)
192
193           * $tag (Gtk2::TextTag)
194
195       boolean = $iter->in_range ($start, $end)
196
197           * $start (Gtk2::TextIter)
198           * $end (Gtk2::TextIter)
199
200       boolean = $iter->inside_sentence
201
202       boolean = $iter->inside_word
203
204       boolean = $iter->is_cursor_position
205
206       boolean = $iter->is_end
207
208       boolean = $iter->is_start
209
210       language = $iter->get_language
211
212       integer = $iter->get_line
213
214       integer = $iter->get_line_index
215
216       $iter->set_line_index ($byte_on_line)
217
218           * $byte_on_line (integer)
219
220       integer = $iter->get_line_offset
221
222       $iter->set_line_offset ($char_on_line)
223
224           * $char_on_line (integer)
225
226       $iter->set_line ($line_number)
227
228           * $line_number (integer)
229
230       list = $iter->get_marks
231
232           Returns a list of all Gtk2::TextMark at this location. Because
233           marks are not iterable (they don't take up any "space" in the buf‐
234           fer, they are just marks in between iterable locations), multiple
235           marks can exist in the same place. The returned list is not in any
236           meaningful order.
237
238       integer = $iter->get_offset
239
240       $iter->set_offset ($char_offset)
241
242           * $char_offset (integer)
243
244       $first->order ($second)
245
246           * $second (Gtk2::TextIter)
247
248       pixbuf or undef = $iter->get_pixbuf
249
250       string = $start->get_slice ($end)
251
252           * $end (Gtk2::TextIter)
253
254       boolean = $iter->starts_line
255
256       boolean = $iter->starts_sentence
257
258       boolean = $iter->starts_word
259
260       list = $iter->get_tags
261
262           Returns a list of tags that apply to iter, in ascending order of
263           priority (highest-priority tags are last).
264
265       string = $start->get_text ($end)
266
267           * $end (Gtk2::TextIter)
268
269       list = $iter->get_toggled_tags ($toggled_on)
270
271           * $toggled_on (boolean)
272
273           Returns a list of Gtk2::TextTag that are toggled on or off at this
274           point. (If toggled_on is TRUE, the list contains tags that are tog‐
275           gled on.) If a tag is toggled on at iter, then some non-empty range
276           of characters following iter has that tag applied to it. If a tag
277           is toggled off, then some non-empty range following iter does not
278           have the tag applied to it.
279
280       boolean = $iter->toggles_tag ($tag)
281
282           * $tag (Gtk2::TextTag or undef)
283
284       integer = $iter->get_visible_line_index
285
286       $iter->set_visible_line_index ($byte_on_line)
287
288           * $byte_on_line (integer)
289
290       integer = $iter->get_visible_line_offset
291
292       $iter->set_visible_line_offset ($char_on_line)
293
294           * $char_on_line (integer)
295
296       string = $start->get_visible_slice ($end)
297
298           * $end (Gtk2::TextIter)
299
300       string = $start->get_visible_text ($end)
301
302           * $end (Gtk2::TextIter)
303

ENUMS AND FLAGS

305       flags Gtk2::TextSearchFlags
306
307       * 'visible-only' / 'GTK_TEXT_SEARCH_VISIBLE_ONLY'
308       * 'text-only' / 'GTK_TEXT_SEARCH_TEXT_ONLY'
309

SEE ALSO

311       Gtk2, Glib::Boxed
312

COPYRIGHT

314       Copyright (C) 2003-2007 by the gtk2-perl team.
315
316       This software is licensed under the LGPL.  See Gtk2 for a full notice.
317
318
319
320perl v5.8.8                       2007-03-18                 Gtk2::TextIter(3)