forked from AuroraMiddleware/gtk
b56118cf13
Wed Nov 21 15:57:29 2001 Owen Taylor <otaylor@redhat.com> * gtk/gtk-sections.txt: Updates * gtk/tmpl/gtkstock.sgml: Close end tags. * gtk/gtk.types: Remove interface types which gtk-doc can't handle currently. * gtk/tmpl/gtknotebook.sgml: Fix some garbage in file. * gdk/tmpl/x_interaction.sgml: Fix SGML errors. * gdk/gdk-overrides.txt gdk/gdk-sections.txt: Updates.
797 lines
8.6 KiB
Plaintext
797 lines
8.6 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkTextIter
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Text buffer iterator
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<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>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GtkTextIter ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_buffer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_line_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_line_index ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_visible_line_index ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_visible_line_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_slice ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@start:
|
|
@end:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_text ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@start:
|
|
@end:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_visible_slice ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@start:
|
|
@end:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_visible_text ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@start:
|
|
@end:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_marks ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_toggled_tags ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@toggled_on:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_child_anchor ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_begins_tag ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_ends_tag ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_toggles_tag ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_has_tag ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_tags ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_editable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@default_setting:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_can_insert ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@default_editability:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_starts_word ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_ends_word ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_inside_word ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_starts_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_ends_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_starts_sentence ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_ends_sentence ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_inside_sentence ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_is_cursor_position ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_chars_in_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_bytes_in_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_attributes ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@values:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_get_language ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_is_end ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_is_start ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_chars ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_chars ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_lines ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_lines ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_word_ends ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_word_starts ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_word_end ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_word_start ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_cursor_position ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_cursor_position ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_cursor_positions ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_cursor_positions ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_sentence_start ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_sentence_starts ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_sentence_end ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_sentence_ends ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@count:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@char_offset:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_line ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@line_number:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_line_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@char_on_line:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_line_index ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@byte_on_line:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_visible_line_index ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@byte_on_line:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_set_visible_line_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@char_on_line:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_to_end ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_to_line_end ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_to_tag_toggle ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_to_tag_toggle ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@tag:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GtkTextCharPredicate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@ch:
|
|
@user_data:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_find_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@pred:
|
|
@user_data:
|
|
@limit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_find_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@pred:
|
|
@user_data:
|
|
@limit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### ENUM GtkTextSearchFlags ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_TEXT_SEARCH_VISIBLE_ONLY:
|
|
@GTK_TEXT_SEARCH_TEXT_ONLY:
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_forward_search ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@str:
|
|
@flags:
|
|
@match_start:
|
|
@match_end:
|
|
@limit:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@visible_only:
|
|
@slice:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_backward_search ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@str:
|
|
@flags:
|
|
@match_start:
|
|
@match_end:
|
|
@limit:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@visible_only:
|
|
@slice:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_equal ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@lhs:
|
|
@rhs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_compare ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@lhs:
|
|
@rhs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_in_range ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@iter:
|
|
@start:
|
|
@end:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_text_iter_order ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@first:
|
|
@second:
|
|
|
|
|