Class

Gtk.TextView

Description [src]

class Gtk.TextView : Gtk.Widget {
  parent_instance: GtkWidget
}

A widget that displays the contents of a GtkTextBuffer.

An example GtkTextview

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

CSS nodes

textview.view
├── border.top
├── border.left
├── text
│   ╰── [selection]
├── border.right
├── border.bottom
╰── [window.popup]

GtkTextView has a main css node with name textview and style class .view, and subnodes for each of the border windows, and the main text area, with names border and text, respectively. The border nodes each get one of the style classes .left, .right, .top or .bottom.

A node representing the selection will appear below the text node.

If a context menu is opened, the window node will appear as a subnode of the main node.

Accessibility

GtkTextView uses the #GTK_ACCESSIBLE_ROLE_TEXT_BOX role.

Hierarchy

Ancestors

GtkWidget
GInitiallyUnowned
GObject

Implements

Constructors

gtk_text_view_new

Creates a new GtkTextView.

gtk_text_view_new_with_buffer

Creates a new GtkTextView widget displaying the buffer buffer.

Instance methods

gtk_text_view_add_child_at_anchor

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

gtk_text_view_add_overlay

Adds child at a fixed coordinate in the GtkTextView‘s text window.

gtk_text_view_backward_display_line

Moves the given iter backward by one display (wrapped) line.

gtk_text_view_backward_display_line_start

Moves the given iter backward to the next display line start.

gtk_text_view_buffer_to_window_coords

Converts buffer coordinates to window coordinates.

gtk_text_view_forward_display_line

Moves the given iter forward by one display (wrapped) line.

gtk_text_view_forward_display_line_end

Moves the given iter forward to the next display line end.

gtk_text_view_get_accepts_tab

Returns whether pressing the Tab key inserts a tab characters.

gtk_text_view_get_bottom_margin

Gets the bottom margin for text in the text_view.

gtk_text_view_get_buffer

Returns the GtkTextBuffer being displayed by this text view.

gtk_text_view_get_cursor_locations

Determine the positions of the strong and weak cursors if the insertion point is at iter.

gtk_text_view_get_cursor_visible

Find out whether the cursor should be displayed.

gtk_text_view_get_editable

Returns the default editability of the GtkTextView.

gtk_text_view_get_extra_menu

Gets the menu model that gets added to the context menu or NULL if none has been set.

gtk_text_view_get_gutter

Gets a GtkWidget that has previously been set as gutter.

gtk_text_view_get_indent

Gets the default indentation of paragraphs in text_view.

gtk_text_view_get_input_hints

Gets the input-hints of the GtkTextView.

gtk_text_view_get_input_purpose

Gets the input-purpose of the GtkTextView.

gtk_text_view_get_iter_at_location

Retrieves the iterator at buffer coordinates x and y.

gtk_text_view_get_iter_at_position

Retrieves the iterator pointing to the character at buffer coordinates x and y.

gtk_text_view_get_iter_location

Gets a rectangle which roughly contains the character at iter.

gtk_text_view_get_justification

Gets the default justification of paragraphs in text_view.

gtk_text_view_get_left_margin

Gets the default left margin size of paragraphs in the text_view.

gtk_text_view_get_line_at_y

Gets the GtkTextIter at the start of the line containing the coordinate y.

gtk_text_view_get_line_yrange

Gets the y coordinate of the top of the line containing iter, and the height of the line.

gtk_text_view_get_monospace

Gets whether the GtkTextView uses monospace styling.

gtk_text_view_get_overwrite

Returns whether the GtkTextView is in overwrite mode or not.

gtk_text_view_get_pixels_above_lines

Gets the default number of pixels to put above paragraphs.

gtk_text_view_get_pixels_below_lines

Gets the default number of pixels to put below paragraphs.

gtk_text_view_get_pixels_inside_wrap

Gets the default number of pixels to put between wrapped lines inside a paragraph.

gtk_text_view_get_right_margin

Gets the default right margin for text in text_view.

gtk_text_view_get_tabs

Gets the default tabs for text_view.

gtk_text_view_get_top_margin

Gets the top margin for text in the text_view.

gtk_text_view_get_visible_rect

Fills visible_rect with the currently-visible region of the buffer, in buffer coordinates.

gtk_text_view_get_wrap_mode

Gets the line wrapping for the view.

gtk_text_view_im_context_filter_keypress

Allow the GtkTextView input method to internally handle key press and release events.

gtk_text_view_move_mark_onscreen

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

gtk_text_view_move_overlay

Updates the position of a child.

gtk_text_view_move_visually

Move the iterator a given number of characters visually, treating it as the strong cursor position.

gtk_text_view_place_cursor_onscreen

Moves the cursor to the currently visible region of the buffer.

gtk_text_view_remove

Removes a child widget from text_view.

gtk_text_view_reset_cursor_blink

Ensures that the cursor is shown.

gtk_text_view_reset_im_context

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

gtk_text_view_scroll_mark_onscreen

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

gtk_text_view_scroll_to_iter

Scrolls text_view so that iter is on the screen in the position indicated by xalign and yalign.

gtk_text_view_scroll_to_mark

Scrolls text_view so that mark is on the screen in the position indicated by xalign and yalign.

gtk_text_view_set_accepts_tab

Sets the behavior of the text widget when the Tab key is pressed.

gtk_text_view_set_bottom_margin

Sets the bottom margin for text in text_view.

gtk_text_view_set_buffer

Sets buffer as the buffer being displayed by text_view.

gtk_text_view_set_cursor_visible

Toggles whether the insertion point should be displayed.

gtk_text_view_set_editable

Sets the default editability of the GtkTextView.

gtk_text_view_set_extra_menu

Sets a menu model to add when constructing the context menu for text_view.

gtk_text_view_set_gutter

Places widget into the gutter specified by win.

gtk_text_view_set_indent

Sets the default indentation for paragraphs in text_view.

gtk_text_view_set_input_hints

Sets the input-hints of the GtkTextView.

gtk_text_view_set_input_purpose

Sets the input-purpose of the GtkTextView.

gtk_text_view_set_justification

Sets the default justification of text in text_view.

gtk_text_view_set_left_margin

Sets the default left margin for text in text_view.

gtk_text_view_set_monospace

Sets whether the GtkTextView should display text in monospace styling.

gtk_text_view_set_overwrite

Changes the GtkTextView overwrite mode.

gtk_text_view_set_pixels_above_lines

Sets the default number of blank pixels above paragraphs in text_view.

gtk_text_view_set_pixels_below_lines

Sets the default number of pixels of blank space to put below paragraphs in text_view.

gtk_text_view_set_pixels_inside_wrap

Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph.

gtk_text_view_set_right_margin

Sets the default right margin for text in the text view.

gtk_text_view_set_tabs

Sets the default tab stops for paragraphs in text_view.

gtk_text_view_set_top_margin

Sets the top margin for text in text_view.

gtk_text_view_set_wrap_mode

Sets the line wrapping for the view.

gtk_text_view_starts_display_line

Determines whether iter is at the start of a display line.

gtk_text_view_window_to_buffer_coords

Converts coordinates on the window identified by win to buffer coordinates.

Methods inherited from GtkWidget (159)

Methods inherited from GtkAccessible (10)

gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)

gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkScrollable (9)

gtk_scrollable_get_border

Returns the size of a non-scrolling border around the outside of the scrollable.

gtk_scrollable_get_hadjustment

Retrieves the GtkAdjustment used for horizontal scrolling.

gtk_scrollable_get_hscroll_policy

Gets the horizontal GtkScrollablePolicy.

gtk_scrollable_get_vadjustment

Retrieves the GtkAdjustment used for vertical scrolling.

gtk_scrollable_get_vscroll_policy

Gets the vertical GtkScrollablePolicy.

gtk_scrollable_set_hadjustment

Sets the horizontal adjustment of the GtkScrollable.

gtk_scrollable_set_hscroll_policy

Sets the GtkScrollablePolicy.

gtk_scrollable_set_vadjustment

Sets the vertical adjustment of the GtkScrollable.

gtk_scrollable_set_vscroll_policy

Sets the GtkScrollablePolicy.

Properties inherited from GtkAccessible (1)

Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Class structure

struct GtkTextViewClass {
  GtkWidgetClass parent_class;
  void (* move_cursor) (
    GtkTextView* text_view,
    GtkMovementStep step,
    int count,
    gboolean extend_selection
  );
  void (* set_anchor) (
    GtkTextView* text_view
  );
  void (* insert_at_cursor) (
    GtkTextView* text_view,
    const char* str
  );
  void (* delete_from_cursor) (
    GtkTextView* text_view,
    GtkDeleteType type,
    int count
  );
  void (* backspace) (
    GtkTextView* text_view
  );
  void (* cut_clipboard) (
    GtkTextView* text_view
  );
  void (* copy_clipboard) (
    GtkTextView* text_view
  );
  void (* paste_clipboard) (
    GtkTextView* text_view
  );
  void (* toggle_overwrite) (
    GtkTextView* text_view
  );
  GtkTextBuffer* (* create_buffer) (
    GtkTextView* text_view
  );
  void (* snapshot_layer) (
    GtkTextView* text_view,
    GtkTextViewLayer layer,
    GtkSnapshot* snapshot
  );
  gboolean (* extend_selection) (
    GtkTextView* text_view,
    GtkTextExtendSelection granularity,
    const GtkTextIter* location,
    GtkTextIter* start,
    GtkTextIter* end
  );
  void (* insert_emoji) (
    GtkTextView* text_view
  );
  
}

Class members

`parent_class`	`GtkWidgetClass`
	The object class structure needs to be the first
`move_cursor`	`void (* move_cursor) ( GtkTextView* text_view, GtkMovementStep step, int count, gboolean extend_selection )`
	No description available.
`set_anchor`	`void (* set_anchor) ( GtkTextView* text_view )`
	No description available.
`insert_at_cursor`	`void (* insert_at_cursor) ( GtkTextView* text_view, const char* str )`
	No description available.
`delete_from_cursor`	`void (* delete_from_cursor) ( GtkTextView* text_view, GtkDeleteType type, int count )`
	No description available.
`backspace`	`void (* backspace) ( GtkTextView* text_view )`
	No description available.
`cut_clipboard`	`void (* cut_clipboard) ( GtkTextView* text_view )`
	No description available.
`copy_clipboard`	`void (* copy_clipboard) ( GtkTextView* text_view )`
	No description available.
`paste_clipboard`	`void (* paste_clipboard) ( GtkTextView* text_view )`
	No description available.
`toggle_overwrite`	`void (* toggle_overwrite) ( GtkTextView* text_view )`
	No description available.
`create_buffer`	`GtkTextBuffer* (* create_buffer) ( GtkTextView* text_view )`
	No description available.
`snapshot_layer`	`void (* snapshot_layer) ( GtkTextView* text_view, GtkTextViewLayer layer, GtkSnapshot* snapshot )`
	No description available.
`extend_selection`	`gboolean (* extend_selection) ( GtkTextView* text_view, GtkTextExtendSelection granularity, const GtkTextIter* location, GtkTextIter* start, GtkTextIter* end )`
	No description available.
`insert_emoji`	`void (* insert_emoji) ( GtkTextView* text_view )`
	No description available.