<refentry id="gtk-GtkTextIter">
<refmeta>
<refentrytitle>GtkTextIter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkTextIter</refname><refpurpose>Text buffer iterator</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>

#include &lt;gtk/gtk.h&gt;


struct      <link linkend="GtkTextIter">GtkTextIter</link>;
<link linkend="GtkTextBuffer">GtkTextBuffer</link>* <link linkend="gtk-text-iter-get-buffer">gtk_text_iter_get_buffer</link>     (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="GtkTextIter">GtkTextIter</link>* <link linkend="gtk-text-iter-copy">gtk_text_iter_copy</link>             (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
void        <link linkend="gtk-text-iter-free">gtk_text_iter_free</link>              (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-offset">gtk_text_iter_get_offset</link>        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-line">gtk_text_iter_get_line</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-line-offset">gtk_text_iter_get_line_offset</link>   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-line-index">gtk_text_iter_get_line_index</link>    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-visible-line-index">gtk_text_iter_get_visible_line_index</link>
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-visible-line-offset">gtk_text_iter_get_visible_line_offset</link>
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gunichar">gunichar</link>    <link linkend="gtk-text-iter-get-char">gtk_text_iter_get_char</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gchar">gchar</link>*      <link linkend="gtk-text-iter-get-slice">gtk_text_iter_get_slice</link>         (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);
<link linkend="gchar">gchar</link>*      <link linkend="gtk-text-iter-get-text">gtk_text_iter_get_text</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);
<link linkend="gchar">gchar</link>*      <link linkend="gtk-text-iter-get-visible-slice">gtk_text_iter_get_visible_slice</link> (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);
<link linkend="gchar">gchar</link>*      <link linkend="gtk-text-iter-get-visible-text">gtk_text_iter_get_visible_text</link>  (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);
<link linkend="GdkPixbuf">GdkPixbuf</link>*  <link linkend="gtk-text-iter-get-pixbuf">gtk_text_iter_get_pixbuf</link>        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="GSList">GSList</link>*     <link linkend="gtk-text-iter-get-marks">gtk_text_iter_get_marks</link>         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="GSList">GSList</link>*     <link linkend="gtk-text-iter-get-toggled-tags">gtk_text_iter_get_toggled_tags</link>  (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> toggled_on);
<link linkend="GtkTextChildAnchor">GtkTextChildAnchor</link>* <link linkend="gtk-text-iter-get-child-anchor">gtk_text_iter_get_child_anchor</link>
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-begins-tag">gtk_text_iter_begins_tag</link>        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-ends-tag">gtk_text_iter_ends_tag</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-toggles-tag">gtk_text_iter_toggles_tag</link>       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-has-tag">gtk_text_iter_has_tag</link>           (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="GSList">GSList</link>*     <link linkend="gtk-text-iter-get-tags">gtk_text_iter_get_tags</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-editable">gtk_text_iter_editable</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> default_setting);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-can-insert">gtk_text_iter_can_insert</link>        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> default_editability);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-starts-word">gtk_text_iter_starts_word</link>       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-ends-word">gtk_text_iter_ends_word</link>         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-inside-word">gtk_text_iter_inside_word</link>       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-starts-line">gtk_text_iter_starts_line</link>       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-ends-line">gtk_text_iter_ends_line</link>         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-starts-sentence">gtk_text_iter_starts_sentence</link>   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-ends-sentence">gtk_text_iter_ends_sentence</link>     (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-inside-sentence">gtk_text_iter_inside_sentence</link>   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-is-cursor-position">gtk_text_iter_is_cursor_position</link>
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-chars-in-line">gtk_text_iter_get_chars_in_line</link> (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-get-bytes-in-line">gtk_text_iter_get_bytes_in_line</link> (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-get-attributes">gtk_text_iter_get_attributes</link>    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextAttributes">GtkTextAttributes</link> *values);
<link linkend="PangoLanguage">PangoLanguage</link>* <link linkend="gtk-text-iter-get-language">gtk_text_iter_get_language</link>   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-is-end">gtk_text_iter_is_end</link>            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-is-start">gtk_text_iter_is_start</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-char">gtk_text_iter_forward_char</link>      (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-char">gtk_text_iter_backward_char</link>     (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-chars">gtk_text_iter_forward_chars</link>     (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-chars">gtk_text_iter_backward_chars</link>    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-line">gtk_text_iter_forward_line</link>      (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-line">gtk_text_iter_backward_line</link>     (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-lines">gtk_text_iter_forward_lines</link>     (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-lines">gtk_text_iter_backward_lines</link>    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-word-ends">gtk_text_iter_forward_word_ends</link> (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-word-starts">gtk_text_iter_backward_word_starts</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-word-end">gtk_text_iter_forward_word_end</link>  (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-word-start">gtk_text_iter_backward_word_start</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-cursor-position">gtk_text_iter_backward_cursor_position</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-cursor-positions">gtk_text_iter_forward_cursor_positions</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-cursor-positions">gtk_text_iter_backward_cursor_positions</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-sentence-start">gtk_text_iter_backward_sentence_start</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-sentence-starts">gtk_text_iter_backward_sentence_starts</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-sentence-end">gtk_text_iter_forward_sentence_end</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-sentence-ends">gtk_text_iter_forward_sentence_ends</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);
void        <link linkend="gtk-text-iter-set-offset">gtk_text_iter_set_offset</link>        (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_offset);
void        <link linkend="gtk-text-iter-set-line">gtk_text_iter_set_line</link>          (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> line_number);
void        <link linkend="gtk-text-iter-set-line-offset">gtk_text_iter_set_line_offset</link>   (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_on_line);
void        <link linkend="gtk-text-iter-set-line-index">gtk_text_iter_set_line_index</link>    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> byte_on_line);
void        <link linkend="gtk-text-iter-set-visible-line-index">gtk_text_iter_set_visible_line_index</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> byte_on_line);
void        <link linkend="gtk-text-iter-set-visible-line-offset">gtk_text_iter_set_visible_line_offset</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_on_line);
void        <link linkend="gtk-text-iter-forward-to-end">gtk_text_iter_forward_to_end</link>    (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-to-line-end">gtk_text_iter_forward_to_line_end</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-to-tag-toggle">gtk_text_iter_forward_to_tag_toggle</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-to-tag-toggle">gtk_text_iter_backward_to_tag_toggle</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);
<link linkend="gboolean">gboolean</link>    (<link linkend="GtkTextCharPredicate">*GtkTextCharPredicate</link>)         (<link linkend="gunichar">gunichar</link> ch,
                                             <link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-find-char">gtk_text_iter_forward_find_char</link> (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextCharPredicate">GtkTextCharPredicate</link> pred,
                                             <link linkend="gpointer">gpointer</link> user_data,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-find-char">gtk_text_iter_backward_find_char</link>
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextCharPredicate">GtkTextCharPredicate</link> pred,
                                             <link linkend="gpointer">gpointer</link> user_data,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);
enum        <link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link>;
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-forward-search">gtk_text_iter_forward_search</link>    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link> flags,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_start,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_end,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-backward-search">gtk_text_iter_backward_search</link>   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link> flags,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_start,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_end,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-equal">gtk_text_iter_equal</link>             (const <link linkend="GtkTextIter">GtkTextIter</link> *lhs,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *rhs);
<link linkend="gint">gint</link>        <link linkend="gtk-text-iter-compare">gtk_text_iter_compare</link>           (const <link linkend="GtkTextIter">GtkTextIter</link> *lhs,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *rhs);
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-text-iter-in-range">gtk_text_iter_in_range</link>          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);
void        <link linkend="gtk-text-iter-order">gtk_text_iter_order</link>             (<link linkend="GtkTextIter">GtkTextIter</link> *first,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *second);


</synopsis>
</refsynopsisdiv>





<refsect1>
<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>

<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GtkTextIter">struct GtkTextIter</title>
<programlisting>struct GtkTextIter {
  /* GtkTextIter is an opaque datatype; ignore all these fields.
   * Initialize the iter with gtk_text_buffer_get_iter_*
   * functions
   */
  /*&lt; private &gt;*/
  gpointer dummy1;
  gpointer dummy2;
  gint dummy3;
  gint dummy4;
  gint dummy5;
  gint dummy6;
  gint dummy7;
  gint dummy8;
  gpointer dummy9;
  gpointer dummy10;
  gint dummy11;
  gint dummy12;
  /* padding */
  gint dummy13;
  gpointer dummy14;
};
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-buffer">gtk_text_iter_get_buffer ()</title>
<programlisting><link linkend="GtkTextBuffer">GtkTextBuffer</link>* gtk_text_iter_get_buffer     (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the <link linkend="GtkTextBuffer">GtkTextBuffer</link> this iterator is associated with.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-copy">gtk_text_iter_copy ()</title>
<programlisting><link linkend="GtkTextIter">GtkTextIter</link>* gtk_text_iter_copy             (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a copy of the <parameter>iter</parameter>, free with <link linkend="gtk-text-iter-free">gtk_text_iter_free</link>()
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-free">gtk_text_iter_free ()</title>
<programlisting>void        gtk_text_iter_free              (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a dynamically-allocated iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-offset">gtk_text_iter_get_offset ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_offset        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the character offset of an iterator.
Each character in a <link linkend="GtkTextBuffer">GtkTextBuffer</link> has an offset,
starting with 0 for the first character in the buffer.
Use <link linkend="gtk-text-buffer-get-iter-at-offset">gtk_text_buffer_get_iter_at_offset</link>() to convert an
offset back into an iterator.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a character offset
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-line">gtk_text_iter_get_line ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_line          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the line number containing the iterator. Lines in
a <link linkend="GtkTextBuffer">GtkTextBuffer</link> are numbered beginning with 0 for the first
line in the buffer.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a line number
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-line-offset">gtk_text_iter_get_line_offset ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_line_offset   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> offset from start of line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-line-index">gtk_text_iter_get_line_index ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_line_index    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the byte index of the iterator, counting
from the start of a newline-terminated line.
Remember that <link linkend="GtkTextBuffer">GtkTextBuffer</link> encodes text in
UTF-8, and that characters can require a variable
number of bytes to represent.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> distance from start of line, in bytes
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-visible-line-index">gtk_text_iter_get_visible_line_index ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_visible_line_index
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> byte index of <parameter>iter</parameter> with respect to the start of the line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-visible-line-offset">gtk_text_iter_get_visible_line_offset ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_visible_line_offset
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> offset in visible characters from the start of the line 
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-char">gtk_text_iter_get_char ()</title>
<programlisting><link linkend="gunichar">gunichar</link>    gtk_text_iter_get_char          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the Unicode character at this iterator.  (Equivalent to
operator* on a C++ iterator.)  If the iterator points at 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">gtk_text_iter_get_char</link>()
returns 0.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a Unicode character, or 0 if <parameter>iter</parameter> is not dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-slice">gtk_text_iter_get_slice ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gtk_text_iter_get_slice         (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);</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 pixbuf or
widget is in the buffer.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>start</parameter>&nbsp;:</entry>
<entry> iterator at start of a range
</entry></row>
<row><entry align="right"><parameter>end</parameter>&nbsp;:</entry>
<entry> iterator at end of a range
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> slice of text from the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-text">gtk_text_iter_get_text ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gtk_text_iter_get_text          (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);</programlisting>
<para>
Returns <emphasis>text</emphasis> 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">gtk_text_iter_get_slice</link>().</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>start</parameter>&nbsp;:</entry>
<entry> iterator at start of a range
</entry></row>
<row><entry align="right"><parameter>end</parameter>&nbsp;:</entry>
<entry> iterator at end of a range
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> array of characters from the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-visible-slice">gtk_text_iter_get_visible_slice ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gtk_text_iter_get_visible_slice (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);</programlisting>
<para>
Like <link linkend="gtk-text-iter-get-slice">gtk_text_iter_get_slice</link>(), but invisible text is not included.
Invisible text is usually invisible because a <link linkend="GtkTextTag">GtkTextTag</link> with the
"invisible" attribute turned on has been applied to it.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>start</parameter>&nbsp;:</entry>
<entry> iterator at start of range
</entry></row>
<row><entry align="right"><parameter>end</parameter>&nbsp;:</entry>
<entry> iterator at end of range
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> slice of text from the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-visible-text">gtk_text_iter_get_visible_text ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gtk_text_iter_get_visible_text  (const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);</programlisting>
<para>
Like <link linkend="gtk-text-iter-get-text">gtk_text_iter_get_text</link>(), but invisible text is not included.
Invisible text is usually invisible because a <link linkend="GtkTextTag">GtkTextTag</link> with the
"invisible" attribute turned on has been applied to it.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>start</parameter>&nbsp;:</entry>
<entry> iterator at start of range
</entry></row>
<row><entry align="right"><parameter>end</parameter>&nbsp;:</entry>
<entry> iterator at end of range
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> string containing visible text in the range
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-pixbuf">gtk_text_iter_get_pixbuf ()</title>
<programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>*  gtk_text_iter_get_pixbuf        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
If the location pointed to by <parameter>iter</parameter> contains a pixbuf, the pixbuf
is returned (with no new reference count added). Otherwise,
<literal>NULL</literal> is returned.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> the pixbuf at <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-marks">gtk_text_iter_get_marks ()</title>
<programlisting><link linkend="GSList">GSList</link>*     gtk_text_iter_get_marks         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns a list of all <link linkend="GtkTextMark">GtkTextMark</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> list of <link linkend="GtkTextMark">GtkTextMark</link>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-toggled-tags">gtk_text_iter_get_toggled_tags ()</title>
<programlisting><link linkend="GSList">GSList</link>*     gtk_text_iter_get_toggled_tags  (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> toggled_on);</programlisting>
<para>
Returns a list of <link linkend="GtkTextTag">GtkTextTag</link> that are toggled on or off at this
point.  (If <parameter>toggled_on</parameter> is <literal>TRUE</literal>, 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 <emphasis>not</emphasis> have the tag applied to it.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>toggled_on</parameter>&nbsp;:</entry>
<entry> <literal>TRUE</literal> to get toggled-on tags
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> tags toggled at this point
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-child-anchor">gtk_text_iter_get_child_anchor ()</title>
<programlisting><link linkend="GtkTextChildAnchor">GtkTextChildAnchor</link>* gtk_text_iter_get_child_anchor
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
If the location pointed to by <parameter>iter</parameter> contains a child anchor, the
anchor is returned (with no new reference count added). Otherwise,
<literal>NULL</literal> is returned.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> the anchor at <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-begins-tag">gtk_text_iter_begins_tag ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_begins_tag        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
Returns <literal>TRUE</literal> if <parameter>tag</parameter> is toggled on at exactly this point. If <parameter>tag</parameter>
is <literal>NULL</literal>, returns <literal>TRUE</literal> if any tag is toggled on at this point. Note
that the <link linkend="gtk-text-iter-begins-tag">gtk_text_iter_begins_tag</link>() returns <literal>TRUE</literal> if <parameter>iter</parameter> is the
<emphasis>start</emphasis> of the tagged range;
<link linkend="gtk-text-iter-has-tag">gtk_text_iter_has_tag</link>() tells you whether an iterator is
<emphasis>within</emphasis> a tagged range.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is the start of a range tagged with <parameter>tag</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-ends-tag">gtk_text_iter_ends_tag ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_ends_tag          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
Returns <literal>TRUE</literal> if <parameter>tag</parameter> is toggled off at exactly this point. If <parameter>tag</parameter>
is <literal>NULL</literal>, returns <literal>TRUE</literal> if any tag is toggled off at this point. Note
that the <link linkend="gtk-text-iter-ends-tag">gtk_text_iter_ends_tag</link>() returns <literal>TRUE</literal> if <parameter>iter</parameter> is the
<emphasis>end</emphasis> of the tagged range;
<link linkend="gtk-text-iter-has-tag">gtk_text_iter_has_tag</link>() tells you whether an iterator is
<emphasis>within</emphasis> a tagged range.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is the end of a range tagged with <parameter>tag</parameter>

</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-toggles-tag">gtk_text_iter_toggles_tag ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_toggles_tag       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
This is equivalent to (<link linkend="gtk-text-iter-begins-tag">gtk_text_iter_begins_tag</link>() ||
<link linkend="gtk-text-iter-ends-tag">gtk_text_iter_ends_tag</link>()), i.e. it tells you whether a range with
<parameter>tag</parameter> applied to it begins <emphasis>or</emphasis> ends at <parameter>iter</parameter>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>tag</parameter> is toggled on or off at <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-has-tag">gtk_text_iter_has_tag ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_has_tag           (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
Returns <literal>TRUE</literal> if <parameter>iter</parameter> is within a range tagged with <parameter>tag</parameter>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is tagged with <parameter>tag</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-tags">gtk_text_iter_get_tags ()</title>
<programlisting><link linkend="GSList">GSList</link>*     gtk_text_iter_get_tags          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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">GtkTextTag</link> in the
list don't have a reference added, but you have to free the list
itself.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> list of <link linkend="GtkTextTag">GtkTextTag</link>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-editable">gtk_text_iter_editable ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_editable          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> default_setting);</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">GtkTextView</link>. This function is simply a convenience
wrapper around <link linkend="gtk-text-iter-get-attributes">gtk_text_iter_get_attributes</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">gtk_text_iter_can_insert</link>() to handle this
case.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>default_setting</parameter>&nbsp;:</entry>
<entry> <literal>TRUE</literal> if text is editable by default
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is inside an editable range
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-can-insert">gtk_text_iter_can_insert ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_can_insert        (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gboolean">gboolean</link> default_editability);</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">gtk_text_buffer_insert_interactive</link>() uses this function to decide
whether insertions are allowed at a given position.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>default_editability</parameter>&nbsp;:</entry>
<entry> <literal>TRUE</literal> if text is editable by default
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether text inserted at <parameter>iter</parameter> would be editable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-starts-word">gtk_text_iter_starts_word ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_starts_word       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is at the start of a word
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-ends-word">gtk_text_iter_ends_word ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_ends_word         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is at the end of a word
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-inside-word">gtk_text_iter_inside_word ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_inside_word       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Determines whether <parameter>iter</parameter> is inside 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>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is inside a word
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-starts-line">gtk_text_iter_starts_line ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_starts_line       (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns <literal>TRUE</literal> if <parameter>iter</parameter> begins a paragraph,
i.e. if <link linkend="gtk-text-iter-get-line-offset">gtk_text_iter_get_line_offset</link>() would return 0.
However this function is potentially more efficient than
<link linkend="gtk-text-iter-get-line-offset">gtk_text_iter_get_line_offset</link>() because it doesn't have to compute
the offset, it just has to see whether it's 0.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> begins a line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-ends-line">gtk_text_iter_ends_line ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_ends_line         (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns <literal>TRUE</literal> 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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is at the end of a line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-starts-sentence">gtk_text_iter_starts_sentence ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_starts_sentence   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is at the start of a sentence.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-ends-sentence">gtk_text_iter_ends_sentence ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_ends_sentence     (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is at the end of a sentence.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-inside-sentence">gtk_text_iter_inside_sentence ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_inside_sentence   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is inside a sentence.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-is-cursor-position">gtk_text_iter_is_cursor_position ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_is_cursor_position
                                            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
See <link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>() or <link linkend="PangoLogAttr">PangoLogAttr</link> or
<link linkend="pango-break">pango_break</link>() for details on what a cursor position is.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if the cursor can be placed at <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-chars-in-line">gtk_text_iter_get_chars_in_line ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_chars_in_line (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the number of characters in the line containing <parameter>iter</parameter>,
including the paragraph delimiters.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> number of characters in the line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-bytes-in-line">gtk_text_iter_get_bytes_in_line ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_get_bytes_in_line (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns the number of bytes in the line containing <parameter>iter</parameter>,
including the paragraph delimiters.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> number of bytes in the line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-attributes">gtk_text_iter_get_attributes ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_get_attributes    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextAttributes">GtkTextAttributes</link> *values);</programlisting>
<para>
Computes the effect of any tags applied to this spot in the
text. The <parameter>values</parameter> parameter should be initialized to the default
settings you wish to use if no tags are in effect. You'd typically
obtain the defaults from <link linkend="gtk-text-view-get-default-attributes">gtk_text_view_get_default_attributes</link>().
</para>
<para>
<link linkend="gtk-text-iter-get-attributes">gtk_text_iter_get_attributes</link>() will modify <parameter>values</parameter>, applying the
effects of any tags present at <parameter>iter</parameter>. If any tags affected <parameter>values</parameter>,
the function returns <literal>TRUE</literal>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>values</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextAttributes">GtkTextAttributes</link> to be filled in
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>values</parameter> was modified
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-get-language">gtk_text_iter_get_language ()</title>
<programlisting><link linkend="PangoLanguage">PangoLanguage</link>* gtk_text_iter_get_language   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
A convenience wrapper around <link linkend="gtk-text-iter-get-attributes">gtk_text_iter_get_attributes</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">gtk_get_default_language</link>().</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> language in effect at <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-is-end">gtk_text_iter_is_end ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_is_end            (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns <literal>TRUE</literal> 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">gtk_text_iter_is_end</link>() is
the most efficient way to check whether an iterator is the end
iterator.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-is-start">gtk_text_iter_is_start ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_is_start          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Returns <literal>TRUE</literal> if <parameter>iter</parameter> is the first iterator in the buffer, that is
if <parameter>iter</parameter> has a character offset of 0.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> is the first in the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-char">gtk_text_iter_forward_char ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_char      (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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">gtk_text_iter_forward_char</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">gtk_text_iter_forward_char</link>() returns <literal>FALSE</literal> for
convenience when writing loops.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved and is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-char">gtk_text_iter_backward_char ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_char     (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Moves backward by one character offset. Returns <literal>TRUE</literal> if movement
was possible; if <parameter>iter</parameter> was the first in the buffer (character
offset 0), <link linkend="gtk-text-iter-backward-char">gtk_text_iter_backward_char</link>() returns <literal>FALSE</literal> for convenience when
writing loops.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether movement was possible
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-chars">gtk_text_iter_forward_chars ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_chars     (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</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 <literal>FALSE</literal>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of characters to move, may be negative
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved and is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-chars">gtk_text_iter_backward_chars ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_chars    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</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 <literal>FALSE</literal> is returned. If <parameter>count</parameter> is 0,
the function does nothing and returns <literal>FALSE</literal>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of characters to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved and is dereferenceable

</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-line">gtk_text_iter_forward_line ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_line      (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Moves <parameter>iter</parameter> to the start of the next line. Returns <literal>TRUE</literal> if there
was a next line to move to, and <literal>FALSE</literal> 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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> can be dereferenced
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-line">gtk_text_iter_backward_line ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_line     (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Moves <parameter>iter</parameter> to the start of the previous line. Returns <literal>TRUE</literal> if
<parameter>iter</parameter> could be moved; i.e. if <parameter>iter</parameter> was at character offset 0, this
function returns <literal>FALSE</literal>. 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 <literal>TRUE</literal>. (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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> an iterator
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-lines">gtk_text_iter_forward_lines ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_lines     (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</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 <literal>FALSE</literal> is returned. If <parameter>count</parameter> is 0,
the function does nothing and returns <literal>FALSE</literal>. If <parameter>count</parameter> is negative,
moves backward by 0 - <parameter>count</parameter> lines.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of lines to move forward
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved and is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-lines">gtk_text_iter_backward_lines ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_lines    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</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 <literal>FALSE</literal> is returned. If <parameter>count</parameter> is 0,
the function does nothing and returns <literal>FALSE</literal>. If <parameter>count</parameter> is negative,
moves forward by 0 - <parameter>count</parameter> lines.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of lines to move backward
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether <parameter>iter</parameter> moved and is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-word-ends">gtk_text_iter_forward_word_ends ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_word_ends (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Calls <link linkend="gtk-text-iter-forward-word-end">gtk_text_iter_forward_word_end</link>() up to <parameter>count</parameter> times.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of times to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator 
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-word-starts">gtk_text_iter_backward_word_starts ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_word_starts
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Calls <link linkend="gtk-text-iter-backward-word-start">gtk_text_iter_backward_word_start</link>() up to <parameter>count</parameter> times.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of times to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator 
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-word-end">gtk_text_iter_forward_word_end ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_word_end  (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator 
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-word-start">gtk_text_iter_backward_word_start ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_word_start
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator 
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_cursor_position
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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">PangoLogAttr</link> structure and
<link linkend="pango-break">pango_break</link>() function.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if we moved and the new position is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-cursor-position">gtk_text_iter_backward_cursor_position ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_cursor_position
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</programlisting>
<para>
Like <link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>(), but moves backward.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if we moved and the new position is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-cursor-positions">gtk_text_iter_forward_cursor_positions ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_cursor_positions
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Moves up to <parameter>count</parameter> cursor positions. See
<link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>() for details.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of positions to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if we moved and the new position is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-cursor-positions">gtk_text_iter_backward_cursor_positions ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_cursor_positions
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Moves up to <parameter>count</parameter> cursor positions. See
<link linkend="gtk-text-iter-forward-cursor-position">gtk_text_iter_forward_cursor_position</link>() for details.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of positions to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if we moved and the new position is dereferenceable
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-sentence-start">gtk_text_iter_backward_sentence_start ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_sentence_start
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-sentence-starts">gtk_text_iter_backward_sentence_starts ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_sentence_starts
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Calls <link linkend="gtk-text-iter-backward-sentence-start">gtk_text_iter_backward_sentence_start</link>() up to <parameter>count</parameter> times,
or until it returns <literal>FALSE</literal>. If <parameter>count</parameter> is negative, moves forward
instead of backward.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of sentences to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-sentence-end">gtk_text_iter_forward_sentence_end ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_sentence_end
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-sentence-ends">gtk_text_iter_forward_sentence_ends ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_sentence_ends
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> count);</programlisting>
<para>
Calls <link linkend="gtk-text-iter-forward-sentence-end">gtk_text_iter_forward_sentence_end</link>() <parameter>count</parameter> times (or until
<link linkend="gtk-text-iter-forward-sentence-end">gtk_text_iter_forward_sentence_end</link>() returns <literal>FALSE</literal>). If <parameter>count</parameter> is
negative, moves backward instead of forward.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>count</parameter>&nbsp;:</entry>
<entry> number of sentences to move
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> moved and is not the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-offset">gtk_text_iter_set_offset ()</title>
<programlisting>void        gtk_text_iter_set_offset        (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_offset);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>char_offset</parameter>&nbsp;:</entry>
<entry> a character number
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-line">gtk_text_iter_set_line ()</title>
<programlisting>void        gtk_text_iter_set_line          (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> line_number);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>line_number</parameter>&nbsp;:</entry>
<entry> line number (counted from 0)
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-line-offset">gtk_text_iter_set_line_offset ()</title>
<programlisting>void        gtk_text_iter_set_line_offset   (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_on_line);</programlisting>
<para>
Moves <parameter>iter</parameter> within a line, to a new <emphasis>character</emphasis>
(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">gtk_text_iter_set_line_index</link>() if you have a byte index rather than
a character offset.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link> 
</entry></row>
<row><entry align="right"><parameter>char_on_line</parameter>&nbsp;:</entry>
<entry> a character offset relative to the start of <parameter>iter</parameter>'s current line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-line-index">gtk_text_iter_set_line_index ()</title>
<programlisting>void        gtk_text_iter_set_line_index    (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> byte_on_line);</programlisting>
<para>
Same as <link linkend="gtk-text-iter-set-line-offset">gtk_text_iter_set_line_offset</link>(), but works with a
<emphasis>byte</emphasis> 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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>byte_on_line</parameter>&nbsp;:</entry>
<entry> a byte index relative to the start of <parameter>iter</parameter>'s current line
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-visible-line-index">gtk_text_iter_set_visible_line_index ()</title>
<programlisting>void        gtk_text_iter_set_visible_line_index
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> byte_on_line);</programlisting>
<para>
Like <link linkend="gtk-text-iter-set-line-index">gtk_text_iter_set_line_index</link>(), but the index is in visible
bytes, i.e. text with a tag making it invisible is not counted
in the index.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>byte_on_line</parameter>&nbsp;:</entry>
<entry> a byte index
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-set-visible-line-offset">gtk_text_iter_set_visible_line_offset ()</title>
<programlisting>void        gtk_text_iter_set_visible_line_offset
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="gint">gint</link> char_on_line);</programlisting>
<para>
Like <link linkend="gtk-text-iter-set-line-offset">gtk_text_iter_set_line_offset</link>(), but the offset is in visible
characters, i.e. text with a tag making it invisible is not
counted in the offset.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>char_on_line</parameter>&nbsp;:</entry>
<entry> a character offset
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-to-end">gtk_text_iter_forward_to_end ()</title>
<programlisting>void        gtk_text_iter_forward_to_end    (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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">gtk_text_iter_get_char</link>() called on the
end iterator returns 0, which is convenient for writing loops.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-to-line-end">gtk_text_iter_forward_to_line_end ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_to_line_end
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter);</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 <literal>FALSE</literal>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if we moved and the new location is not the end iterator
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-to-tag-toggle">gtk_text_iter_forward_to_tag_toggle ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_to_tag_toggle
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
Moves forward to the next toggle (on or off) of the
<link linkend="GtkTextTag">GtkTextTag</link> <parameter>tag</parameter>, or to the next toggle of any tag if
<parameter>tag</parameter> is <literal>NULL</literal>. If no matching tag toggles are found,
returns <literal>FALSE</literal>, otherwise <literal>TRUE</literal>. 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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether we found a tag toggle after <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-to-tag-toggle">gtk_text_iter_backward_to_tag_toggle ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_to_tag_toggle
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextTag">GtkTextTag</link> *tag);</programlisting>
<para>
Moves backward to the next toggle (on or off) of the
<link linkend="GtkTextTag">GtkTextTag</link> <parameter>tag</parameter>, or to the next toggle of any tag if
<parameter>tag</parameter> is <literal>NULL</literal>. If no matching tag toggles are found,
returns <literal>FALSE</literal>, otherwise <literal>TRUE</literal>. 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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>tag</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextTag">GtkTextTag</link>, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether we found a tag toggle before <parameter>iter</parameter>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="GtkTextCharPredicate">GtkTextCharPredicate ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    (*GtkTextCharPredicate)         (<link linkend="gunichar">gunichar</link> ch,
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ch</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-find-char">gtk_text_iter_forward_find_char ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_find_char (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextCharPredicate">GtkTextCharPredicate</link> pred,
                                             <link linkend="gpointer">gpointer</link> user_data,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);</programlisting>
<para>
Advances <parameter>iter</parameter>, calling <parameter>pred</parameter> on each character. If
<parameter>pred</parameter> returns <literal>TRUE</literal>, returns <literal>TRUE</literal> and stops scanning.
If <parameter>pred</parameter> never returns <literal>TRUE</literal>, <parameter>iter</parameter> is set to <parameter>limit</parameter> if
<parameter>limit</parameter> is non-<literal>NULL</literal>, otherwise to the end iterator.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>pred</parameter>&nbsp;:</entry>
<entry> a function to be called on each character
</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry> user data for <parameter>pred</parameter>
</entry></row>
<row><entry align="right"><parameter>limit</parameter>&nbsp;:</entry>
<entry> search limit, or <literal>NULL</literal> for none 
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether a match was found
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-find-char">gtk_text_iter_backward_find_char ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_find_char
                                            (<link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             <link linkend="GtkTextCharPredicate">GtkTextCharPredicate</link> pred,
                                             <link linkend="gpointer">gpointer</link> user_data,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);</programlisting>
<para>
Same as <link linkend="gtk-text-iter-forward-find-char">gtk_text_iter_forward_find_char</link>(), but goes backward from <parameter>iter</parameter>.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>pred</parameter>&nbsp;:</entry>
<entry> function to be called on each character
</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry> user data for <parameter>pred</parameter>
</entry></row>
<row><entry align="right"><parameter>limit</parameter>&nbsp;:</entry>
<entry> search limit, or <literal>NULL</literal> for none
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether a match was found
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="GtkTextSearchFlags">enum GtkTextSearchFlags</title>
<programlisting>typedef enum {
  GTK_TEXT_SEARCH_VISIBLE_ONLY,
  GTK_TEXT_SEARCH_TEXT_ONLY
  /* Possible future plans: SEARCH_CASE_INSENSITIVE, SEARCH_REGEXP */
} GtkTextSearchFlags;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-forward-search">gtk_text_iter_forward_search ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_forward_search    (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link> flags,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_start,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_end,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);</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>
If the <link linkend="GTK-TEXT-SEARCH-VISIBLE-ONLY-CAPS">GTK_TEXT_SEARCH_VISIBLE_ONLY</link> flag is present, the match may
have invisible text interspersed in <parameter>str</parameter>. i.e. <parameter>str</parameter> will be a
possibly-noncontiguous subsequence of the matched range. similarly,
if you specify <link linkend="GTK-TEXT-SEARCH-TEXT-ONLY-CAPS">GTK_TEXT_SEARCH_TEXT_ONLY</link>, the match may have
pixbufs or child widgets mixed inside the matched range. If these
flags are not given, the match must be exact; the special 0xFFFC
character in <parameter>str</parameter> will match embedded pixbufs or child widgets.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> start of search
</entry></row>
<row><entry align="right"><parameter>str</parameter>&nbsp;:</entry>
<entry> a search string
</entry></row>
<row><entry align="right"><parameter>flags</parameter>&nbsp;:</entry>
<entry> flags affecting how the search is done
</entry></row>
<row><entry align="right"><parameter>match_start</parameter>&nbsp;:</entry>
<entry> return location for start of match, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><parameter>match_end</parameter>&nbsp;:</entry>
<entry> return location for end of match, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><parameter>limit</parameter>&nbsp;:</entry>
<entry> bound for the search, or <literal>NULL</literal> for the end of the buffer
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether a match was found
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-backward-search">gtk_text_iter_backward_search ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_backward_search   (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="gchar">gchar</link> *str,
                                             <link linkend="GtkTextSearchFlags">GtkTextSearchFlags</link> flags,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_start,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *match_end,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *limit);</programlisting>
<para>
Same as <link linkend="gtk-text-iter-forward-search">gtk_text_iter_forward_search</link>(), but moves backward.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link> where the search begins
</entry></row>
<row><entry align="right"><parameter>str</parameter>&nbsp;:</entry>
<entry> search string
</entry></row>
<row><entry align="right"><parameter>flags</parameter>&nbsp;:</entry>
<entry> bitmask of flags affecting the search
</entry></row>
<row><entry align="right"><parameter>match_start</parameter>&nbsp;:</entry>
<entry> return location for start of match, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><parameter>match_end</parameter>&nbsp;:</entry>
<entry> return location for end of match, or <literal>NULL</literal>
</entry></row>
<row><entry align="right"><parameter>limit</parameter>&nbsp;:</entry>
<entry> location of last possible <parameter>match_start</parameter>, or <literal>NULL</literal> for start of buffer
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> whether a match was found
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-equal">gtk_text_iter_equal ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_equal             (const <link linkend="GtkTextIter">GtkTextIter</link> *lhs,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *rhs);</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">gtk_text_iter_compare</link>().</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>lhs</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>rhs</parameter>&nbsp;:</entry>
<entry> another <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if the iterators point to the same place in the buffer
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-compare">gtk_text_iter_compare ()</title>
<programlisting><link linkend="gint">gint</link>        gtk_text_iter_compare           (const <link linkend="GtkTextIter">GtkTextIter</link> *lhs,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *rhs);</programlisting>
<para>
A <link linkend="qsort">qsort</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>lhs</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>rhs</parameter>&nbsp;:</entry>
<entry> another <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> -1 if <parameter>lhs</parameter> is less than <parameter>rhs</parameter>, 1 if <parameter>lhs</parameter> is greater, 0 if they are equal
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-in-range">gtk_text_iter_in_range ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gtk_text_iter_in_range          (const <link linkend="GtkTextIter">GtkTextIter</link> *iter,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                             const <link linkend="GtkTextIter">GtkTextIter</link> *end);</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>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>iter</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>start</parameter>&nbsp;:</entry>
<entry> start of range
</entry></row>
<row><entry align="right"><parameter>end</parameter>&nbsp;:</entry>
<entry> end of range
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> <literal>TRUE</literal> if <parameter>iter</parameter> is in the range
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-text-iter-order">gtk_text_iter_order ()</title>
<programlisting>void        gtk_text_iter_order             (<link linkend="GtkTextIter">GtkTextIter</link> *first,
                                             <link linkend="GtkTextIter">GtkTextIter</link> *second);</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">gtk_text_iter_in_range</link>(),
that expect a pre-sorted range.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>first</parameter>&nbsp;:</entry>
<entry> a <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
<row><entry align="right"><parameter>second</parameter>&nbsp;:</entry>
<entry> another <link linkend="GtkTextIter">GtkTextIter</link>
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
