]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtktextview.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtktextview.sgml
index 2ab94d5ba756cec6274b2b688aa5df22a796e359..bd8168d01590f8b8adb4184dd12b13a6f7ecc87a 100644 (file)
 GtkTextView
 
 <!-- ##### SECTION Short_Description ##### -->
+Widget that displays a GtkTextBuffer
 
+<!-- ##### 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>
+#GtkTextBuffer, #GtkTextIter
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT GtkTextView ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GtkTextView::backspace ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::delete-from-cursor ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextView::insert-at-cursor ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextView::move-cursor ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+@arg2: 
+@arg3: 
+
+<!-- ##### SIGNAL GtkTextView::move-viewport ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextView::page-horizontally ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::populate-popup ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextView::preedit-changed ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextView::select-all ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### SIGNAL GtkTextView::toggle-cursor-visible ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
+<para>
+
+</para>
+
+@textview: the object which received the signal.
+
+<!-- ##### ARG GtkTextView:accepts-tab ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:buffer ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:cursor-visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:editable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:im-module ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:indent ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:justification ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:left-margin ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:overwrite ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:pixels-above-lines ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:pixels-below-lines ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:pixels-inside-wrap ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:right-margin ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:tabs ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:wrap-mode ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTextView:error-underline-color ##### -->
+<para>
+
+</para>
+
+<!-- ##### ENUM GtkTextWindowType ##### -->
+<para>
+
+</para>
+
+@GTK_TEXT_WINDOW_PRIVATE: 
+@GTK_TEXT_WINDOW_WIDGET: 
+@GTK_TEXT_WINDOW_TEXT: 
+@GTK_TEXT_WINDOW_LEFT: 
+@GTK_TEXT_WINDOW_RIGHT: 
+@GTK_TEXT_WINDOW_TOP: 
+@GTK_TEXT_WINDOW_BOTTOM: 
+
+<!-- ##### FUNCTION gtk_text_view_new ##### -->
+<para>
+
+</para>
+
+@void: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_new_with_buffer ##### -->
+<para>
+
+</para>
+
+@buffer: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_buffer ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@buffer: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_buffer ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_hadjustment ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_vadjustment ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_scroll_to_mark ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@mark: 
+@within_margin: 
+@use_align: 
+@xalign: 
+@yalign: 
+
+
+<!-- ##### FUNCTION gtk_text_view_scroll_to_iter ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@iter: 
+@within_margin: 
+@use_align: 
+@xalign: 
+@yalign: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_scroll_mark_onscreen ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@mark: 
+
+
+<!-- ##### FUNCTION gtk_text_view_move_mark_onscreen ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@mark: 
+@Returns: 
 
-<!-- ##### SECTION Long_Description ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_place_cursor_onscreen ##### -->
 <para>
 
 </para>
 
-<!-- ##### SECTION See_Also ##### -->
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_visible_rect ##### -->
 <para>
 
 </para>
 
-<!-- ##### STRUCT GtkTextView ##### -->
+@text_view: 
+@visible_rect: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_iter_location ##### -->
 <para>
 
 </para>
 
+@text_view: 
+@iter: 
+@location: 
+
 
-<!-- ##### ENUM GtkTextViewMovementStep ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_line_at_y ##### -->
 <para>
 
 </para>
 
-@GTK_TEXT_MOVEMENT_CHAR: 
-@GTK_TEXT_MOVEMENT_POSITIONS: 
-@GTK_TEXT_MOVEMENT_WORD: 
-@GTK_TEXT_MOVEMENT_WRAPPED_LINE: 
-@GTK_TEXT_MOVEMENT_LINE: 
-@GTK_TEXT_MOVEMENT_LINE_ENDS: 
-@GTK_TEXT_MOVEMENT_BUFFER_ENDS: 
+@text_view: 
+@target_iter: 
+@y: 
+@line_top: 
 
-<!-- ##### ENUM GtkTextViewScrollType ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_get_line_yrange ##### -->
 <para>
 
 </para>
 
-@GTK_TEXT_SCROLL_TO_TOP: 
-@GTK_TEXT_SCROLL_TO_BOTTOM: 
-@GTK_TEXT_SCROLL_PAGE_DOWN: 
-@GTK_TEXT_SCROLL_PAGE_UP: 
+@text_view: 
+@iter: 
+@y: 
+@height: 
+
 
-<!-- ##### ENUM GtkTextViewDeleteType ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_iter_at_location ##### -->
 <para>
 
 </para>
 
-@GTK_TEXT_DELETE_CHAR: 
-@GTK_TEXT_DELETE_HALF_WORD: 
-@GTK_TEXT_DELETE_WHOLE_WORD: 
-@GTK_TEXT_DELETE_HALF_WRAPPED_LINE: 
-@GTK_TEXT_DELETE_WHOLE_WRAPPED_LINE: 
-@GTK_TEXT_DELETE_HALF_LINE: 
-@GTK_TEXT_DELETE_WHOLE_LINE: 
-@GTK_TEXT_DELETE_WHITESPACE: 
-@GTK_TEXT_DELETE_WHITESPACE_LEAVE_ONE: 
+@text_view: 
+@iter: 
+@x: 
+@y: 
 
-<!-- ##### FUNCTION gtk_text_view_new ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_get_iter_at_position ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@iter: 
+@trailing: 
+@x: 
+@y: 
+
+
+<!-- ##### FUNCTION gtk_text_view_buffer_to_window_coords ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@win: 
+@buffer_x: 
+@buffer_y: 
+@window_x: 
+@window_y: 
+
+
+<!-- ##### FUNCTION gtk_text_view_window_to_buffer_coords ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@win: 
+@window_x: 
+@window_y: 
+@buffer_x: 
+@buffer_y: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_window ##### -->
 <para>
 
 </para>
 
+@text_view: 
+@win: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_new_with_buffer ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_window_type ##### -->
 <para>
 
 </para>
 
-@buffer: 
+@text_view: 
+@window: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_set_buffer ##### -->
+<!-- ##### FUNCTION gtk_text_view_set_border_window_size ##### -->
 <para>
 
 </para>
 
 @text_view: 
-@buffer: 
+@type: 
+@size: 
 
 
-<!-- ##### FUNCTION gtk_text_view_get_buffer ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_border_window_size ##### -->
 <para>
 
 </para>
 
 @text_view: 
+@type: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_get_iter_at_pixel ##### -->
+<!-- ##### FUNCTION gtk_text_view_forward_display_line ##### -->
 <para>
 
 </para>
 
 @text_view: 
 @iter: 
-@x: 
-@y: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_scroll_to_mark ##### -->
+<!-- ##### FUNCTION gtk_text_view_backward_display_line ##### -->
 <para>
 
 </para>
 
 @text_view: 
-@mark: 
-@mark_within_margin: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_move_mark_onscreen ##### -->
+<!-- ##### FUNCTION gtk_text_view_forward_display_line_end ##### -->
 <para>
 
 </para>
 
 @text_view: 
-@mark
+@iter
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_place_cursor_onscreen ##### -->
+<!-- ##### FUNCTION gtk_text_view_backward_display_line_start ##### -->
 <para>
 
 </para>
 
 @text_view: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_get_visible_rect ##### -->
+<!-- ##### FUNCTION gtk_text_view_starts_display_line ##### -->
 <para>
 
 </para>
 
 @text_view: 
-@visible_rect: 
+@iter: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_move_visually ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@iter: 
+@count: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_add_child_at_anchor ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@child: 
+@anchor: 
+
+
+<!-- ##### STRUCT GtkTextChildAnchor ##### -->
+<para>
+A <structname>GtkTextChildAnchor</structname> is a spot in the buffer 
+where child widgets can be "anchored" (inserted inline, as if they were 
+characters). The anchor can have multiple widgets anchored, to allow for 
+multiple views.
+</para>
+
+
+<!-- ##### FUNCTION gtk_text_child_anchor_new ##### -->
+<para>
+
+</para>
+
+@void: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_child_anchor_get_widgets ##### -->
+<para>
+
+</para>
+
+@anchor: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_child_anchor_get_deleted ##### -->
+<para>
+
+</para>
+
+@anchor: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_add_child_in_window ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@child: 
+@which_window: 
+@xpos: 
+@ypos: 
+
+
+<!-- ##### FUNCTION gtk_text_view_move_child ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@child: 
+@xpos: 
+@ypos: 
 
 
 <!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### -->
@@ -197,119 +675,218 @@ GtkTextView
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_text_view_get_iter_location ##### -->
+<!-- ##### FUNCTION gtk_text_view_set_overwrite ##### -->
 <para>
 
 </para>
 
 @text_view: 
-@iter: 
-@location: 
+@overwrite: 
 
 
-<!-- ##### SIGNAL GtkTextView::move-insert ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_overwrite ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
-@arg1: 
-@arg2: 
-@arg3: 
+@text_view: 
+@Returns: 
 
-<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_set_pixels_above_lines ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
+@text_view: 
+@pixels_above_lines: 
+
 
-<!-- ##### SIGNAL GtkTextView::scroll-text ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_pixels_above_lines ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
-@arg1
+@text_view: 
+@Returns
 
-<!-- ##### SIGNAL GtkTextView::delete-text ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_set_pixels_below_lines ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
-@arg1
-@arg2: 
+@text_view: 
+@pixels_below_lines
+
 
-<!-- ##### SIGNAL GtkTextView::cut-text ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_pixels_below_lines ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
+@text_view: 
+@Returns: 
+
 
-<!-- ##### SIGNAL GtkTextView::copy-text ##### -->
+<!-- ##### FUNCTION gtk_text_view_set_pixels_inside_wrap ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
+@text_view: 
+@pixels_inside_wrap: 
 
-<!-- ##### SIGNAL GtkTextView::paste-text ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_get_pixels_inside_wrap ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
+@text_view: 
+@Returns: 
 
-<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_set_justification ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
+@text_view: 
+@justification: 
 
-<!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
+
+<!-- ##### FUNCTION gtk_text_view_get_justification ##### -->
 <para>
 
 </para>
 
-@textview: the object which received the signal.
-@arg1: 
-@arg2: 
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_left_margin ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@left_margin: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_left_margin ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_right_margin ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@right_margin: 
+
 
-<!-- ##### ARG GtkTextView:height_lines ##### -->
+<!-- ##### FUNCTION gtk_text_view_get_right_margin ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:width_columns ##### -->
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_indent ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:pixels_above_lines ##### -->
+@text_view: 
+@indent: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_indent ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:pixels_below_lines ##### -->
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_tabs ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:pixels_inside_wrap ##### -->
+@text_view: 
+@tabs: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_tabs ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:editable ##### -->
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_set_accepts_tab ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@accepts_tab: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_accepts_tab ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_get_default_attributes ##### -->
+<para>
+
+</para>
+
+@text_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_im_context_filter_keypress ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkTextView:wrap_mode ##### -->
+@text_view: 
+@event: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_text_view_reset_im_context ##### -->
 <para>
 
 </para>
 
+@text_view: 
+
+
+<!-- ##### MACRO GTK_TEXT_VIEW_PRIORITY_VALIDATE ##### -->
+<para>
+The priority at which the text view validates onscreen lines
+in an idle job in the background.
+</para>
+
+
+