You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.

Creates a new T. If you don't call SetBuffer before using the text view, an empty default buffer will be created for you. Get the buffer with GetBuffer. If you want to specify your own buffer, consider gtk_text_view_new_with_buffer().

Creates a new T widget displaying the buffer buffer. One buffer can be shared among many widgets. buffer may be NULL to create a default buffer, in which case this function is equivalent to gtk_text_view_new(). The text view adds its own reference count to the buffer; it does not take over an existing reference.

Adds a child widget in the text buffer, at the given anchor.

Adds a child at fixed coordinates in one of the text widget's windows. The window must have nonzero size (see SetBorderWindowSize). Note that the child coordinates are given relative to the Gtk.Gdk.Window.T in question, and that these coordinates have no sane relationship to scrolling. When placing a child in GTK_TEXT_WINDOW_WIDGET, scrolling is irrelevant, the child floats above all scrollable areas. But when placing a child in one of the scrollable windows (border windows or text window), you'll need to compute the child's correct position in buffer coordinates any time scrolling occurs or buffer changes occur, and then call MoveChild to update the child's position. Unfortunately there's no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes. See bug 64518 on bugzilla.gnome.org for status of fixing this issue.

Moves the given iter backward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view's width; paragraphs are the same in all views, since they depend on the contents of the Gtk.Gtk.TextBuffer.T.

Moves the given iter backward to the next display line start. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view's width; paragraphs are the same in all views, since they depend on the contents of the Gtk.Gtk.TextBuffer.T.

Converts coordinate (buffer_x, buffer_y) to coordinates for the window win, and stores the result in (window_x, window_y).

Note that you can't convert coordinates for a nonexisting window (see SetBorderWindowSize).

Moves the given iter forward by one display (wrapped) line. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view's width; paragraphs are the same in all views, since they depend on the contents of the Gtk.Gtk.TextBuffer.T.

Moves the given iter forward to the next display line end. A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view's width; paragraphs are the same in all views, since they depend on the contents of the Gtk.Gtk.TextBuffer.T.

Returns whether pressing the Tab key inserts a tab characters. SetAcceptsTab.

Gets the width of the specified border window. See SetBorderWindowSize.

Returns the Gtk.Gtk.TextBuffer.T being displayed by this text view. The reference count on the buffer is not incremented; the caller of this function won't own a new reference.

Find out whether the cursor is being displayed.

Obtains a copy of the default text attributes. These are the attributes used for text unless a tag overrides them. You'd typically pass the default attributes in to Gtk.Gtk.TextIter.GetAttributes in order to get the attributes in effect at a given text position.

The return value is a copy owned by the caller of this function, and should be freed.

Returns the default editability of the T. Tags in the buffer may override this setting for some ranges of text.

Gets the horizontal-scrolling Gtk.Gtk.Adjustment.T.

Gets the default indentation of paragraphs in text_view. Tags in the view's buffer may override the default. The indentation may be negative.

Retrieves the iterator at buffer coordinates x and y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with WindowToBufferCoords.

Retrieves the iterator pointing to the character at buffer coordinates x and y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with WindowToBufferCoords.

Note that this is different from GetIterAtLocation, which returns cursor locations, i.e. positions between characters.

Gets a rectangle which roughly contains the character at iter. The rectangle position is in buffer coordinates; use BufferToWindowCoords to convert these coordinates to coordinates for one of the windows in the text view.

Gets the default justification of paragraphs in text_view. Tags in the buffer may override the default.

Gets the default left margin size of paragraphs in the text_view. Tags in the buffer may override the default.

Gets the Gtk.Gtk.TextIter.T at the start of the line containing the coordinate y. y is in buffer coordinates, convert from window coordinates with WindowToBufferCoords. If non-NULL, line_top will be filled with the coordinate of the top edge of the line.

Gets the y coordinate of the top of the line containing iter, and the height of the line. The coordinate is a buffer coordinate; convert to window coordinates with BufferToWindowCoords.

Returns whether the T is in overwrite mode or not.

Gets the default number of pixels to put above paragraphs.

Gets the value set by SetPixelsBelowLines.

Gets the value set by SetPixelsInsideWrap.

Gets the default right margin for text in text_view. Tags in the buffer may override the default.

Gets the default tabs for text_view. Tags in the buffer may override the defaults. The returned array will be NULL if "standard" (8-space) tabs are used. Free the return value with pango_tab_array_free().

Gets the vertical-scrolling Gtk.Gtk.Adjustment.T.

Fills visible_rect with the currently-visible region of the buffer, in buffer coordinates. Convert to window coordinates with BufferToWindowCoords.

Retrieves the Gtk.Gdk.Window.T corresponding to an area of the text view; possible windows include the overall widget window, child windows on the left, right, top, bottom, and the window that displays the text buffer. Windows are NULL and nonexistent if their width or height is 0, and are nonexistent before the widget has been realized.

Usually used to find out which window an event corresponds to. If you connect to an event signal on text_view, this function should be called on event->window to see which window it was.

Gets the line wrapping for the view.

Allow the T input method to internally handle key press and release events. If this function returns TRUE, then no further processing should be done for this key event. See Gtk.Gtk.IMContext.FilterKeypress.

Note that you are expected to call this function from your handler when overriding key event handling. This is needed in the case when you need to insert your own key handling between the input method and the default key event handling of the T.

1
2
3
4
5
6
7
8
9
10
11
12
13
14

static gboolean
gtk_foo_bar_key_press_event (GtkWidget   *widget,
                             GdkEventKey *event)
{
  if ((key->keyval == GDK_Return || key->keyval == GDK_KP_Enter))
    {
      if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (view), event))
        return TRUE;
    }

    /* Do some stuff */

  return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
}

Updates the position of a child, as for AddChildInWindow.

Moves a mark within the buffer so that it's located within the currently-visible text area.

Move the iterator a given number of characters visually, treating it as the strong cursor position. If count is positive, then the new strong cursor position will be count positions to the right of the old cursor position. If count is negative then the new strong cursor position will be count positions to the left of the old cursor position.

In the presence of bi-directional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.

Moves the cursor to the currently visible region of the buffer, it it isn't there already.

Reset the input method context of the text view if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

Scrolls text_view the minimum distance such that mark is contained within the visible area of the widget.

Scrolls text_view so that iter is on the screen in the position indicated by xalign and yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If use_align is FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size within_margin.

Note that this function uses the currently-computed height of the lines in the text buffer. Line heights are computed in an idle handler; so this function may not have the desired effect if it's called before the height computations. To avoid oddness, consider using ScrollToMark which saves a point to be scrolled to after line validation.

Scrolls text_view so that mark is on the screen in the position indicated by xalign and yalign. An alignment of 0.0 indicates left or top, 1.0 indicates right or bottom, 0.5 means center. If use_align is FALSE, the text scrolls the minimal distance to get the mark onscreen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size within_margin.

Sets the behavior of the text widget when the Tab key is pressed. If accepts_tab is TRUE, a tab character is inserted. If accepts_tab is FALSE the keyboard focus is moved to the next widget in the focus chain.

Sets the width of Gtk.Gtk.TextWindowType.Left or Gtk.Gtk.TextWindowType.Right, or the height of Gtk.Gtk.TextWindowType.Top or Gtk.Gtk.TextWindowType.Bottom. Automatically destroys the corresponding window if the size is set to 0, and creates the window if the size is set to non-zero. This function can only be used for the "border windows," it doesn't work with GTK_TEXT_WINDOW_WIDGET, GTK_TEXT_WINDOW_TEXT, or GTK_TEXT_WINDOW_PRIVATE.

Sets buffer as the buffer being displayed by text_view. The previous buffer displayed by the text view is unreferenced, and a reference is added to buffer. If you owned a reference to buffer before passing it to this function, you must remove that reference yourself; T will not "adopt" it.

Toggles whether the insertion point is displayed. A buffer with no editable text probably shouldn't have a visible cursor, so you may want to turn the cursor off.

Sets the default editability of the T. You can override this default setting with tags in the buffer, using the "editable" attribute of tags.

Sets the default indentation for paragraphs in text_view. Tags in the buffer may override the default.

Sets the default justification of text in text_view. Tags in the view's buffer may override the default.

Sets the default left margin for text in text_view. Tags in the buffer may override the default.

Changes the T overwrite mode.

Sets the default number of blank pixels above paragraphs in text_view. Tags in the buffer for text_view may override the defaults.

Sets the default number of pixels of blank space to put below paragraphs in text_view. May be overridden by tags applied to text_view's buffer.

Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph. May be overridden by tags in text_view's buffer.

Sets the default right margin for text in the text view. Tags in the buffer may override the default.

Sets the default tab stops for paragraphs in text_view. Tags in the buffer may override the default.

Sets the line wrapping for the view.

Determines whether iter is at the start of a display line. See ForwardDisplayLine for an explanation of display lines vs. paragraphs.

Converts coordinates on the window identified by win to buffer coordinates, storing the result in (buffer_x,buffer_y).

Note that you can't convert coordinates for a nonexisting window (see SetBorderWindowSize).