man Gtk2::TextIter (3): 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'

COPYRIGHT

This software is licensed under the LGPL. See Gtk2 for a full notice.