--- name: "Gtk2::TextIter" section: "3pm" platform: "linux" package: "libgtk2-perl-doc" version: "2:1.24992-1" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/Gtk2::TextIter" --- # Gtk2::TextIter(3pm) wrapper for GtkTextIter ## NAME Gtk2::TextIter - wrapper for GtkTextIter ## HIERARCHY ``` Glib::Boxed +----Gtk2::TextIter ``` ## METHODS ### textattributes = $iter-\>get\_attributes ### boolean = $iter-\>backward\_char ### boolean = $iter-\>backward\_chars ($count) - • `$count` (integer) ### boolean = $iter-\>backward\_cursor\_position ### boolean = $iter-\>backward\_cursor\_positions ($count) - • `$count` (integer) ### boolean = $iter-\>backward\_find\_char ($pred, $user\_data=undef, $limit=undef) - • `$pred` (scalar) - • `$user_data` (scalar) - • `$limit` (Gtk2::TextIter or undef) ### boolean = $iter-\>backward\_line ### boolean = $iter-\>backward\_lines ($count) - • `$count` (integer) ### (match\_start, match\_end) = $iter-\>backward\_search ($str, $flags, $limit=NULL) - • `$str` (string) - • `$flags` (Gtk2::TextSearchFlags) - • `$limit` (Gtk2::TextIter or undef) ### boolean = $iter-\>backward\_sentence\_start ### boolean = $iter-\>backward\_sentence\_starts ($count) - • `$count` (integer) ### boolean = $iter-\>backward\_to\_tag\_toggle ($tag) - • `$tag` (Gtk2::TextTag or undef) ### boolean = $iter-\>backward\_visible\_cursor\_position Since: gtk+ 2.4 ### boolean = $iter-\>backward\_visible\_cursor\_positions ($count) - • `$count` (integer) Since: gtk+ 2.4 ### boolean = $iter-\>backward\_visible\_line Since: gtk+ 2.8 ### boolean = $iter-\>backward\_visible\_lines ($count) - • `$count` (integer) Since: gtk+ 2.8 ### boolean = $iter-\>backward\_visible\_word\_start Since: gtk+ 2.4 ### boolean = $iter-\>backward\_visible\_word\_starts ($count) - • `$count` (integer) Since: gtk+ 2.4 ### boolean = $iter-\>backward\_word\_start ### boolean = $iter-\>backward\_word\_starts ($count) - • `$count` (integer) ### boolean = $iter-\>begins\_tag ($tag) - • `$tag` (Gtk2::TextTag or undef) ### textbuffer = $iter-\>get\_buffer ### integer = $iter-\>get\_bytes\_in\_line ### boolean = $iter-\>can\_insert ($default\_editability) - • `$default_editability` (boolean) ### character = $iter-\>get\_char ### integer = $iter-\>get\_chars\_in\_line ### textchildanchor or undef = $iter-\>get\_child\_anchor ### integer = $lhs-\>compare ($rhs) - • `$rhs` (Gtk2::TextIter) ### boolean = $iter-\>editable ($default\_setting) - • `$default_setting` (boolean) ### boolean = $iter-\>ends\_line ### boolean = $iter-\>ends\_sentence ### boolean = $iter-\>ends\_tag ($tag) - • `$tag` (Gtk2::TextTag or undef) ### boolean = $iter-\>ends\_word ### boolean = $lhs-\>equal ($rhs) - • `$rhs` (Gtk2::TextIter) ### boolean = $iter-\>forward\_char ### boolean = $iter-\>forward\_chars ($count) - • `$count` (integer) ### boolean = $iter-\>forward\_cursor\_position ### boolean = $iter-\>forward\_cursor\_positions ($count) - • `$count` (integer) ### boolean = $iter-\>forward\_find\_char ($pred, $user\_data=undef, $limit=undef) - • `$pred` (scalar) - • `$user_data` (scalar) - • `$limit` (Gtk2::TextIter or undef) ### boolean = $iter-\>forward\_line ### boolean = $iter-\>forward\_lines ($count) - • `$count` (integer) ### (match\_start, match\_end) = $iter-\>forward\_search ($str, $flags, $limit=NULL) - • `$str` (string) - • `$flags` (Gtk2::TextSearchFlags) - • `$limit` (Gtk2::TextIter or undef) ### boolean = $iter-\>forward\_sentence\_end ### boolean = $iter-\>forward\_sentence\_ends ($count) - • `$count` (integer) ### $iter-\>forward\_to\_end ### boolean = $iter-\>forward\_to\_line\_end ### boolean = $iter-\>forward\_to\_tag\_toggle ($tag) - • `$tag` (Gtk2::TextTag or undef) ### boolean = $iter-\>forward\_visible\_cursor\_position Since: gtk+ 2.4 ### boolean = $iter-\>forward\_visible\_cursor\_positions ($count) - • `$count` (integer) Since: gtk+ 2.4 ### boolean = $iter-\>forward\_visible\_line Since: gtk+ 2.8 ### boolean = $iter-\>forward\_visible\_lines ($count) - • `$count` (integer) Since: gtk+ 2.8 ### boolean = $iter-\>forward\_visible\_word\_end Since: gtk+ 2.4 ### boolean = $iter-\>forward\_visible\_word\_ends ($count) - • `$count` (integer) Since: gtk+ 2.4 ### boolean = $iter-\>forward\_word\_end ### boolean = $iter-\>forward\_word\_ends ($count) - • `$count` (integer) ### boolean = $iter-\>has\_tag ($tag) - • `$tag` (Gtk2::TextTag) ### boolean = $iter-\>in\_range ($start, $end) - • `$start` (Gtk2::TextIter) - • `$end` (Gtk2::TextIter) ### boolean = $iter-\>inside\_sentence ### boolean = $iter-\>inside\_word ### boolean = $iter-\>is\_cursor\_position ### boolean = $iter-\>is\_end ### boolean = $iter-\>is\_start ### language = $iter-\>get\_language ### integer = $iter-\>get\_line ### integer = $iter-\>get\_line\_index ### $iter-\>set\_line\_index ($byte\_on\_line) - • `$byte_on_line` (integer) ### integer = $iter-\>get\_line\_offset ### $iter-\>set\_line\_offset ($char\_on\_line) - • `$char_on_line` (integer) ### $iter-\>set\_line ($line\_number) - • `$line_number` (integer) ### list = $iter-\>get\_marks Returns a list of all Gtk2::TextMark at this location. Because marks are not iterable (they don't take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order. ### integer = $iter-\>get\_offset ### $iter-\>set\_offset ($char\_offset) - • `$char_offset` (integer) ### $first-\>order ($second) - • `$second` (Gtk2::TextIter) ### pixbuf or undef = $iter-\>get\_pixbuf ### string = $start-\>get\_slice ($end) - • `$end` (Gtk2::TextIter) ### boolean = $iter-\>starts\_line ### boolean = $iter-\>starts\_sentence ### boolean = $iter-\>starts\_word ### list = $iter-\>get\_tags Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last). ### string = $start-\>get\_text ($end) - • `$end` (Gtk2::TextIter) ### list = $iter-\>get\_toggled\_tags ($toggled\_on) - • `$toggled_on` (boolean) Returns a list of Gtk2::TextTag that are toggled on or off at this point. (If toggled\_on is TRUE, the list contains tags that are toggled on.) If a tag is toggled on at iter, then some non-empty range of characters following iter has that tag applied to it. If a tag is toggled off, then some non-empty range following iter does not have the tag applied to it. ### boolean = $iter-\>toggles\_tag ($tag) - • `$tag` (Gtk2::TextTag or undef) ### integer = $iter-\>get\_visible\_line\_index ### $iter-\>set\_visible\_line\_index ($byte\_on\_line) - • `$byte_on_line` (integer) ### integer = $iter-\>get\_visible\_line\_offset ### $iter-\>set\_visible\_line\_offset ($char\_on\_line) - • `$char_on_line` (integer) ### string = $start-\>get\_visible\_slice ($end) - • `$end` (Gtk2::TextIter) ### string = $start-\>get\_visible\_text ($end) - • `$end` (Gtk2::TextIter) ## ENUMS AND FLAGS ### flags Gtk2::TextSearchFlags - • 'visible-only' / 'GTK\_TEXT\_SEARCH\_VISIBLE\_ONLY' - • 'text-only' / 'GTK\_TEXT\_SEARCH\_TEXT\_ONLY' ## SEE ALSO Gtk2, Glib::Boxed ## COPYRIGHT Copyright (C) 2003-2011 by the gtk2-perl team. This software is licensed under the LGPL. See Gtk2 for a full notice.