Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gtk / tmpl / gtktextbuffer.sgml

diff --git a/docs/reference/gtk/tmpl/gtktextbuffer.sgml b/docs/reference/gtk/tmpl/gtktextbuffer.sgml
index de02fed274343d470dbcd570b0634664f627be5d..f7cfdef3561c1add277d02093287150e5cc7d752 100644 (file)
--- a/docs/reference/gtk/tmpl/gtktextbuffer.sgml
+++ b/docs/reference/gtk/tmpl/gtktextbuffer.sgml
@@ -2,9 +2,7 @@
 GtkTextBuffer
 
 <!-- ##### SECTION Short_Description ##### -->
-
-Stores attributed text for display in a <link
-linkend="GtkTextView">GtkTextView</link>
+Stores attributed text for display in a GtkTextView
 
 <!-- ##### SECTION Long_Description ##### -->
 
@@ -23,6 +21,158 @@ types related to the text widget and how they work together.
 #GtkTextView, #GtkTextIter, #GtkTextMark
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT GtkTextBuffer ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+@arg3: 
+
+<!-- ##### SIGNAL GtkTextBuffer::begin-user-action ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextBuffer::delete-range ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextBuffer::end-user-action ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextBuffer::insert-child-anchor ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextBuffer::insert-pixbuf ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+@arg3: 
+
+<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextBuffer::paste-done ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
+<para>
+
+</para>
+
+@textbuffer: the object which received the signal.
+@arg1: 
+@arg2: 
+@arg3: 
+
+<!-- ##### ARG GtkTextBuffer:copy-target-list ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextBuffer:cursor-position ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextBuffer:has-selection ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextBuffer:paste-target-list ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextBuffer:tag-table ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextBuffer:text ##### -->
+<para>
+
+</para>
+
 <!-- ##### FUNCTION gtk_text_buffer_new ##### -->
 <para>
 
@@ -116,6 +266,45 @@ types related to the text widget and how they work together.
 @end: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_insert_range_interactive ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@start: 
+@end: 
+@default_editable: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_insert_with_tags ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@text: 
+@len: 
+@first_tag: 
+@Varargs: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_insert_with_tags_by_name ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@text: 
+@len: 
+@first_tag_name: 
+@Varargs: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_delete ##### -->
 <para>
 
@@ -124,9 +313,6 @@ types related to the text widget and how they work together.
 @buffer: 
 @start: 
 @end: 
-<!-- # Unused Parameters # -->
-@start_iter: 
-@end_iter: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_delete_interactive ##### -->
@@ -141,6 +327,18 @@ types related to the text widget and how they work together.
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_backspace ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@interactive: 
+@default_editable: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_set_text ##### -->
 <para>
 
@@ -161,9 +359,6 @@ types related to the text widget and how they work together.
 @end: 
 @include_hidden_chars: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@start_iter: 
-@end_iter: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_get_slice ##### -->
@@ -176,9 +371,6 @@ types related to the text widget and how they work together.
 @end: 
 @include_hidden_chars: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@start_iter: 
-@end_iter: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_insert_pixbuf ##### -->
@@ -191,6 +383,26 @@ types related to the text widget and how they work together.
 @pixbuf: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_insert_child_anchor ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@anchor: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_create_child_anchor ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_create_mark ##### -->
 <para>
 
@@ -213,6 +425,26 @@ types related to the text widget and how they work together.
 @where: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_move_mark_by_name ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@name: 
+@where: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_add_mark ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@mark: 
+@where: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_delete_mark ##### -->
 <para>
 
@@ -250,6 +482,24 @@ types related to the text widget and how they work together.
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_get_selection_bound ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_has_selection ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_place_cursor ##### -->
 <para>
 
@@ -259,6 +509,16 @@ types related to the text widget and how they work together.
 @where: 
 
 
+<!-- ##### FUNCTION gtk_text_buffer_select_range ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@ins: 
+@bound: 
+
+
 <!-- ##### FUNCTION gtk_text_buffer_apply_tag ##### -->
 <para>
 
@@ -266,8 +526,8 @@ types related to the text widget and how they work together.
 
 @buffer: 
 @tag: 
-@start_index: 
-@end_index: 
+@start: 
+@end: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
@@ -277,8 +537,8 @@ types related to the text widget and how they work together.
 
 @buffer: 
 @tag: 
-@start_index: 
-@end_index: 
+@start: 
+@end: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
@@ -288,8 +548,8 @@ types related to the text widget and how they work together.
 
 @buffer: 
 @name: 
-@start_index: 
-@end_index: 
+@start: 
+@end: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
@@ -299,8 +559,18 @@ types related to the text widget and how they work together.
 
 @buffer: 
 @name: 
-@start_index: 
-@end_index: 
+@start: 
+@end: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_remove_all_tags ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@start: 
+@end: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
@@ -310,6 +580,8 @@ types related to the text widget and how they work together.
 
 @buffer: 
 @tag_name: 
+@first_property_name: 
+@Varargs: 
 @Returns: 
 
 
@@ -344,46 +616,66 @@ types related to the text widget and how they work together.
 @line_number: 
 
 
-<!-- ##### FUNCTION gtk_text_buffer_get_last_iter ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 <para>
 
 </para>
 
 @buffer: 
 @iter: 
+@line_number: 
+@byte_index: 
 
 
-<!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 <para>
 
 </para>
 
 @buffer: 
-@start: 
-@end: 
+@iter: 
+@mark: 
 
 
-<!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 <para>
 
 </para>
 
 @buffer: 
 @iter: 
-@mark: 
+@anchor: 
 
 
-<!-- ##### FUNCTION gtk_text_buffer_get_tags ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_get_start_iter ##### -->
 <para>
 
 </para>
 
 @buffer: 
 @iter: 
-@Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_buffer_modified ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_get_end_iter ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@iter: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@start: 
+@end: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_modified ##### -->
 <para>
 
 </para>
@@ -418,10 +710,28 @@ types related to the text widget and how they work together.
 </para>
 
 @buffer: 
+@clipboard: 
+@override_location: 
+@default_editable: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@clipboard: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@clipboard: 
 @default_editable: 
-<!-- # Unused Parameters # -->
-@time: 
-@interactive: 
 
 
 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
@@ -435,75 +745,230 @@ types related to the text widget and how they work together.
 @Returns: 
 
 
-<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
+<!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
+@buffer: 
 
-<!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
+
+<!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
+@buffer: 
 
-<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
+
+<!-- ##### FUNCTION gtk_text_buffer_add_selection_clipboard ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
+@buffer: 
+@clipboard: 
 
-<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
+
+<!-- ##### FUNCTION gtk_text_buffer_remove_selection_clipboard ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
-@arg4: 
+@buffer: 
+@clipboard: 
 
-<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
+
+<!-- ##### ENUM GtkTextBufferTargetInfo ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
+@GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS: 
+@GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT: 
+@GTK_TEXT_BUFFER_TARGET_INFO_TEXT: 
 
-<!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
+<!-- ##### USER_FUNCTION GtkTextBufferDeserializeFunc ##### -->
+<para>
+A function that is called to deserialize rich text that has been
+serialized with gtk_text_buffer_serialize(), and insert it at @iter.
+</para>
+
+@register_buffer: the #GtkTextBuffer the format is registered with
+@content_buffer: the #GtkTextBuffer to deserialize into
+@iter: insertion point for the deserialized text
+@data: data to deserialize
+@length: length of %data
+@create_tags: %TRUE if deserializing may create tags
+@user_data: user data that was specified when registering the format
+@error: return location for a #GError
+@Returns: %TRUE on success, %FALSE otherwise
+
+
+<!-- ##### FUNCTION gtk_text_buffer_deserialize ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
-@arg2: 
+@register_buffer: 
+@content_buffer: 
+@format: 
+@iter: 
+@data: 
+@length: 
+@error: 
+@Returns: 
 
-<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
+
+<!-- ##### FUNCTION gtk_text_buffer_deserialize_get_can_create_tags ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
+@buffer: 
+@format: 
+@Returns: 
 
-<!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
+
+<!-- ##### FUNCTION gtk_text_buffer_deserialize_set_can_create_tags ##### -->
 <para>
 
 </para>
 
-@textbuffer: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
+@buffer: 
+@format: 
+@can_create_tags: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_copy_target_list ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_deserialize_formats ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@n_formats: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_paste_target_list ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_get_serialize_formats ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@n_formats: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_register_deserialize_format ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@mime_type: 
+@function: 
+@user_data: 
+@user_data_destroy: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_register_deserialize_tagset ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@tagset_name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_register_serialize_format ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@mime_type: 
+@function: 
+@user_data: 
+@user_data_destroy: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_register_serialize_tagset ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@tagset_name: 
+@Returns: 
+
+
+<!-- ##### USER_FUNCTION GtkTextBufferSerializeFunc ##### -->
+<para>
+A function that is called to serialize the content of a text buffer.
+It must return the serialized form of the content.
+</para>
+
+@register_buffer: the #GtkTextBuffer for which the format is registered
+@content_buffer: the #GtkTextsBuffer to serialize
+@start: start of the block of text to serialize
+@end: end of the block of text to serialize
+@length: Return location for the length of the serialized data
+@user_data: user data that was specified when registering the format
+@Returns: a newly-allocated array of guint8 which contains the serialized
+          data, or %NULL if an error occurred
+
+
+<!-- ##### FUNCTION gtk_text_buffer_serialize ##### -->
+<para>
+
+</para>
+
+@register_buffer: 
+@content_buffer: 
+@format: 
+@start: 
+@end: 
+@length: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_unregister_deserialize_format ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@format: 
+
+
+<!-- ##### FUNCTION gtk_text_buffer_unregister_serialize_format ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@format: 
+