Gtk2::TextIter(3)

okay so bestie, welcome to the manual page for Gtk2::TextIter(3) — it's literally the wrapper for GtkTextIter, and it's giving main character energy in the Gtk2 Perl world 💅✨. This is your no-skip guide, so grab a boba and let's vibe check every method, flag, and copyright line. No cap.

🌸 NAME 🌸

Gtk2::TextIter — wrapper for GtkTextIter 🎀

🦋 HIERARCHY 🦋

the family tree, bestie:

  Glib::Boxed
  +----Gtk2::TextIter

✨ METHODS ✨

here's the whole method menu, bestie. every single one. no skipping. periodt. 💅

• textattributes = $iter->get_attributes — returns textattributes, iconic.
• boolean = $iter->backward_char — returns a boolean, slay.
• boolean = $iter->backward_chars ($count) — returns a boolean.
  • $count (integer) — the count, bestie.
• boolean = $iter->backward_cursor_position — returns a boolean, lowkey.
• boolean = $iter->backward_cursor_positions ($count) — returns a boolean.
  • $count (integer) — the count.
• boolean = $iter->backward_find_char ($pred, $user_data=undef, $limit=undef) — returns a boolean.
  • $pred (scalar) — the pred.
  • $user_data (scalar) — defaults to undef.
  • $limit (Gtk2::TextIter or undef) — defaults to undef.
• boolean = $iter->backward_line — returns a boolean.
• boolean = $iter->backward_lines ($count) — returns a boolean.
  • $count (integer)
• (match_start, match_end) = $iter->backward_search ($str, $flags, $limit=NULL) — returns (match_start, match_end), no cap.
  • $str (string)
  • $flags (Gtk2::TextSearchFlags)
  • $limit (Gtk2::TextIter or undef) — default is NULL.
• boolean = $iter->backward_sentence_start — returns a boolean.
• boolean = $iter->backward_sentence_starts ($count) — returns a boolean.
  • $count (integer)
• boolean = $iter->backward_to_tag_toggle ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag or undef)
• boolean = $iter->backward_visible_cursor_position — returns a boolean. Since: gtk+ 2.4 — old but iconic.
• boolean = $iter->backward_visible_cursor_positions ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.4
• boolean = $iter->backward_visible_line — returns a boolean. Since: gtk+ 2.8
• boolean = $iter->backward_visible_lines ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.8
• boolean = $iter->backward_visible_word_start — returns a boolean. Since: gtk+ 2.4
• boolean = $iter->backward_visible_word_starts ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.4
• boolean = $iter->backward_word_start — returns a boolean.
• boolean = $iter->backward_word_starts ($count) — returns a boolean.
  • $count (integer)
• boolean = $iter->begins_tag ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag or undef)
• textbuffer = $iter->get_buffer — returns a textbuffer, slay.
• integer = $iter->get_bytes_in_line — returns an integer.
• boolean = $iter->can_insert ($default_editability) — returns a boolean.
  • $default_editability (boolean)
• character = $iter->get_char — returns a character, iconic.
• integer = $iter->get_chars_in_line — returns an integer.
• textchildanchor or undef = $iter->get_child_anchor — returns a textchildanchor or undef.
• integer = $lhs->compare ($rhs) — returns an integer.
  • $rhs (Gtk2::TextIter)
• boolean = $iter->editable ($default_setting) — returns a boolean.
  • $default_setting (boolean)
• boolean = $iter->ends_line — returns a boolean.
• boolean = $iter->ends_sentence — returns a boolean.
• boolean = $iter->ends_tag ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag or undef)
• boolean = $iter->ends_word — returns a boolean.
• boolean = $lhs->equal ($rhs) — returns a boolean.
  • $rhs (Gtk2::TextIter)
• boolean = $iter->forward_char — returns a boolean.
• boolean = $iter->forward_chars ($count) — returns a boolean.
  • $count (integer)
• boolean = $iter->forward_cursor_position — returns a boolean.
• boolean = $iter->forward_cursor_positions ($count) — returns a boolean.
  • $count (integer)
• boolean = $iter->forward_find_char ($pred, $user_data=undef, $limit=undef) — returns a boolean.
  • $pred (scalar)
  • $user_data (scalar) — default undef.
  • $limit (Gtk2::TextIter or undef) — default undef.
• boolean = $iter->forward_line — returns a boolean.
• boolean = $iter->forward_lines ($count) — returns a boolean.
  • $count (integer)
• (match_start, match_end) = $iter->forward_search ($str, $flags, $limit=NULL) — returns (match_start, match_end).
  • $str (string)
  • $flags (Gtk2::TextSearchFlags)
  • $limit (Gtk2::TextIter or undef) — default NULL.
• boolean = $iter->forward_sentence_end — returns a boolean.
• boolean = $iter->forward_sentence_ends ($count) — returns a boolean.
  • $count (integer)
• $iter->forward_to_end — no return type, just vibes. 💫
• boolean = $iter->forward_to_line_end — returns a boolean.
• boolean = $iter->forward_to_tag_toggle ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag or undef)
• boolean = $iter->forward_visible_cursor_position — returns a boolean. Since: gtk+ 2.4
• boolean = $iter->forward_visible_cursor_positions ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.4
• boolean = $iter->forward_visible_line — returns a boolean. Since: gtk+ 2.8
• boolean = $iter->forward_visible_lines ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.8
• boolean = $iter->forward_visible_word_end — returns a boolean. Since: gtk+ 2.4
• boolean = $iter->forward_visible_word_ends ($count) — returns a boolean.
  • $count (integer)
  • Since: gtk+ 2.4
• boolean = $iter->forward_word_end — returns a boolean.
• boolean = $iter->forward_word_ends ($count) — returns a boolean.
  • $count (integer)
• boolean = $iter->has_tag ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag)
• boolean = $iter->in_range ($start, $end) — returns a boolean.
  • $start (Gtk2::TextIter)
  • $end (Gtk2::TextIter)
• boolean = $iter->inside_sentence — returns a boolean.
• boolean = $iter->inside_word — returns a boolean.
• boolean = $iter->is_cursor_position — returns a boolean.
• boolean = $iter->is_end — returns a boolean.
• boolean = $iter->is_start — returns a boolean.
• language = $iter->get_language — returns a language.
• integer = $iter->get_line — returns an integer.
• integer = $iter->get_line_index — returns an integer.
• $iter->set_line_index ($byte_on_line) — takes:
  • $byte_on_line (integer)
• integer = $iter->get_line_offset — returns an integer.
• $iter->set_line_offset ($char_on_line) — takes:
  • $char_on_line (integer)
• $iter->set_line ($line_number) — takes:
  • $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 — returns an integer.
• $iter->set_offset ($char_offset) — takes:
  • $char_offset (integer)
• $first->order ($second) — no return type, just vibes. 💫
  • $second (Gtk2::TextIter)
• pixbuf or undef = $iter->get_pixbuf — returns a pixbuf or undef.
• string = $start->get_slice ($end) — returns a string.
  • $end (Gtk2::TextIter)
• boolean = $iter->starts_line — returns a boolean.
• boolean = $iter->starts_sentence — returns a boolean.
• boolean = $iter->starts_word — returns a boolean.
• 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) — returns a string.
  • $end (Gtk2::TextIter)
• list = $iter->get_toggled_tags ($toggled_on) — 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.
  • $toggled_on (boolean)
• boolean = $iter->toggles_tag ($tag) — returns a boolean.
  • $tag (Gtk2::TextTag or undef)
• integer = $iter->get_visible_line_index — returns an integer.
• $iter->set_visible_line_index ($byte_on_line) — takes:
  • $byte_on_line (integer)
• integer = $iter->get_visible_line_offset — returns an integer.
• $iter->set_visible_line_offset ($char_on_line) — takes:
  • $char_on_line (integer)
• string = $start->get_visible_slice ($end) — returns a string.
  • $end (Gtk2::TextIter)
• string = $start->get_visible_text ($end) — returns a string.
  • $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.

---

and that's the tea, bestie! this page is from perl v5.42.0, dated 2025-07-25, and it's Gtk2::TextIter(3) — now go slay some text buffers. 💖✨🦋