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

NAME

6       Gtk2::TextIter - wrapper for GtkTextIter
7

HIERARCHY

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

METHODS

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

ENUMS AND FLAGS

247   flags Gtk2::TextSearchFlags
248       •   'visible-only' / 'GTK_TEXT_SEARCH_VISIBLE_ONLY'
249
250       •   'text-only' / 'GTK_TEXT_SEARCH_TEXT_ONLY'
251

SEE ALSO

253       Gtk2, Glib::Boxed
254

COPYRIGHT

256       Copyright (C) 2003-2011 by the gtk2-perl team.
257
258       This software is licensed under the LGPL.  See Gtk2 for a full notice.
259
260
261
262perl v5.34.0                      2022-01-21                 Gtk2::TextIter(3)