Module `Wrappers.Text_buffer`

type t = [ `text_buffer | `object_ ] Gobject.obj

val new_ : [ `text_tag_table | `object_ ] Gobject.obj option -> t

Create a new TextBuffer

val undo : t -> unit

Undoes the last undoable action on the buffer, if there is one.

val set_text : t -> string -> int -> unit

Deletes current contents of @buffer, and inserts @text instead. This is automatically marked as an irreversible action in the undo stack. If you wish to mark this action as part of a larger undo operation, call method@TextBuffer.delete and method@TextBuffer.insert directly instead.

If @len is -1, @text must be nul-terminated. @text must be valid UTF-8.

val set_modified : t -> bool -> unit

Used to keep track of whether the buffer has been modified since the last time it was saved.

Whenever the buffer is saved to disk, call `gtk_text_buffer_set_modified (@buffer, FALSE)`. When the buffer is modified, it will automatically toggle on the modified bit again. When the modified bit flips, the buffer emits the signal@Gtk.TextBuffer::modified-changed signal.

val set_max_undo_levels : t -> int -> unit

Sets the maximum number of undo levels to perform.

If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.

val set_enable_undo : t -> bool -> unit

Sets whether or not to enable undoable actions in the text buffer.

Undoable actions in this context are changes to the text content of the buffer. Changes to tags and marks are not tracked.

If enabled, the user will be able to undo the last number of actions up to method@Gtk.TextBuffer.get_max_undo_levels.

See method@Gtk.TextBuffer.begin_irreversible_action and method@Gtk.TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.

val select_range : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

This function moves the “insert” and “selection_bound” marks simultaneously.

If you move them in two steps with method@Gtk.TextBuffer.move_mark, you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.

val remove_tag_by_name : 
  t ->
  string ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Emits the “remove-tag” signal.

Calls method@Gtk.TextTagTable.lookup on the buffer’s tag table to get a `GtkTextTag`, then calls method@Gtk.TextBuffer.remove_tag.

val remove_tag : 
  t ->
  [ `text_tag | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Emits the “remove-tag” signal.

The default handler for the signal removes all occurrences of @tag from the given range. @start and @end don’t have to be in order.

val remove_selection_clipboard : 
  t ->
  Ocgtk_gdk.Gdk.Wrappers.Clipboard.t ->
  unit

Removes a `GdkClipboard` added with method@Gtk.TextBuffer.add_selection_clipboard

val remove_all_tags : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Removes all tags in the range between @start and @end.

Be careful with this function; it could remove tags added in code unrelated to the code you’re currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags.

val redo : t -> unit

Redoes the next redoable action on the buffer, if there is one.

val place_cursor : t -> [ `text_iter ] Gobject.obj -> unit

This function moves the “insert” and “selection_bound” marks simultaneously.

If you move them to the same place in two steps with method@Gtk.TextBuffer.move_mark, you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.

val paste_clipboard : 
  t ->
  Ocgtk_gdk.Gdk.Wrappers.Clipboard.t ->
  [ `text_iter ] Gobject.obj option ->
  bool ->
  unit

Pastes the contents of a clipboard.

If @override_location is %NULL, the pasted text will be inserted at the cursor position, or the buffer selection will be replaced if the selection is non-empty.

Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted.

val move_mark_by_name : t -> string -> [ `text_iter ] Gobject.obj -> unit

Moves the mark named @name (which must exist) to location @where.

See method@Gtk.TextBuffer.move_mark for details.

val move_mark : 
  t ->
  [ `text_mark | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Moves @mark to the new location @where.

Emits the signal@Gtk.TextBuffer::mark-set signal as notification of the move.

val insert_range_interactive : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  bool ->
  bool

Copies text, tags, and paintables between @start and @end and inserts the copy at @iter.

Same as method@Gtk.TextBuffer.insert_range, but does nothing if the insertion point isn’t editable. The @default_editable parameter indicates whether the text is editable at @iter if no tags enclosing @iter affect editability. Typically the result of method@Gtk.TextView.get_editable is appropriate here.

val insert_range : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Copies text, tags, and paintables between @start and @end and inserts the copy at @iter.

The order of @start and @end doesn’t matter.

Used instead of simply getting/inserting text because it preserves images and tags. If @start and @end are in a different buffer from @buffer, the two buffers must share the same tag table.

Implemented via emissions of the ::insert-text and ::apply-tag signals, so expect those.

val insert_paintable : 
  t ->
  [ `text_iter ] Gobject.obj ->
  Ocgtk_gdk.Gdk.Wrappers.Paintable.t ->
  unit

Inserts an image into the text buffer at @iter.

The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for paintable, but the “text” variants do not. e.g. see method@Gtk.TextBuffer.get_slice and method@Gtk.TextBuffer.get_text.

val insert_markup : t -> [ `text_iter ] Gobject.obj -> string -> int -> unit

Inserts the text in @markup at position @iter.

@markup will be inserted in its entirety and must be nul-terminated and valid UTF-8. Emits the signal@Gtk.TextBuffer::insert-text signal, possibly multiple times; insertion actually occurs in the default handler for the signal. @iter will point to the end of the inserted text on return.

val insert_interactive_at_cursor : t -> string -> int -> bool -> bool

Inserts @text in @buffer.

Calls method@Gtk.TextBuffer.insert_interactive at the cursor position.

@default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of method@Gtk.TextView.get_editable is appropriate here.

val insert_interactive : 
  t ->
  [ `text_iter ] Gobject.obj ->
  string ->
  int ->
  bool ->
  bool

Inserts @text in @buffer.

Like method@Gtk.TextBuffer.insert, but the insertion will not occur if @iter is at a non-editable location in the buffer. Usually you want to prevent insertions at ineditable locations if the insertion results from a user action (is interactive).

@default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of method@Gtk.TextView.get_editable is appropriate here.

val insert_child_anchor : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_child_anchor | `object_ ] Gobject.obj ->
  unit

Inserts a child widget anchor into the text buffer at @iter.

The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for child anchors, but the “text” variants do not. E.g. see method@Gtk.TextBuffer.get_slice and method@Gtk.TextBuffer.get_text.

Consider method@Gtk.TextBuffer.create_child_anchor as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.

val insert_at_cursor : t -> string -> int -> unit

Inserts @text in @buffer.

Simply calls method@Gtk.TextBuffer.insert, using the current cursor position as the insertion point.

val insert : t -> [ `text_iter ] Gobject.obj -> string -> int -> unit

Inserts @len bytes of @text at position @iter.

If @len is -1, @text must be nul-terminated and will be inserted in its entirety. Emits the “insert-text” signal; insertion actually occurs in the default handler for the signal. @iter is invalidated when insertion occurs (because the buffer contents change), but the default signal handler revalidates it to point to the end of the inserted text.

val get_text : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  bool ->
  string

Returns the text in the range @start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. Does not include characters representing embedded images, so byte and character indexes into the returned string do not correspond to byte and character indexes into the buffer. Contrast with [method@Gtk.TextBuffer.get_slice].

val get_tag_table : t -> [ `text_tag_table | `object_ ] Gobject.obj

Get the `GtkTextTagTable` associated with this buffer.

val get_start_iter : t -> [ `text_iter ] Gobject.obj

Initialized @iter with the first position in the text buffer.

This is the same as using method@Gtk.TextBuffer.get_iter_at_offset to get the iter at character offset 0.

val get_slice : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  bool ->
  string

Returns the text in the range @start,@end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if @include_hidden_chars is %FALSE. The returned string includes a 0xFFFC character whenever the buffer contains embedded images, so byte and character indexes into the returned string do correspond to byte and character indexes into the buffer. Contrast with [method@Gtk.TextBuffer.get_text]. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a paintable or widget is in the buffer.

val get_selection_content : t -> Ocgtk_gdk.Gdk.Wrappers.Content_provider.t

Get a content provider for this buffer.

It can be used to make the content of @buffer available in a `GdkClipboard`, see method@Gdk.Clipboard.set_content.

val get_selection_bounds : 
  t ->
  bool * [ `text_iter ] Gobject.obj * [ `text_iter ] Gobject.obj

Returns %TRUE if some text is selected; places the bounds of the selection in @start and @end.

If the selection has length 0, then @start and @end are filled in with the same value. @start and @end will be in ascending order. If @start and @end are %NULL, then they are not filled in, but the return value still indicates whether text is selected.

val get_selection_bound : t -> [ `text_mark | `object_ ] Gobject.obj

Returns the mark that represents the selection bound.

Equivalent to calling method@Gtk.TextBuffer.get_mark to get the mark named “selection_bound”, but very slightly more efficient, and involves less typing.

The currently-selected text in @buffer is the region between the “selection_bound” and “insert” marks. If “selection_bound” and “insert” are in the same place, then there is no current selection. method@Gtk.TextBuffer.get_selection_bounds is another convenient function for handling the selection, if you just want to know whether there’s a selection and what its bounds are.

val get_modified : t -> bool

Indicates whether the buffer has been modified since the last call to method@Gtk.TextBuffer.set_modified set the modification flag to %FALSE.

Used for example to enable a “save” function in a text editor.

val get_max_undo_levels : t -> int

Gets the maximum number of undo levels to perform.

If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.

val get_mark : t -> string -> [ `text_mark | `object_ ] Gobject.obj option

Returns the mark named @name in buffer @buffer, or %NULL if no such mark exists in the buffer.

val get_line_count : t -> int

Obtains the number of lines in the buffer.

This value is cached, so the function is very fast.

val get_iter_at_offset : t -> int -> [ `text_iter ] Gobject.obj

Initializes @iter to a position @char_offset chars from the start of the entire buffer.

If @char_offset is -1 or greater than the number of characters in the buffer, @iter is initialized to the end iterator, the iterator one past the last valid character in the buffer.

val get_iter_at_mark : 
  t ->
  [ `text_mark | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj

Initializes @iter with the current position of @mark.

val get_iter_at_line_offset : 
  t ->
  int ->
  int ->
  bool * [ `text_iter ] Gobject.obj

Obtains an iterator pointing to @char_offset within the given line.

Note characters, not bytes; UTF-8 may encode one character as multiple bytes.

If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned. And if @char_offset is off the end of the line, the iterator at the end of the line is returned.

val get_iter_at_line_index : 
  t ->
  int ->
  int ->
  bool * [ `text_iter ] Gobject.obj

Obtains an iterator pointing to @byte_index within the given line.

@byte_index must be the start of a UTF-8 character. Note bytes, not characters; UTF-8 may encode one character as multiple bytes.

If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned. And if @byte_index is off the end of the line, the iterator at the end of the line is returned.

val get_iter_at_line : t -> int -> bool * [ `text_iter ] Gobject.obj

Initializes @iter to the start of the given line.

If @line_number is greater than or equal to the number of lines in the @buffer, the end iterator is returned.

val get_iter_at_child_anchor : 
  t ->
  [ `text_child_anchor | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj

Obtains the location of @anchor within @buffer.

val get_insert : t -> [ `text_mark | `object_ ] Gobject.obj

Returns the mark that represents the cursor (insertion point).

Equivalent to calling method@Gtk.TextBuffer.get_mark to get the mark named “insert”, but very slightly more efficient, and involves less typing.

val get_has_selection : t -> bool

Indicates whether the buffer has some text currently selected.

val get_end_iter : t -> [ `text_iter ] Gobject.obj

Initializes @iter with the “end iterator,” one past the last valid character in the text buffer.

If dereferenced with method@Gtk.TextIter.get_char, the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call method@Gtk.TextBuffer.get_start_iter to get character position 0) to the end iterator.

val get_enable_undo : t -> bool

Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions.

See method@Gtk.TextBuffer.begin_irreversible_action and method@Gtk.TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.

val get_char_count : t -> int

Gets the number of characters in the buffer.

Note that characters and bytes are not the same, you can’t e.g. expect the contents of the buffer in string form to be this many bytes long.

The character count is cached, so this function is very fast.

val get_can_undo : t -> bool

Gets whether there is an undoable action in the history.

val get_can_redo : t -> bool

Gets whether there is a redoable action in the history.

val get_bounds : t -> [ `text_iter ] Gobject.obj * [ `text_iter ] Gobject.obj

Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range @start,@end).

val end_user_action : t -> unit

Ends a user-visible operation.

Should be paired with a call to method@Gtk.TextBuffer.begin_user_action. See that function for a full explanation.

val end_irreversible_action : t -> unit

Denotes the end of an action that may not be undone.

This will cause any previous operations in the undo/redo queue to be cleared.

This should be called after completing modifications to the text buffer after method@Gtk.TextBuffer.begin_irreversible_action was called.

You may nest calls to gtk_text_buffer_begin_irreversible_action() and gtk_text_buffer_end_irreversible_action() pairs.

val delete_selection : t -> bool -> bool -> bool

Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text.

If @interactive is %TRUE, the editability of the selection will be considered (users can’t delete uneditable text).

val delete_mark_by_name : t -> string -> unit

Deletes the mark named @name; the mark must exist.

See method@Gtk.TextBuffer.delete_mark for details.

val delete_mark : t -> [ `text_mark | `object_ ] Gobject.obj -> unit

Deletes @mark, so that it’s no longer located anywhere in the buffer.

Removes the reference the buffer holds to the mark, so if you haven’t called g_object_ref() on the mark, it will be freed. Even if the mark isn’t freed, most operations on @mark become invalid, until it gets added to a buffer again with method@Gtk.TextBuffer.add_mark. Use method@Gtk.TextMark.get_deleted to find out if a mark has been removed from its buffer.

The signal@Gtk.TextBuffer::mark-deleted signal will be emitted as notification after the mark is deleted.

val delete_interactive : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  bool ->
  bool

Deletes all editable text in the given range.

Calls method@Gtk.TextBuffer.delete for each editable sub-range of @start,@end). @start and @end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted.

val delete : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Deletes text between @start and @end.

The order of @start and @end is not actually relevant; gtk_text_buffer_delete() will reorder them.

This function actually emits the “delete-range” signal, and the default handler of that signal deletes the text. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the @start and @end will be re-initialized to point to the location where text was deleted.

val cut_clipboard : t -> Ocgtk_gdk.Gdk.Wrappers.Clipboard.t -> bool -> unit

Copies the currently-selected text to a clipboard, then deletes said text if it’s editable.

val create_mark : 
  t ->
  string option ->
  [ `text_iter ] Gobject.obj ->
  bool ->
  [ `text_mark | `object_ ] Gobject.obj

Creates a mark at position @where.

If @mark_name is %NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using method@Gtk.TextBuffer.get_mark. If a mark has left gravity, and text is inserted at the mark’s current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (@left_gravity = %FALSE), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you’re typing).

The caller of this function does not own a reference to the returned `GtkTextMark`, so you can ignore the return value if you like. Marks are owned by the buffer and go away when the buffer does.

Emits the signal@Gtk.TextBuffer::mark-set signal as notification of the mark's initial placement.

val create_child_anchor : 
  t ->
  [ `text_iter ] Gobject.obj ->
  [ `text_child_anchor | `object_ ] Gobject.obj

Creates and inserts a child anchor.

This is a convenience function which simply creates a child anchor with ctor@Gtk.TextChildAnchor.new and inserts it into the buffer with method@Gtk.TextBuffer.insert_child_anchor.

The new anchor is owned by the buffer; no reference count is returned to the caller of this function.

val copy_clipboard : t -> Ocgtk_gdk.Gdk.Wrappers.Clipboard.t -> unit

Copies the currently-selected text to a clipboard.

val begin_user_action : t -> unit

Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation.

The operations between gtk_text_buffer_begin_user_action() and gtk_text_buffer_end_user_action() can then be grouped when creating an undo stack. `GtkTextBuffer` maintains a count of calls to gtk_text_buffer_begin_user_action() that have not been closed with a call to gtk_text_buffer_end_user_action(), and emits the “begin-user-action” and “end-user-action” signals only for the outermost pair of calls. This allows you to build user actions from other user actions.

The “interactive” buffer mutation functions, such as method@Gtk.TextBuffer.insert_interactive, automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those functions.

val begin_irreversible_action : t -> unit

Denotes the beginning of an action that may not be undone.

This will cause any previous operations in the undo/redo queue to be cleared.

This should be paired with a call to method@Gtk.TextBuffer.end_irreversible_action after the irreversible action has completed.

You may nest calls to gtk_text_buffer_begin_irreversible_action() and gtk_text_buffer_end_irreversible_action() pairs.

val backspace : t -> [ `text_iter ] Gobject.obj -> bool -> bool -> bool

Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by @iter.

In the normal case a single character will be deleted, but when combining accents are involved, more than one character can be deleted, and when precomposed character and accent combinations are involved, less than one character will be deleted.

Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the @iter will be re-initialized to point to the location where text was deleted.

val apply_tag_by_name : 
  t ->
  string ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Emits the “apply-tag” signal on @buffer.

Calls method@Gtk.TextTagTable.lookup on the buffer’s tag table to get a `GtkTextTag`, then calls method@Gtk.TextBuffer.apply_tag.

val apply_tag : 
  t ->
  [ `text_tag | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Emits the “apply-tag” signal on @buffer.

The default handler for the signal applies @tag to the given range. @start and @end do not have to be in order.

val add_selection_clipboard : t -> Ocgtk_gdk.Gdk.Wrappers.Clipboard.t -> unit

Adds @clipboard to the list of clipboards in which the selection contents of @buffer are available.

In most cases, @clipboard will be the `GdkClipboard` returned by method@Gtk.Widget.get_primary_clipboard for a view of @buffer.

val add_mark : 
  t ->
  [ `text_mark | `object_ ] Gobject.obj ->
  [ `text_iter ] Gobject.obj ->
  unit

Adds the mark at position @where.

The mark must not be added to another buffer, and if its name is not %NULL then there must not be another mark in the buffer with the same name.

Emits the signal@Gtk.TextBuffer::mark-set signal as notification of the mark's initial placement.

val get_cursor_position : t -> int

Get property: cursor-position

val on_begin_user_action : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_changed : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_end_user_action : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_mark_deleted : 
  ?after:bool ->
  t ->
  callback:(mark:[ `text_mark | `object_ ] Gobject.obj -> unit) ->
  Gobject.Signal.handler_id

val on_modified_changed : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_paste_done : 
  ?after:bool ->
  t ->
  callback:(clipboard:Ocgtk_gdk.Gdk.Wrappers.Clipboard.t -> unit) ->
  Gobject.Signal.handler_id

val on_redo : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

val on_undo : 
  ?after:bool ->
  t ->
  callback:(unit -> unit) ->
  Gobject.Signal.handler_id

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Text_buffer/index.html

Module `Wrappers.Text_buffer`

package ocgtk

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Text_buffer/index.html

Module Wrappers.Text_buffer

dune-project
Dependency

Module `Wrappers.Text_buffer`