<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkTextIter">
<refmeta>
<refentrytitle role="top_of_page" id="GtkTextIter.top_of_page">GtkTextIter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkTextIter</refname>
<refpurpose>Text buffer iterator</refpurpose>
</refnamediv>

<refsect1 id="GtkTextIter.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkTextBuffer"><returnvalue>GtkTextBuffer</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-buffer">gtk_text_iter_get_buffer</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkTextIter"><returnvalue>GtkTextIter</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-copy">gtk_text_iter_copy</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-assign">gtk_text_iter_assign</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-free">gtk_text_iter_free</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-offset">gtk_text_iter_get_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-line">gtk_text_iter_get_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-line-offset">gtk_text_iter_get_line_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-line-index">gtk_text_iter_get_line_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-visible-line-index">gtk_text_iter_get_visible_line_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-visible-line-offset">gtk_text_iter_get_visible_line_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gunichar"><returnvalue>gunichar</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-char">gtk_text_iter_get_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-slice">gtk_text_iter_get_slice</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-text">gtk_text_iter_get_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-visible-slice">gtk_text_iter_get_visible_slice</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-visible-text">gtk_text_iter_get_visible_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-marks">gtk_text_iter_get_marks</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-toggled-tags">gtk_text_iter_get_toggled_tags</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkTextChildAnchor"><returnvalue>GtkTextChildAnchor</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-child-anchor">gtk_text_iter_get_child_anchor</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-starts-tag">gtk_text_iter_starts_tag</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-ends-tag">gtk_text_iter_ends_tag</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-toggles-tag">gtk_text_iter_toggles_tag</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-has-tag">gtk_text_iter_has_tag</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-tags">gtk_text_iter_get_tags</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-editable">gtk_text_iter_editable</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-can-insert">gtk_text_iter_can_insert</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-starts-word">gtk_text_iter_starts_word</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-ends-word">gtk_text_iter_ends_word</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-inside-word">gtk_text_iter_inside_word</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-starts-line">gtk_text_iter_starts_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-ends-line">gtk_text_iter_ends_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-starts-sentence">gtk_text_iter_starts_sentence</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-ends-sentence">gtk_text_iter_ends_sentence</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-inside-sentence">gtk_text_iter_inside_sentence</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-is-cursor-position">gtk_text_iter_is_cursor_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-chars-in-line">gtk_text_iter_get_chars_in_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-bytes-in-line">gtk_text_iter_get_bytes_in_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLanguage"><returnvalue>PangoLanguage</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-text-iter-get-language">gtk_text_iter_get_language</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-is-end">gtk_text_iter_is_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-is-start">gtk_text_iter_is_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-char">gtk_text_iter_forward_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-char">gtk_text_iter_backward_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-chars">gtk_text_iter_forward_chars</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-chars">gtk_text_iter_backward_chars</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-line">gtk_text_iter_forward_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-line">gtk_text_iter_backward_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-lines">gtk_text_iter_forward_lines</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-lines">gtk_text_iter_backward_lines</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-word-ends">gtk_text_iter_forward_word_ends</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-word-starts">gtk_text_iter_backward_word_starts</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-word-end">gtk_text_iter_forward_word_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-word-start">gtk_text_iter_backward_word_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-cursor-position">gtk_text_iter_backward_cursor_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-cursor-positions">gtk_text_iter_forward_cursor_positions</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-cursor-positions">gtk_text_iter_backward_cursor_positions</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-sentence-start">gtk_text_iter_backward_sentence_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-sentence-starts">gtk_text_iter_backward_sentence_starts</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-sentence-end">gtk_text_iter_forward_sentence_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-sentence-ends">gtk_text_iter_forward_sentence_ends</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-word-ends">gtk_text_iter_forward_visible_word_ends</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-word-starts">gtk_text_iter_backward_visible_word_starts</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-word-end">gtk_text_iter_forward_visible_word_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-word-start">gtk_text_iter_backward_visible_word_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-cursor-position">gtk_text_iter_forward_visible_cursor_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-cursor-position">gtk_text_iter_backward_visible_cursor_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-cursor-positions">gtk_text_iter_forward_visible_cursor_positions</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-cursor-positions">gtk_text_iter_backward_visible_cursor_positions</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-line">gtk_text_iter_forward_visible_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-line">gtk_text_iter_backward_visible_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-visible-lines">gtk_text_iter_forward_visible_lines</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-visible-lines">gtk_text_iter_backward_visible_lines</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-offset">gtk_text_iter_set_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-line">gtk_text_iter_set_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-line-offset">gtk_text_iter_set_line_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-line-index">gtk_text_iter_set_line_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-visible-line-index">gtk_text_iter_set_visible_line_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-set-visible-line-offset">gtk_text_iter_set_visible_line_offset</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-to-end">gtk_text_iter_forward_to_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-to-line-end">gtk_text_iter_forward_to_line_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-to-tag-toggle">gtk_text_iter_forward_to_tag_toggle</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-to-tag-toggle">gtk_text_iter_backward_to_tag_toggle</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><phrase role="c_punctuation">(</phrase><link linkend="GtkTextCharPredicate">*GtkTextCharPredicate</link><phrase role="c_punctuation">)</phrase>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-find-char">gtk_text_iter_forward_find_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-find-char">gtk_text_iter_backward_find_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-forward-search">gtk_text_iter_forward_search</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-backward-search">gtk_text_iter_backward_search</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-equal">gtk_text_iter_equal</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-compare">gtk_text_iter_compare</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-in-range">gtk_text_iter_in_range</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-text-iter-order">gtk_text_iter_order</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkTextIter.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkTextIter-struct">GtkTextIter</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkTextIter.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GBoxed">GBoxed</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkTextIter
</screen>
</refsect1>

<refsect1 id="GtkTextIter.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkTextIter.description" role="desc">
<title role="desc.title">Description</title>
<para>You may wish to begin by reading the
<link linkend="TextWidget">text widget conceptual overview</link>
which gives an overview of all the objects and data
types related to the text widget and how they work together.</para>

</refsect1>
<refsect1 id="GtkTextIter.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-text-iter-get-buffer" role="function">
<title>gtk_text_iter_get_buffer&#160;()</title>
<indexterm zone="gtk-text-iter-get-buffer"><primary>gtk_text_iter_get_buffer</primary></indexterm>
<programlisting language="C"><link linkend="GtkTextBuffer"><returnvalue>GtkTextBuffer</returnvalue></link>&#160;*
gtk_text_iter_get_buffer (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> this iterator is associated with.</para>
<refsect3 id="gtk-text-iter-get-buffer.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-buffer.returns" role="returns">
<title>Returns</title>
<para>the buffer. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-copy" role="function">
<title>gtk_text_iter_copy&#160;()</title>
<indexterm zone="gtk-text-iter-copy"><primary>gtk_text_iter_copy</primary></indexterm>
<programlisting language="C"><link linkend="GtkTextIter"><returnvalue>GtkTextIter</returnvalue></link>&#160;*
gtk_text_iter_copy (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Creates a dynamically-allocated copy of an iterator. This function
is not useful in applications, because iterators can be copied with a
simple assignment (<literal>GtkTextIter i = j;</literal>). The
function is used by language bindings.</para>
<refsect3 id="gtk-text-iter-copy.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-copy.returns" role="returns">
<title>Returns</title>
<para> a copy of the <parameter>iter</parameter>
, free with <link linkend="gtk-text-iter-free"><function>gtk_text_iter_free()</function></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-assign" role="function">
<title>gtk_text_iter_assign&#160;()</title>
<indexterm zone="gtk-text-iter-assign"><primary>gtk_text_iter_assign</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_assign (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                      <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *other</parameter>);</programlisting>
<para>Assigns the value of <parameter>other</parameter>
 to <parameter>iter</parameter>
.  This function
is not useful in applications, because iterators can be assigned
with <literal>GtkTextIter i = j;</literal>. The
function is used by language bindings.</para>
<refsect3 id="gtk-text-iter-assign.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>other</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-free" role="function">
<title>gtk_text_iter_free&#160;()</title>
<indexterm zone="gtk-text-iter-free"><primary>gtk_text_iter_free</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_free (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Free an iterator allocated on the heap. This function
is intended for use in language bindings, and is not
especially useful for applications, because iterators can
simply be allocated on the stack.</para>
<refsect3 id="gtk-text-iter-free.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a dynamically-allocated iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-offset" role="function">
<title>gtk_text_iter_get_offset&#160;()</title>
<indexterm zone="gtk-text-iter-get-offset"><primary>gtk_text_iter_get_offset</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_offset (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the character offset of an iterator.
Each character in a <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> has an offset,
starting with 0 for the first character in the buffer.
Use <link linkend="gtk-text-buffer-get-iter-at-offset"><function>gtk_text_buffer_get_iter_at_offset()</function></link> to convert an
offset back into an iterator.</para>
<refsect3 id="gtk-text-iter-get-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-offset.returns" role="returns">
<title>Returns</title>
<para> a character offset</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-line" role="function">
<title>gtk_text_iter_get_line&#160;()</title>
<indexterm zone="gtk-text-iter-get-line"><primary>gtk_text_iter_get_line</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_line (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the line number containing the iterator. Lines in
a <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> are numbered beginning with 0 for the first
line in the buffer.</para>
<refsect3 id="gtk-text-iter-get-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-line.returns" role="returns">
<title>Returns</title>
<para> a line number</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-line-offset" role="function">
<title>gtk_text_iter_get_line_offset&#160;()</title>
<indexterm zone="gtk-text-iter-get-line-offset"><primary>gtk_text_iter_get_line_offset</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_line_offset (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the character offset of the iterator,
counting from the start of a newline-terminated line.
The first character on the line has offset 0.</para>
<refsect3 id="gtk-text-iter-get-line-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-line-offset.returns" role="returns">
<title>Returns</title>
<para> offset from start of line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-line-index" role="function">
<title>gtk_text_iter_get_line_index&#160;()</title>
<indexterm zone="gtk-text-iter-get-line-index"><primary>gtk_text_iter_get_line_index</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_line_index (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the byte index of the iterator, counting
from the start of a newline-terminated line.
Remember that <link linkend="GtkTextBuffer"><type>GtkTextBuffer</type></link> encodes text in
UTF-8, and that characters can require a variable
number of bytes to represent.</para>
<refsect3 id="gtk-text-iter-get-line-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-line-index.returns" role="returns">
<title>Returns</title>
<para> distance from start of line, in bytes</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-visible-line-index" role="function">
<title>gtk_text_iter_get_visible_line_index&#160;()</title>
<indexterm zone="gtk-text-iter-get-visible-line-index"><primary>gtk_text_iter_get_visible_line_index</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_visible_line_index (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the number of bytes from the start of the
line to the given <parameter>iter</parameter>
, not counting bytes that
are invisible due to tags with the “invisible” flag
toggled on.</para>
<refsect3 id="gtk-text-iter-get-visible-line-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-visible-line-index.returns" role="returns">
<title>Returns</title>
<para> byte index of <parameter>iter</parameter>
with respect to the start of the line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-visible-line-offset" role="function">
<title>gtk_text_iter_get_visible_line_offset&#160;()</title>
<indexterm zone="gtk-text-iter-get-visible-line-offset"><primary>gtk_text_iter_get_visible_line_offset</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_visible_line_offset (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the offset in characters from the start of the
line to the given <parameter>iter</parameter>
, not counting characters that
are invisible due to tags with the “invisible” flag
toggled on.</para>
<refsect3 id="gtk-text-iter-get-visible-line-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-visible-line-offset.returns" role="returns">
<title>Returns</title>
<para> offset in visible characters from the start of the line </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-char" role="function">
<title>gtk_text_iter_get_char&#160;()</title>
<indexterm zone="gtk-text-iter-get-char"><primary>gtk_text_iter_get_char</primary></indexterm>
<programlisting language="C"><link linkend="gunichar"><returnvalue>gunichar</returnvalue></link>
gtk_text_iter_get_char (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>The Unicode character at this iterator is returned.  (Equivalent to
operator* on a C++ iterator.)  If the element at this iterator is a
non-character element, such as an image embedded in the buffer, the
Unicode “unknown” character 0xFFFC is returned. If invoked on
the end iterator, zero is returned; zero is not a valid Unicode character.
So you can write a loop which ends when <link linkend="gtk-text-iter-get-char"><function>gtk_text_iter_get_char()</function></link>
returns 0.</para>
<refsect3 id="gtk-text-iter-get-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-char.returns" role="returns">
<title>Returns</title>
<para> a Unicode character, or 0 if <parameter>iter</parameter>
is not dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-slice" role="function">
<title>gtk_text_iter_get_slice&#160;()</title>
<indexterm zone="gtk-text-iter-get-slice"><primary>gtk_text_iter_get_slice</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_text_iter_get_slice (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *start</parameter>,
                         <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *end</parameter>);</programlisting>
<para>Returns the text in the given range. A “slice” is an array of
characters encoded in UTF-8 format, including the Unicode “unknown”
character 0xFFFC for iterable non-character elements in the buffer,
such as images.  Because images are encoded in the slice, byte and
character offsets in the returned array will correspond to byte
offsets in the text buffer. Note that 0xFFFC can occur in normal
text as well, so it is not a reliable indicator that a paintable or
widget is in the buffer.</para>
<refsect3 id="gtk-text-iter-get-slice.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>start</para></entry>
<entry role="parameter_description"><para>iterator at start of a range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end</para></entry>
<entry role="parameter_description"><para>iterator at end of a range</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-slice.returns" role="returns">
<title>Returns</title>
<para>slice of text from the buffer. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-text" role="function">
<title>gtk_text_iter_get_text&#160;()</title>
<indexterm zone="gtk-text-iter-get-text"><primary>gtk_text_iter_get_text</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_text_iter_get_text (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *start</parameter>,
                        <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *end</parameter>);</programlisting>
<para>Returns text in the given range.  If the range
contains non-text elements such as images, the character and byte
offsets in the returned string will not correspond to character and
byte offsets in the buffer. If you want offsets to correspond, see
<link linkend="gtk-text-iter-get-slice"><function>gtk_text_iter_get_slice()</function></link>.</para>
<refsect3 id="gtk-text-iter-get-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>start</para></entry>
<entry role="parameter_description"><para>iterator at start of a range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end</para></entry>
<entry role="parameter_description"><para>iterator at end of a range</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-text.returns" role="returns">
<title>Returns</title>
<para>array of characters from the buffer. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-visible-slice" role="function">
<title>gtk_text_iter_get_visible_slice&#160;()</title>
<indexterm zone="gtk-text-iter-get-visible-slice"><primary>gtk_text_iter_get_visible_slice</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_text_iter_get_visible_slice (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *start</parameter>,
                                 <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *end</parameter>);</programlisting>
<para>Like <link linkend="gtk-text-iter-get-slice"><function>gtk_text_iter_get_slice()</function></link>, but invisible text is not included.
Invisible text is usually invisible because a <link linkend="GtkTextTag"><type>GtkTextTag</type></link> with the
“invisible” attribute turned on has been applied to it.</para>
<refsect3 id="gtk-text-iter-get-visible-slice.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>start</para></entry>
<entry role="parameter_description"><para>iterator at start of range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end</para></entry>
<entry role="parameter_description"><para>iterator at end of range</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-visible-slice.returns" role="returns">
<title>Returns</title>
<para>slice of text from the buffer. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-visible-text" role="function">
<title>gtk_text_iter_get_visible_text&#160;()</title>
<indexterm zone="gtk-text-iter-get-visible-text"><primary>gtk_text_iter_get_visible_text</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_text_iter_get_visible_text (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *start</parameter>,
                                <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *end</parameter>);</programlisting>
<para>Like <link linkend="gtk-text-iter-get-text"><function>gtk_text_iter_get_text()</function></link>, but invisible text is not included.
Invisible text is usually invisible because a <link linkend="GtkTextTag"><type>GtkTextTag</type></link> with the
“invisible” attribute turned on has been applied to it.</para>
<refsect3 id="gtk-text-iter-get-visible-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>start</para></entry>
<entry role="parameter_description"><para>iterator at start of range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end</para></entry>
<entry role="parameter_description"><para>iterator at end of range</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-visible-text.returns" role="returns">
<title>Returns</title>
<para>string containing visible text in the
range. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-marks" role="function">
<title>gtk_text_iter_get_marks&#160;()</title>
<indexterm zone="gtk-text-iter-get-marks"><primary>gtk_text_iter_get_marks</primary></indexterm>
<programlisting language="C"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
gtk_text_iter_get_marks (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns a list of all <link linkend="GtkTextMark"><type>GtkTextMark</type></link> 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.</para>
<refsect3 id="gtk-text-iter-get-marks.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-marks.returns" role="returns">
<title>Returns</title>
<para>list of <link linkend="GtkTextMark"><type>GtkTextMark</type></link>. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> GtkTextMark][<acronym>transfer container</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-toggled-tags" role="function">
<title>gtk_text_iter_get_toggled_tags&#160;()</title>
<indexterm zone="gtk-text-iter-get-toggled-tags"><primary>gtk_text_iter_get_toggled_tags</primary></indexterm>
<programlisting language="C"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
gtk_text_iter_get_toggled_tags (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gboolean"><type>gboolean</type></link> toggled_on</parameter>);</programlisting>
<para>Returns a list of <link linkend="GtkTextTag"><type>GtkTextTag</type></link> that are toggled on or off at this
point.  (If <parameter>toggled_on</parameter>
 is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the list contains tags that are
toggled on.) If a tag is toggled on at <parameter>iter</parameter>
, then some non-empty
range of characters following <parameter>iter</parameter>
 has that tag applied to it.  If
a tag is toggled off, then some non-empty range following <parameter>iter</parameter>

does not have the tag applied to it.</para>
<refsect3 id="gtk-text-iter-get-toggled-tags.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>toggled_on</para></entry>
<entry role="parameter_description"><para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to get toggled-on tags</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-toggled-tags.returns" role="returns">
<title>Returns</title>
<para>tags toggled at this point. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> GtkTextTag][<acronym>transfer container</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-child-anchor" role="function">
<title>gtk_text_iter_get_child_anchor&#160;()</title>
<indexterm zone="gtk-text-iter-get-child-anchor"><primary>gtk_text_iter_get_child_anchor</primary></indexterm>
<programlisting language="C"><link linkend="GtkTextChildAnchor"><returnvalue>GtkTextChildAnchor</returnvalue></link>&#160;*
gtk_text_iter_get_child_anchor (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>If the location at <parameter>iter</parameter>
 contains a child anchor, the
anchor is returned (with no new reference count added). Otherwise,
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
<refsect3 id="gtk-text-iter-get-child-anchor.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-child-anchor.returns" role="returns">
<title>Returns</title>
<para>the anchor at <parameter>iter</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-starts-tag" role="function">
<title>gtk_text_iter_starts_tag&#160;()</title>
<indexterm zone="gtk-text-iter-starts-tag"><primary>gtk_text_iter_starts_tag</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_starts_tag (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                          <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>tag</parameter>
 is toggled on at exactly this point. If <parameter>tag</parameter>

is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if any tag is toggled on at this point.</para>
<para>Note that if <link linkend="gtk-text-iter-starts-tag"><function>gtk_text_iter_starts_tag()</function></link> returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, it means that <parameter>iter</parameter>
 is
at the beginning of the tagged range, and that the
character at <parameter>iter</parameter>
 is inside the tagged range. In other
words, unlike <link linkend="gtk-text-iter-ends-tag"><function>gtk_text_iter_ends_tag()</function></link>, if <link linkend="gtk-text-iter-starts-tag"><function>gtk_text_iter_starts_tag()</function></link> returns
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, <link linkend="gtk-text-iter-has-tag"><function>gtk_text_iter_has_tag()</function></link> will also return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> for the same
parameters.</para>
<refsect3 id="gtk-text-iter-starts-tag.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-starts-tag.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is the start of a range tagged with <parameter>tag</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-ends-tag" role="function">
<title>gtk_text_iter_ends_tag&#160;()</title>
<indexterm zone="gtk-text-iter-ends-tag"><primary>gtk_text_iter_ends_tag</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_ends_tag (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                        <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>tag</parameter>
 is toggled off at exactly this point. If <parameter>tag</parameter>

is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if any tag is toggled off at this point.</para>
<para>Note that if <link linkend="gtk-text-iter-ends-tag"><function>gtk_text_iter_ends_tag()</function></link> returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, it means that <parameter>iter</parameter>
 is
at the end of the tagged range, but that the character
at <parameter>iter</parameter>
 is outside the tagged range. In other words,
unlike <link linkend="gtk-text-iter-starts-tag"><function>gtk_text_iter_starts_tag()</function></link>, if <link linkend="gtk-text-iter-ends-tag"><function>gtk_text_iter_ends_tag()</function></link> returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>,
<link linkend="gtk-text-iter-has-tag"><function>gtk_text_iter_has_tag()</function></link> will return <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> for the same parameters.</para>
<refsect3 id="gtk-text-iter-ends-tag.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-ends-tag.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is the end of a range tagged with <parameter>tag</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-toggles-tag" role="function">
<title>gtk_text_iter_toggles_tag&#160;()</title>
<indexterm zone="gtk-text-iter-toggles-tag"><primary>gtk_text_iter_toggles_tag</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_toggles_tag (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                           <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>This is equivalent to (<link linkend="gtk-text-iter-starts-tag"><function>gtk_text_iter_starts_tag()</function></link> ||
<link linkend="gtk-text-iter-ends-tag"><function>gtk_text_iter_ends_tag()</function></link>), i.e. it tells you whether a range with
<parameter>tag</parameter>
 applied to it begins or ends at <parameter>iter</parameter>
.</para>
<refsect3 id="gtk-text-iter-toggles-tag.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-toggles-tag.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>tag</parameter>
is toggled on or off at <parameter>iter</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-has-tag" role="function">
<title>gtk_text_iter_has_tag&#160;()</title>
<indexterm zone="gtk-text-iter-has-tag"><primary>gtk_text_iter_has_tag</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_has_tag (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                       <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
 points to a character that is part of a range tagged
with <parameter>tag</parameter>
. See also <link linkend="gtk-text-iter-starts-tag"><function>gtk_text_iter_starts_tag()</function></link> and <link linkend="gtk-text-iter-ends-tag"><function>gtk_text_iter_ends_tag()</function></link>.</para>
<refsect3 id="gtk-text-iter-has-tag.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-has-tag.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is tagged with <parameter>tag</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-tags" role="function">
<title>gtk_text_iter_get_tags&#160;()</title>
<indexterm zone="gtk-text-iter-get-tags"><primary>gtk_text_iter_get_tags</primary></indexterm>
<programlisting language="C"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
gtk_text_iter_get_tags (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns a list of tags that apply to <parameter>iter</parameter>
, in ascending order of
priority (highest-priority tags are last). The <link linkend="GtkTextTag"><type>GtkTextTag</type></link> in the
list don’t have a reference added, but you have to free the list
itself.</para>
<refsect3 id="gtk-text-iter-get-tags.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-tags.returns" role="returns">
<title>Returns</title>
<para>list of <link linkend="GtkTextTag"><type>GtkTextTag</type></link>. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> GtkTextTag][<acronym>transfer container</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-editable" role="function">
<title>gtk_text_iter_editable&#160;()</title>
<indexterm zone="gtk-text-iter-editable"><primary>gtk_text_iter_editable</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_editable (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                        <parameter><link linkend="gboolean"><type>gboolean</type></link> default_setting</parameter>);</programlisting>
<para>Returns whether the character at <parameter>iter</parameter>
 is within an editable region
of text.  Non-editable text is “locked” and can’t be changed by the
user via <link linkend="GtkTextView"><type>GtkTextView</type></link>. This function is simply a convenience
wrapper around <link linkend="gtk-text-iter-get-attributes"><function>gtk_text_iter_get_attributes()</function></link>. If no tags applied
to this text affect editability, <parameter>default_setting</parameter>
 will be returned.</para>
<para>You don’t want to use this function to decide whether text can be
inserted at <parameter>iter</parameter>
, because for insertion you don’t want to know
whether the char at <parameter>iter</parameter>
 is inside an editable range, you want to
know whether a new character inserted at <parameter>iter</parameter>
 would be inside an
editable range. Use <link linkend="gtk-text-iter-can-insert"><function>gtk_text_iter_can_insert()</function></link> to handle this
case.</para>
<refsect3 id="gtk-text-iter-editable.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>default_setting</para></entry>
<entry role="parameter_description"><para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if text is editable by default</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-editable.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is inside an editable range</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-can-insert" role="function">
<title>gtk_text_iter_can_insert&#160;()</title>
<indexterm zone="gtk-text-iter-can-insert"><primary>gtk_text_iter_can_insert</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_can_insert (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                          <parameter><link linkend="gboolean"><type>gboolean</type></link> default_editability</parameter>);</programlisting>
<para>Considering the default editability of the buffer, and tags that
affect editability, determines whether text inserted at <parameter>iter</parameter>
 would
be editable. If text inserted at <parameter>iter</parameter>
 would be editable then the
user should be allowed to insert text at <parameter>iter</parameter>
.
<link linkend="gtk-text-buffer-insert-interactive"><function>gtk_text_buffer_insert_interactive()</function></link> uses this function to decide
whether insertions are allowed at a given position.</para>
<refsect3 id="gtk-text-iter-can-insert.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>default_editability</para></entry>
<entry role="parameter_description"><para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if text is editable by default</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-can-insert.returns" role="returns">
<title>Returns</title>
<para> whether text inserted at <parameter>iter</parameter>
would be editable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-starts-word" role="function">
<title>gtk_text_iter_starts_word&#160;()</title>
<indexterm zone="gtk-text-iter-starts-word"><primary>gtk_text_iter_starts_word</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_starts_word (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 begins a natural-language word.  Word
breaks are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-starts-word.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-starts-word.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is at the start of a word</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-ends-word" role="function">
<title>gtk_text_iter_ends_word&#160;()</title>
<indexterm zone="gtk-text-iter-ends-word"><primary>gtk_text_iter_ends_word</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_ends_word (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 ends a natural-language word.  Word breaks
are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-ends-word.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-ends-word.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is at the end of a word</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-inside-word" role="function">
<title>gtk_text_iter_inside_word&#160;()</title>
<indexterm zone="gtk-text-iter-inside-word"><primary>gtk_text_iter_inside_word</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_inside_word (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether the character pointed by <parameter>iter</parameter>
 is part of a
natural-language word (as opposed to say inside some whitespace).  Word
breaks are determined by Pango and should be correct for nearly any language
(if not, the correct fix would be to the Pango word break algorithms).</para>
<para>Note that if <link linkend="gtk-text-iter-starts-word"><function>gtk_text_iter_starts_word()</function></link> returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, then this function
returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> too, since <parameter>iter</parameter>
 points to the first character of the word.</para>
<refsect3 id="gtk-text-iter-inside-word.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-inside-word.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is inside a word</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-starts-line" role="function">
<title>gtk_text_iter_starts_line&#160;()</title>
<indexterm zone="gtk-text-iter-starts-line"><primary>gtk_text_iter_starts_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_starts_line (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
 begins a paragraph,
i.e. if <link linkend="gtk-text-iter-get-line-offset"><function>gtk_text_iter_get_line_offset()</function></link> would return 0.
However this function is potentially more efficient than
<link linkend="gtk-text-iter-get-line-offset"><function>gtk_text_iter_get_line_offset()</function></link> because it doesn’t have to compute
the offset, it just has to see whether it’s 0.</para>
<refsect3 id="gtk-text-iter-starts-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-starts-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
begins a line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-ends-line" role="function">
<title>gtk_text_iter_ends_line&#160;()</title>
<indexterm zone="gtk-text-iter-ends-line"><primary>gtk_text_iter_ends_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_ends_line (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
 points to the start of the paragraph
delimiter characters for a line (delimiters will be either a
newline, a carriage return, a carriage return followed by a
newline, or a Unicode paragraph separator character). Note that an
iterator pointing to the \n of a \r\n pair will not be counted as
the end of a line, the line ends before the \r. The end iterator is
considered to be at the end of a line, even though there are no
paragraph delimiter chars there.</para>
<refsect3 id="gtk-text-iter-ends-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-ends-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is at the end of a line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-starts-sentence" role="function">
<title>gtk_text_iter_starts_sentence&#160;()</title>
<indexterm zone="gtk-text-iter-starts-sentence"><primary>gtk_text_iter_starts_sentence</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_starts_sentence (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 begins a sentence.  Sentence boundaries are
determined by Pango and should be correct for nearly any language
(if not, the correct fix would be to the Pango text boundary
algorithms).</para>
<refsect3 id="gtk-text-iter-starts-sentence.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-starts-sentence.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is at the start of a sentence.</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-ends-sentence" role="function">
<title>gtk_text_iter_ends_sentence&#160;()</title>
<indexterm zone="gtk-text-iter-ends-sentence"><primary>gtk_text_iter_ends_sentence</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_ends_sentence (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 ends a sentence.  Sentence boundaries are
determined by Pango and should be correct for nearly any language
(if not, the correct fix would be to the Pango text boundary
algorithms).</para>
<refsect3 id="gtk-text-iter-ends-sentence.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-ends-sentence.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is at the end of a sentence.</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-inside-sentence" role="function">
<title>gtk_text_iter_inside_sentence&#160;()</title>
<indexterm zone="gtk-text-iter-inside-sentence"><primary>gtk_text_iter_inside_sentence</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_inside_sentence (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 is inside a sentence (as opposed to in
between two sentences, e.g. after a period and before the first
letter of the next sentence).  Sentence boundaries are determined
by Pango and should be correct for nearly any language (if not, the
correct fix would be to the Pango text boundary algorithms).</para>
<refsect3 id="gtk-text-iter-inside-sentence.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-inside-sentence.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is inside a sentence.</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-is-cursor-position" role="function">
<title>gtk_text_iter_is_cursor_position&#160;()</title>
<indexterm zone="gtk-text-iter-is-cursor-position"><primary>gtk_text_iter_is_cursor_position</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_is_cursor_position (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>See <link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link> or <link linkend="PangoLogAttr"><type>PangoLogAttr</type></link> or
<link linkend="pango-break"><function>pango_break()</function></link> for details on what a cursor position is.</para>
<refsect3 id="gtk-text-iter-is-cursor-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-is-cursor-position.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the cursor can be placed at <parameter>iter</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-chars-in-line" role="function">
<title>gtk_text_iter_get_chars_in_line&#160;()</title>
<indexterm zone="gtk-text-iter-get-chars-in-line"><primary>gtk_text_iter_get_chars_in_line</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_chars_in_line (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the number of characters in the line containing <parameter>iter</parameter>
,
including the paragraph delimiters.</para>
<refsect3 id="gtk-text-iter-get-chars-in-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-chars-in-line.returns" role="returns">
<title>Returns</title>
<para> number of characters in the line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-bytes-in-line" role="function">
<title>gtk_text_iter_get_bytes_in_line&#160;()</title>
<indexterm zone="gtk-text-iter-get-bytes-in-line"><primary>gtk_text_iter_get_bytes_in_line</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_get_bytes_in_line (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns the number of bytes in the line containing <parameter>iter</parameter>
,
including the paragraph delimiters.</para>
<refsect3 id="gtk-text-iter-get-bytes-in-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-bytes-in-line.returns" role="returns">
<title>Returns</title>
<para> number of bytes in the line</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-get-language" role="function">
<title>gtk_text_iter_get_language&#160;()</title>
<indexterm zone="gtk-text-iter-get-language"><primary>gtk_text_iter_get_language</primary></indexterm>
<programlisting language="C"><link linkend="PangoLanguage"><returnvalue>PangoLanguage</returnvalue></link>&#160;*
gtk_text_iter_get_language (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>A convenience wrapper around <link linkend="gtk-text-iter-get-attributes"><function>gtk_text_iter_get_attributes()</function></link>,
which returns the language in effect at <parameter>iter</parameter>
. If no tags affecting
language apply to <parameter>iter</parameter>
, the return value is identical to that of
<link linkend="gtk-get-default-language"><function>gtk_get_default_language()</function></link>.</para>
<refsect3 id="gtk-text-iter-get-language.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-get-language.returns" role="returns">
<title>Returns</title>
<para>language in effect at <parameter>iter</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-is-end" role="function">
<title>gtk_text_iter_is_end&#160;()</title>
<indexterm zone="gtk-text-iter-is-end"><primary>gtk_text_iter_is_end</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_is_end (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
 is the end iterator, i.e. one past the last
dereferenceable iterator in the buffer. <link linkend="gtk-text-iter-is-end"><function>gtk_text_iter_is_end()</function></link> is
the most efficient way to check whether an iterator is the end
iterator.</para>
<refsect3 id="gtk-text-iter-is-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-is-end.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-is-start" role="function">
<title>gtk_text_iter_is_start&#160;()</title>
<indexterm zone="gtk-text-iter-is-start"><primary>gtk_text_iter_is_start</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_is_start (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
 is the first iterator in the buffer, that is
if <parameter>iter</parameter>
 has a character offset of 0.</para>
<refsect3 id="gtk-text-iter-is-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-is-start.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
is the first in the buffer</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-char" role="function">
<title>gtk_text_iter_forward_char&#160;()</title>
<indexterm zone="gtk-text-iter-forward-char"><primary>gtk_text_iter_forward_char</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_char (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward by one character offset. Note that images
embedded in the buffer occupy 1 character slot, so
<link linkend="gtk-text-iter-forward-char"><function>gtk_text_iter_forward_char()</function></link> may actually move onto an image instead
of a character, if you have images in your buffer.  If <parameter>iter</parameter>
 is the
end iterator or one character before it, <parameter>iter</parameter>
 will now point at
the end iterator, and <link linkend="gtk-text-iter-forward-char"><function>gtk_text_iter_forward_char()</function></link> returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> for
convenience when writing loops.</para>
<refsect3 id="gtk-text-iter-forward-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-char.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-char" role="function">
<title>gtk_text_iter_backward_char&#160;()</title>
<indexterm zone="gtk-text-iter-backward-char"><primary>gtk_text_iter_backward_char</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_char (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves backward by one character offset. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if movement
was possible; if <parameter>iter</parameter>
 was the first in the buffer (character
offset 0), <link linkend="gtk-text-iter-backward-char"><function>gtk_text_iter_backward_char()</function></link> returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> for convenience when
writing loops.</para>
<refsect3 id="gtk-text-iter-backward-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-char.returns" role="returns">
<title>Returns</title>
<para> whether movement was possible</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-chars" role="function">
<title>gtk_text_iter_forward_chars&#160;()</title>
<indexterm zone="gtk-text-iter-forward-chars"><primary>gtk_text_iter_forward_chars</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_chars (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                             <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 characters if possible (if <parameter>count</parameter>
 would move past the
start or end of the buffer, moves to the start or end of the
buffer). The return value indicates whether the new position of
<parameter>iter</parameter>
 is different from its original position, and dereferenceable
(the last iterator in the buffer is not dereferenceable). If <parameter>count</parameter>

is 0, the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="gtk-text-iter-forward-chars.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of characters to move, may be negative</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-chars.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-chars" role="function">
<title>gtk_text_iter_backward_chars&#160;()</title>
<indexterm zone="gtk-text-iter-backward-chars"><primary>gtk_text_iter_backward_chars</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_chars (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 characters backward, if possible (if <parameter>count</parameter>
 would move
past the start or end of the buffer, moves to the start or end of
the buffer).  The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned. If <parameter>count</parameter>
 is 0,
the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="gtk-text-iter-backward-chars.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of characters to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-chars.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-line" role="function">
<title>gtk_text_iter_forward_line&#160;()</title>
<indexterm zone="gtk-text-iter-forward-line"><primary>gtk_text_iter_forward_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_line (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 to the start of the next line. If the iter is already on the
last line of the buffer, moves the iter to the end of the current line.
If after the operation, the iter is at the end of the buffer and not
dereferencable, returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. Otherwise, returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<refsect3 id="gtk-text-iter-forward-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
can be dereferenced</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-line" role="function">
<title>gtk_text_iter_backward_line&#160;()</title>
<indexterm zone="gtk-text-iter-backward-line"><primary>gtk_text_iter_backward_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_line (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 to the start of the previous line. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if
<parameter>iter</parameter>
 could be moved; i.e. if <parameter>iter</parameter>
 was at character offset 0, this
function returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. Therefore if <parameter>iter</parameter>
 was already on line 0,
but not at the start of the line, <parameter>iter</parameter>
 is snapped to the start of
the line and the function returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. (Note that this implies that
in a loop calling this function, the line number may not change on
every iteration, if your first iteration is on line 0.)</para>
<refsect3 id="gtk-text-iter-backward-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-lines" role="function">
<title>gtk_text_iter_forward_lines&#160;()</title>
<indexterm zone="gtk-text-iter-forward-lines"><primary>gtk_text_iter_forward_lines</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_lines (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                             <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 lines forward, if possible (if <parameter>count</parameter>
 would move
past the start or end of the buffer, moves to the start or end of
the buffer).  The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned. If <parameter>count</parameter>
 is 0,
the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. If <parameter>count</parameter>
 is negative,
moves backward by 0 - <parameter>count</parameter>
 lines.</para>
<refsect3 id="gtk-text-iter-forward-lines.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of lines to move forward</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-lines.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-lines" role="function">
<title>gtk_text_iter_backward_lines&#160;()</title>
<indexterm zone="gtk-text-iter-backward-lines"><primary>gtk_text_iter_backward_lines</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_lines (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 lines backward, if possible (if <parameter>count</parameter>
 would move
past the start or end of the buffer, moves to the start or end of
the buffer).  The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned. If <parameter>count</parameter>
 is 0,
the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. If <parameter>count</parameter>
 is negative,
moves forward by 0 - <parameter>count</parameter>
 lines.</para>
<refsect3 id="gtk-text-iter-backward-lines.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of lines to move backward</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-lines.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-word-ends" role="function">
<title>gtk_text_iter_forward_word_ends&#160;()</title>
<indexterm zone="gtk-text-iter-forward-word-ends"><primary>gtk_text_iter_forward_word_ends</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_word_ends (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                 <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-forward-word-end"><function>gtk_text_iter_forward_word_end()</function></link> up to <parameter>count</parameter>
 times.</para>
<refsect3 id="gtk-text-iter-forward-word-ends.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of times to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-word-ends.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-word-starts" role="function">
<title>gtk_text_iter_backward_word_starts&#160;()</title>
<indexterm zone="gtk-text-iter-backward-word-starts"><primary>gtk_text_iter_backward_word_starts</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_word_starts (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                    <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-backward-word-start"><function>gtk_text_iter_backward_word_start()</function></link> up to <parameter>count</parameter>
 times.</para>
<refsect3 id="gtk-text-iter-backward-word-starts.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of times to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-word-starts.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-word-end" role="function">
<title>gtk_text_iter_forward_word_end&#160;()</title>
<indexterm zone="gtk-text-iter-forward-word-end"><primary>gtk_text_iter_forward_word_end</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_word_end (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves forward to the next word end. (If <parameter>iter</parameter>
 is currently on a
word end, moves forward to the next one after that.) Word breaks
are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-forward-word-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-word-end.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-word-start" role="function">
<title>gtk_text_iter_backward_word_start&#160;()</title>
<indexterm zone="gtk-text-iter-backward-word-start"><primary>gtk_text_iter_backward_word_start</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_word_start (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves backward to the previous word start. (If <parameter>iter</parameter>
 is currently on a
word start, moves backward to the next one after that.) Word breaks
are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-backward-word-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-word-start.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-cursor-position" role="function">
<title>gtk_text_iter_forward_cursor_position&#160;()</title>
<indexterm zone="gtk-text-iter-forward-cursor-position"><primary>gtk_text_iter_forward_cursor_position</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_cursor_position (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward by a single cursor position. Cursor positions
are (unsurprisingly) positions where the cursor can appear. Perhaps
surprisingly, there may not be a cursor position between all
characters. The most common example for European languages would be
a carriage return/newline sequence. For some Unicode characters,
the equivalent of say the letter “a” with an accent mark will be
represented as two characters, first the letter then a "combining
mark" that causes the accent to be rendered; so the cursor can’t go
between those two characters. See also the <link linkend="PangoLogAttr-struct"><type>PangoLogAttr</type></link> and
<link linkend="pango-break"><function>pango_break()</function></link> function.</para>
<refsect3 id="gtk-text-iter-forward-cursor-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-cursor-position.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-cursor-position" role="function">
<title>gtk_text_iter_backward_cursor_position&#160;()</title>
<indexterm zone="gtk-text-iter-backward-cursor-position"><primary>gtk_text_iter_backward_cursor_position</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_cursor_position
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Like <link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link>, but moves backward.</para>
<refsect3 id="gtk-text-iter-backward-cursor-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-cursor-position.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-cursor-positions" role="function">
<title>gtk_text_iter_forward_cursor_positions&#160;()</title>
<indexterm zone="gtk-text-iter-forward-cursor-positions"><primary>gtk_text_iter_forward_cursor_positions</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_cursor_positions
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves up to <parameter>count</parameter>
 cursor positions. See
<link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-forward-cursor-positions.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of positions to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-cursor-positions.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-cursor-positions" role="function">
<title>gtk_text_iter_backward_cursor_positions&#160;()</title>
<indexterm zone="gtk-text-iter-backward-cursor-positions"><primary>gtk_text_iter_backward_cursor_positions</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_cursor_positions
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves up to <parameter>count</parameter>
 cursor positions. See
<link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-backward-cursor-positions.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of positions to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-cursor-positions.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-sentence-start" role="function">
<title>gtk_text_iter_backward_sentence_start&#160;()</title>
<indexterm zone="gtk-text-iter-backward-sentence-start"><primary>gtk_text_iter_backward_sentence_start</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_sentence_start (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves backward to the previous sentence start; if <parameter>iter</parameter>
 is already at
the start of a sentence, moves backward to the next one.  Sentence
boundaries are determined by Pango and should be correct for nearly
any language (if not, the correct fix would be to the Pango text
boundary algorithms).</para>
<refsect3 id="gtk-text-iter-backward-sentence-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-sentence-start.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-sentence-starts" role="function">
<title>gtk_text_iter_backward_sentence_starts&#160;()</title>
<indexterm zone="gtk-text-iter-backward-sentence-starts"><primary>gtk_text_iter_backward_sentence_starts</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_sentence_starts
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-backward-sentence-start"><function>gtk_text_iter_backward_sentence_start()</function></link> up to <parameter>count</parameter>
 times,
or until it returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. If <parameter>count</parameter>
 is negative, moves forward
instead of backward.</para>
<refsect3 id="gtk-text-iter-backward-sentence-starts.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of sentences to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-sentence-starts.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-sentence-end" role="function">
<title>gtk_text_iter_forward_sentence_end&#160;()</title>
<indexterm zone="gtk-text-iter-forward-sentence-end"><primary>gtk_text_iter_forward_sentence_end</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_sentence_end (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves forward to the next sentence end. (If <parameter>iter</parameter>
 is at the end of
a sentence, moves to the next end of sentence.)  Sentence
boundaries are determined by Pango and should be correct for nearly
any language (if not, the correct fix would be to the Pango text
boundary algorithms).</para>
<refsect3 id="gtk-text-iter-forward-sentence-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-sentence-end.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-sentence-ends" role="function">
<title>gtk_text_iter_forward_sentence_ends&#160;()</title>
<indexterm zone="gtk-text-iter-forward-sentence-ends"><primary>gtk_text_iter_forward_sentence_ends</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_sentence_ends (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                     <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-forward-sentence-end"><function>gtk_text_iter_forward_sentence_end()</function></link> <parameter>count</parameter>
 times (or until
<link linkend="gtk-text-iter-forward-sentence-end"><function>gtk_text_iter_forward_sentence_end()</function></link> returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>). If <parameter>count</parameter>
 is
negative, moves backward instead of forward.</para>
<refsect3 id="gtk-text-iter-forward-sentence-ends.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of sentences to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-sentence-ends.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-word-ends" role="function">
<title>gtk_text_iter_forward_visible_word_ends&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-word-ends"><primary>gtk_text_iter_forward_visible_word_ends</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_word_ends
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-forward-visible-word-end"><function>gtk_text_iter_forward_visible_word_end()</function></link> up to <parameter>count</parameter>
 times.</para>
<refsect3 id="gtk-text-iter-forward-visible-word-ends.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of times to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-word-ends.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-word-starts" role="function">
<title>gtk_text_iter_backward_visible_word_starts&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-word-starts"><primary>gtk_text_iter_backward_visible_word_starts</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_word_starts
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Calls <link linkend="gtk-text-iter-backward-visible-word-start"><function>gtk_text_iter_backward_visible_word_start()</function></link> up to <parameter>count</parameter>
 times.</para>
<refsect3 id="gtk-text-iter-backward-visible-word-starts.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of times to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-word-starts.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-word-end" role="function">
<title>gtk_text_iter_forward_visible_word_end&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-word-end"><primary>gtk_text_iter_forward_visible_word_end</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_word_end
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves forward to the next visible word end. (If <parameter>iter</parameter>
 is currently on a
word end, moves forward to the next one after that.) Word breaks
are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-forward-visible-word-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-word-end.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-word-start" role="function">
<title>gtk_text_iter_backward_visible_word_start&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-word-start"><primary>gtk_text_iter_backward_visible_word_start</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_word_start
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves backward to the previous visible word start. (If <parameter>iter</parameter>
 is currently 
on a word start, moves backward to the next one after that.) Word breaks
are determined by Pango and should be correct for nearly any
language (if not, the correct fix would be to the Pango word break
algorithms).</para>
<refsect3 id="gtk-text-iter-backward-visible-word-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-word-start.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
moved and is not the end iterator </para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-cursor-position" role="function">
<title>gtk_text_iter_forward_visible_cursor_position&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-cursor-position"><primary>gtk_text_iter_forward_visible_cursor_position</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_cursor_position
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the next visible cursor position. See 
<link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-forward-visible-cursor-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-cursor-position.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-cursor-position" role="function">
<title>gtk_text_iter_backward_visible_cursor_position&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-cursor-position"><primary>gtk_text_iter_backward_visible_cursor_position</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_cursor_position
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the previous visible cursor position. See 
<link linkend="gtk-text-iter-backward-cursor-position"><function>gtk_text_iter_backward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-backward-visible-cursor-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-cursor-position.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-cursor-positions" role="function">
<title>gtk_text_iter_forward_visible_cursor_positions&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-cursor-positions"><primary>gtk_text_iter_forward_visible_cursor_positions</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_cursor_positions
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves up to <parameter>count</parameter>
 visible cursor positions. See
<link linkend="gtk-text-iter-forward-cursor-position"><function>gtk_text_iter_forward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-forward-visible-cursor-positions.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of positions to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-cursor-positions.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-cursor-positions" role="function">
<title>gtk_text_iter_backward_visible_cursor_positions&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-cursor-positions"><primary>gtk_text_iter_backward_visible_cursor_positions</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_cursor_positions
                               (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves up to <parameter>count</parameter>
 visible cursor positions. See
<link linkend="gtk-text-iter-backward-cursor-position"><function>gtk_text_iter_backward_cursor_position()</function></link> for details.</para>
<refsect3 id="gtk-text-iter-backward-visible-cursor-positions.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of positions to move</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-cursor-positions.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new position is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-line" role="function">
<title>gtk_text_iter_forward_visible_line&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-line"><primary>gtk_text_iter_forward_visible_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_line (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 to the start of the next visible line. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there
was a next line to move to, and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if <parameter>iter</parameter>
 was simply moved to
the end of the buffer and is now not dereferenceable, or if <parameter>iter</parameter>
 was
already at the end of the buffer.</para>
<refsect3 id="gtk-text-iter-forward-visible-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
can be dereferenced</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-line" role="function">
<title>gtk_text_iter_backward_visible_line&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-line"><primary>gtk_text_iter_backward_visible_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_line (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 to the start of the previous visible line. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if
<parameter>iter</parameter>
 could be moved; i.e. if <parameter>iter</parameter>
 was at character offset 0, this
function returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. Therefore if <parameter>iter</parameter>
 was already on line 0,
but not at the start of the line, <parameter>iter</parameter>
 is snapped to the start of
the line and the function returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. (Note that this implies that
in a loop calling this function, the line number may not change on
every iteration, if your first iteration is on line 0.)</para>
<refsect3 id="gtk-text-iter-backward-visible-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>an iterator</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-line.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-visible-lines" role="function">
<title>gtk_text_iter_forward_visible_lines&#160;()</title>
<indexterm zone="gtk-text-iter-forward-visible-lines"><primary>gtk_text_iter_forward_visible_lines</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_visible_lines (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                     <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 visible lines forward, if possible (if <parameter>count</parameter>
 would move
past the start or end of the buffer, moves to the start or end of
the buffer).  The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned. If <parameter>count</parameter>
 is 0,
the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. If <parameter>count</parameter>
 is negative,
moves backward by 0 - <parameter>count</parameter>
 lines.</para>
<refsect3 id="gtk-text-iter-forward-visible-lines.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of lines to move forward</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-visible-lines.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-visible-lines" role="function">
<title>gtk_text_iter_backward_visible_lines&#160;()</title>
<indexterm zone="gtk-text-iter-backward-visible-lines"><primary>gtk_text_iter_backward_visible_lines</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_visible_lines (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                      <parameter><link linkend="gint"><type>gint</type></link> count</parameter>);</programlisting>
<para>Moves <parameter>count</parameter>
 visible lines backward, if possible (if <parameter>count</parameter>
 would move
past the start or end of the buffer, moves to the start or end of
the buffer).  The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned. If <parameter>count</parameter>
 is 0,
the function does nothing and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. If <parameter>count</parameter>
 is negative,
moves forward by 0 - <parameter>count</parameter>
 lines.</para>
<refsect3 id="gtk-text-iter-backward-visible-lines.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>count</para></entry>
<entry role="parameter_description"><para>number of lines to move backward</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-visible-lines.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>iter</parameter>
moved and is dereferenceable</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-offset" role="function">
<title>gtk_text_iter_set_offset&#160;()</title>
<indexterm zone="gtk-text-iter-set-offset"><primary>gtk_text_iter_set_offset</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_offset (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                          <parameter><link linkend="gint"><type>gint</type></link> char_offset</parameter>);</programlisting>
<para>Sets <parameter>iter</parameter>
 to point to <parameter>char_offset</parameter>
. <parameter>char_offset</parameter>
 counts from the start
of the entire text buffer, starting with 0.</para>
<refsect3 id="gtk-text-iter-set-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>char_offset</para></entry>
<entry role="parameter_description"><para>a character number</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-line" role="function">
<title>gtk_text_iter_set_line&#160;()</title>
<indexterm zone="gtk-text-iter-set-line"><primary>gtk_text_iter_set_line</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_line (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                        <parameter><link linkend="gint"><type>gint</type></link> line_number</parameter>);</programlisting>
<para>Moves iterator <parameter>iter</parameter>
 to the start of the line <parameter>line_number</parameter>
.  If
<parameter>line_number</parameter>
 is negative or larger than the number of lines in the
buffer, moves <parameter>iter</parameter>
 to the start of the last line in the buffer.</para>
<refsect3 id="gtk-text-iter-set-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>line_number</para></entry>
<entry role="parameter_description"><para>line number (counted from 0)</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-line-offset" role="function">
<title>gtk_text_iter_set_line_offset&#160;()</title>
<indexterm zone="gtk-text-iter-set-line-offset"><primary>gtk_text_iter_set_line_offset</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_line_offset (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                               <parameter><link linkend="gint"><type>gint</type></link> char_on_line</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 within a line, to a new character
(not byte) offset. The given character offset must be less than or
equal to the number of characters in the line; if equal, <parameter>iter</parameter>

moves to the start of the next line. See
<link linkend="gtk-text-iter-set-line-index"><function>gtk_text_iter_set_line_index()</function></link> if you have a byte index rather than
a character offset.</para>
<refsect3 id="gtk-text-iter-set-line-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link> </para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>char_on_line</para></entry>
<entry role="parameter_description"><para>a character offset relative to the start of <parameter>iter</parameter>
’s current line</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-line-index" role="function">
<title>gtk_text_iter_set_line_index&#160;()</title>
<indexterm zone="gtk-text-iter-set-line-index"><primary>gtk_text_iter_set_line_index</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_line_index (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> byte_on_line</parameter>);</programlisting>
<para>Same as <link linkend="gtk-text-iter-set-line-offset"><function>gtk_text_iter_set_line_offset()</function></link>, but works with a
byte index. The given byte index must be at
the start of a character, it can’t be in the middle of a UTF-8
encoded character.</para>
<refsect3 id="gtk-text-iter-set-line-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>byte_on_line</para></entry>
<entry role="parameter_description"><para>a byte index relative to the start of <parameter>iter</parameter>
’s current line</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-visible-line-index" role="function">
<title>gtk_text_iter_set_visible_line_index&#160;()</title>
<indexterm zone="gtk-text-iter-set-visible-line-index"><primary>gtk_text_iter_set_visible_line_index</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_visible_line_index (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                      <parameter><link linkend="gint"><type>gint</type></link> byte_on_line</parameter>);</programlisting>
<para>Like <link linkend="gtk-text-iter-set-line-index"><function>gtk_text_iter_set_line_index()</function></link>, but the index is in visible
bytes, i.e. text with a tag making it invisible is not counted
in the index.</para>
<refsect3 id="gtk-text-iter-set-visible-line-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>byte_on_line</para></entry>
<entry role="parameter_description"><para>a byte index</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-set-visible-line-offset" role="function">
<title>gtk_text_iter_set_visible_line_offset&#160;()</title>
<indexterm zone="gtk-text-iter-set-visible-line-offset"><primary>gtk_text_iter_set_visible_line_offset</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_set_visible_line_offset (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                       <parameter><link linkend="gint"><type>gint</type></link> char_on_line</parameter>);</programlisting>
<para>Like <link linkend="gtk-text-iter-set-line-offset"><function>gtk_text_iter_set_line_offset()</function></link>, but the offset is in visible
characters, i.e. text with a tag making it invisible is not
counted in the offset.</para>
<refsect3 id="gtk-text-iter-set-visible-line-offset.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>char_on_line</para></entry>
<entry role="parameter_description"><para>a character offset</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-to-end" role="function">
<title>gtk_text_iter_forward_to_end&#160;()</title>
<indexterm zone="gtk-text-iter-forward-to-end"><primary>gtk_text_iter_forward_to_end</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_forward_to_end (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the “end iterator,” which points one past the last
valid character in the buffer. <link linkend="gtk-text-iter-get-char"><function>gtk_text_iter_get_char()</function></link> called on the
end iterator returns 0, which is convenient for writing loops.</para>
<refsect3 id="gtk-text-iter-forward-to-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-to-line-end" role="function">
<title>gtk_text_iter_forward_to_line_end&#160;()</title>
<indexterm zone="gtk-text-iter-forward-to-line-end"><primary>gtk_text_iter_forward_to_line_end</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_to_line_end (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>);</programlisting>
<para>Moves the iterator to point to the paragraph delimiter characters,
which will be either a newline, a carriage return, a carriage
return/newline in sequence, or the Unicode paragraph separator
character. If the iterator is already at the paragraph delimiter
characters, moves to the paragraph delimiter characters for the
next line. If <parameter>iter</parameter>
 is on the last line in the buffer, which does
not end in paragraph delimiters, moves to the end iterator (end of
the last line), and returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="gtk-text-iter-forward-to-line-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-to-line-end.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we moved and the new location is not the end iterator</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-to-tag-toggle" role="function">
<title>gtk_text_iter_forward_to_tag_toggle&#160;()</title>
<indexterm zone="gtk-text-iter-forward-to-tag-toggle"><primary>gtk_text_iter_forward_to_tag_toggle</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_to_tag_toggle (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                     <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>Moves forward to the next toggle (on or off) of the
<link linkend="GtkTextTag"><type>GtkTextTag</type></link> <parameter>tag</parameter>
, or to the next toggle of any tag if
<parameter>tag</parameter>
 is <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If no matching tag toggles are found,
returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, otherwise <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. Does not return toggles
located at <parameter>iter</parameter>
, only toggles after <parameter>iter</parameter>
. Sets <parameter>iter</parameter>
 to
the location of the toggle, or to the end of the buffer
if no toggle is found.</para>
<refsect3 id="gtk-text-iter-forward-to-tag-toggle.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-to-tag-toggle.returns" role="returns">
<title>Returns</title>
<para> whether we found a tag toggle after <parameter>iter</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-to-tag-toggle" role="function">
<title>gtk_text_iter_backward_to_tag_toggle&#160;()</title>
<indexterm zone="gtk-text-iter-backward-to-tag-toggle"><primary>gtk_text_iter_backward_to_tag_toggle</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_to_tag_toggle (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                      <parameter><link linkend="GtkTextTag"><type>GtkTextTag</type></link> *tag</parameter>);</programlisting>
<para>Moves backward to the next toggle (on or off) of the
<link linkend="GtkTextTag"><type>GtkTextTag</type></link> <parameter>tag</parameter>
, or to the next toggle of any tag if
<parameter>tag</parameter>
 is <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If no matching tag toggles are found,
returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, otherwise <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. Does not return toggles
located at <parameter>iter</parameter>
, only toggles before <parameter>iter</parameter>
. Sets <parameter>iter</parameter>

to the location of the toggle, or the start of the buffer
if no toggle is found.</para>
<refsect3 id="gtk-text-iter-backward-to-tag-toggle.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tag</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextTag"><type>GtkTextTag</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-to-tag-toggle.returns" role="returns">
<title>Returns</title>
<para> whether we found a tag toggle before <parameter>iter</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="GtkTextCharPredicate" role="function">
<title>GtkTextCharPredicate&#160;()</title>
<indexterm zone="GtkTextCharPredicate"><primary>GtkTextCharPredicate</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
<phrase role="c_punctuation">(</phrase>*GtkTextCharPredicate<phrase role="c_punctuation">)</phrase> (<parameter><link linkend="gunichar"><type>gunichar</type></link> ch</parameter>,
                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
</refsect2>
<refsect2 id="gtk-text-iter-forward-find-char" role="function">
<title>gtk_text_iter_forward_find_char&#160;()</title>
<indexterm zone="gtk-text-iter-forward-find-char"><primary>gtk_text_iter_forward_find_char</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_find_char (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                 <parameter><link linkend="GtkTextCharPredicate"><type>GtkTextCharPredicate</type></link> pred</parameter>,
                                 <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>,
                                 <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *limit</parameter>);</programlisting>
<para>Advances <parameter>iter</parameter>
, calling <parameter>pred</parameter>
 on each character. If
<parameter>pred</parameter>
 returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> and stops scanning.
If <parameter>pred</parameter>
 never returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, <parameter>iter</parameter>
 is set to <parameter>limit</parameter>
 if
<parameter>limit</parameter>
 is non-<link linkend="NULL:CAPS"><literal>NULL</literal></link>, otherwise to the end iterator.</para>
<refsect3 id="gtk-text-iter-forward-find-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>pred</para></entry>
<entry role="parameter_description"><para>a function to be called on each character. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>scope call</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>user_data</para></entry>
<entry role="parameter_description"><para>user data for <parameter>pred</parameter>
. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>limit</para></entry>
<entry role="parameter_description"><para>search limit, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-find-char.returns" role="returns">
<title>Returns</title>
<para> whether a match was found</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-find-char" role="function">
<title>gtk_text_iter_backward_find_char&#160;()</title>
<indexterm zone="gtk-text-iter-backward-find-char"><primary>gtk_text_iter_backward_find_char</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_find_char (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                                  <parameter><link linkend="GtkTextCharPredicate"><type>GtkTextCharPredicate</type></link> pred</parameter>,
                                  <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>,
                                  <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *limit</parameter>);</programlisting>
<para>Same as <link linkend="gtk-text-iter-forward-find-char"><function>gtk_text_iter_forward_find_char()</function></link>, but goes backward from <parameter>iter</parameter>
.</para>
<refsect3 id="gtk-text-iter-backward-find-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>pred</para></entry>
<entry role="parameter_description"><para>function to be called on each character. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>scope call</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>user_data</para></entry>
<entry role="parameter_description"><para>user data for <parameter>pred</parameter>
. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>limit</para></entry>
<entry role="parameter_description"><para>search limit, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-find-char.returns" role="returns">
<title>Returns</title>
<para> whether a match was found</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-forward-search" role="function">
<title>gtk_text_iter_forward_search&#160;()</title>
<indexterm zone="gtk-text-iter-forward-search"><primary>gtk_text_iter_forward_search</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_forward_search (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                              <parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>,
                              <parameter><link linkend="GtkTextSearchFlags"><type>GtkTextSearchFlags</type></link> flags</parameter>,
                              <parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *match_start</parameter>,
                              <parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *match_end</parameter>,
                              <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *limit</parameter>);</programlisting>
<para>Searches forward for <parameter>str</parameter>
. Any match is returned by setting
<parameter>match_start</parameter>
 to the first character of the match and <parameter>match_end</parameter>
 to the
first character after the match. The search will not continue past
<parameter>limit</parameter>
. Note that a search is a linear or O(n) operation, so you
may wish to use <parameter>limit</parameter>
 to avoid locking up your UI on large
buffers.</para>
<para><parameter>match_start</parameter>
 will never be set to a <link linkend="GtkTextIter"><type>GtkTextIter</type></link> located before <parameter>iter</parameter>
, even if
there is a possible <parameter>match_end</parameter>
 after or at <parameter>iter</parameter>
.</para>
<refsect3 id="gtk-text-iter-forward-search.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>start of search</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>str</para></entry>
<entry role="parameter_description"><para>a search string</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>flags</para></entry>
<entry role="parameter_description"><para>flags affecting how the search is done</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>match_start</para></entry>
<entry role="parameter_description"><para>return location for start of match, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>match_end</para></entry>
<entry role="parameter_description"><para>return location for end of match, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>limit</para></entry>
<entry role="parameter_description"><para>location of last possible <parameter>match_end</parameter>
, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for the end of the buffer. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-forward-search.returns" role="returns">
<title>Returns</title>
<para> whether a match was found</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-backward-search" role="function">
<title>gtk_text_iter_backward_search&#160;()</title>
<indexterm zone="gtk-text-iter-backward-search"><primary>gtk_text_iter_backward_search</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_backward_search (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                               <parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>,
                               <parameter><link linkend="GtkTextSearchFlags"><type>GtkTextSearchFlags</type></link> flags</parameter>,
                               <parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *match_start</parameter>,
                               <parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *match_end</parameter>,
                               <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *limit</parameter>);</programlisting>
<para>Same as <link linkend="gtk-text-iter-forward-search"><function>gtk_text_iter_forward_search()</function></link>, but moves backward.</para>
<para><parameter>match_end</parameter>
 will never be set to a <link linkend="GtkTextIter"><type>GtkTextIter</type></link> located after <parameter>iter</parameter>
, even if
there is a possible <parameter>match_start</parameter>
 before or at <parameter>iter</parameter>
.</para>
<refsect3 id="gtk-text-iter-backward-search.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link> where the search begins</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>str</para></entry>
<entry role="parameter_description"><para>search string</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>flags</para></entry>
<entry role="parameter_description"><para>bitmask of flags affecting the search</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>match_start</para></entry>
<entry role="parameter_description"><para>return location for start of match, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>match_end</para></entry>
<entry role="parameter_description"><para>return location for end of match, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>limit</para></entry>
<entry role="parameter_description"><para>location of last possible <parameter>match_start</parameter>
, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for start of buffer. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-backward-search.returns" role="returns">
<title>Returns</title>
<para> whether a match was found</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-equal" role="function">
<title>gtk_text_iter_equal&#160;()</title>
<indexterm zone="gtk-text-iter-equal"><primary>gtk_text_iter_equal</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_equal (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *lhs</parameter>,
                     <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *rhs</parameter>);</programlisting>
<para>Tests whether two iterators are equal, using the fastest possible
mechanism. This function is very fast; you can expect it to perform
better than e.g. getting the character offset for each iterator and
comparing the offsets yourself. Also, it’s a bit faster than
<link linkend="gtk-text-iter-compare"><function>gtk_text_iter_compare()</function></link>.</para>
<refsect3 id="gtk-text-iter-equal.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>lhs</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>rhs</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-equal.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the iterators point to the same place in the buffer</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-compare" role="function">
<title>gtk_text_iter_compare&#160;()</title>
<indexterm zone="gtk-text-iter-compare"><primary>gtk_text_iter_compare</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_text_iter_compare (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *lhs</parameter>,
                       <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *rhs</parameter>);</programlisting>
<para>A <link linkend="qsort"><function>qsort()</function></link>-style function that returns negative if <parameter>lhs</parameter>
 is less than
<parameter>rhs</parameter>
, positive if <parameter>lhs</parameter>
 is greater than <parameter>rhs</parameter>
, and 0 if they’re equal.
Ordering is in character offset order, i.e. the first character in the buffer
is less than the second character in the buffer.</para>
<refsect3 id="gtk-text-iter-compare.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>lhs</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>rhs</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-compare.returns" role="returns">
<title>Returns</title>
<para> -1 if <parameter>lhs</parameter>
is less than <parameter>rhs</parameter>
, 1 if <parameter>lhs</parameter>
is greater, 0 if they are equal</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-in-range" role="function">
<title>gtk_text_iter_in_range&#160;()</title>
<indexterm zone="gtk-text-iter-in-range"><primary>gtk_text_iter_in_range</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_text_iter_in_range (<parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *iter</parameter>,
                        <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *start</parameter>,
                        <parameter>const <link linkend="GtkTextIter"><type>GtkTextIter</type></link> *end</parameter>);</programlisting>
<para>Checks whether <parameter>iter</parameter>
 falls in the range [<parameter>start</parameter>
, <parameter>end</parameter>
).
<parameter>start</parameter>
 and <parameter>end</parameter>
 must be in ascending order.</para>
<refsect3 id="gtk-text-iter-in-range.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>start</para></entry>
<entry role="parameter_description"><para>start of range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end</para></entry>
<entry role="parameter_description"><para>end of range</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-text-iter-in-range.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is in the range</para>
</refsect3></refsect2>
<refsect2 id="gtk-text-iter-order" role="function">
<title>gtk_text_iter_order&#160;()</title>
<indexterm zone="gtk-text-iter-order"><primary>gtk_text_iter_order</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_text_iter_order (<parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *first</parameter>,
                     <parameter><link linkend="GtkTextIter"><type>GtkTextIter</type></link> *second</parameter>);</programlisting>
<para>Swaps the value of <parameter>first</parameter>
 and <parameter>second</parameter>
 if <parameter>second</parameter>
 comes before
<parameter>first</parameter>
 in the buffer. That is, ensures that <parameter>first</parameter>
 and <parameter>second</parameter>
 are
in sequence. Most text buffer functions that take a range call this
automatically on your behalf, so there’s no real reason to call it yourself
in those cases. There are some exceptions, such as <link linkend="gtk-text-iter-in-range"><function>gtk_text_iter_in_range()</function></link>,
that expect a pre-sorted range.</para>
<refsect3 id="gtk-text-iter-order.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>first</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>second</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkTextIter"><type>GtkTextIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkTextIter.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkTextIter-struct" role="struct">
<title>GtkTextIter</title>
<indexterm zone="GtkTextIter-struct"><primary>GtkTextIter</primary></indexterm>
<programlisting language="C">typedef struct {
  /* GtkTextIter is an opaque datatype; ignore all these fields.
   * Initialize the iter with gtk_text_buffer_get_iter_*
   * functions
   */
} GtkTextIter;
</programlisting>
</refsect2>
<refsect2 id="GtkTextSearchFlags" role="enum">
<title>enum GtkTextSearchFlags</title>
<indexterm zone="GtkTextSearchFlags"><primary>GtkTextSearchFlags</primary></indexterm>
<para>Flags affecting how a search is done.</para>
<para>If neither <link linkend="GTK-TEXT-SEARCH-VISIBLE-ONLY:CAPS"><type>GTK_TEXT_SEARCH_VISIBLE_ONLY</type></link> nor <link linkend="GTK-TEXT-SEARCH-TEXT-ONLY:CAPS"><type>GTK_TEXT_SEARCH_TEXT_ONLY</type></link> are
enabled, the match must be exact; the special 0xFFFC character will match
embedded paintables or child widgets.</para>
<refsect3 id="GtkTextSearchFlags.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="GTK-TEXT-SEARCH-VISIBLE-ONLY:CAPS">GTK_TEXT_SEARCH_VISIBLE_ONLY</para></entry>
<entry role="enum_member_description"><para>Search only visible data. A search match may
have invisible text interspersed.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-TEXT-SEARCH-TEXT-ONLY:CAPS">GTK_TEXT_SEARCH_TEXT_ONLY</para></entry>
<entry role="enum_member_description"><para>Search only text. A match may have paintables or
child widgets mixed inside the matched range.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-TEXT-SEARCH-CASE-INSENSITIVE:CAPS">GTK_TEXT_SEARCH_CASE_INSENSITIVE</para></entry>
<entry role="enum_member_description"><para>The text will be matched regardless of
what case it is in.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>

</refentry>
