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 text buffer.

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 "mark-set" signal as notification of the mark's initial placement.

Adds clipboard to the list of clipboards in which the selection contents of buffer are available. In most cases, clipboard will be the Gtk.Gtk.Clipboard.T of type GDK_SELECTION_PRIMARY for a view of buffer.

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.

Calls Gtk.Gtk.TextTagTable.Lookup on the buffer's tag table to get a Gtk.Gtk.TextTag.T, then calls ApplyTag.

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.

Called to indicate that the buffer operations between here and a call to EndUserAction are part of a single user-visible operation. The operations between BeginUserAction and EndUserAction can then be grouped when creating an undo stack. T maintains a count of calls to BeginUserAction that have not been closed with a call to EndUserAction, 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 InsertInteractive, 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.

Copies the currently-selected text to a clipboard.

This is a convenience function which simply creates a child anchor with gtk_text_child_anchor_new() and inserts it into the buffer with InsertChildAnchor. The new anchor is owned by the buffer; no reference count is returned to the caller of CreateChildAnchor.

Creates a mark at position where. If mark_name is NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using GetMark. 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 Gtk.Gtk.TextMark.T, 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 "mark-set" signal as notification of the mark's initial placement.

Creates a tag and adds it to the tag table for buffer. Equivalent to calling gtk_text_tag_new() and then adding the tag to the buffer's tag table. The returned tag is owned by the buffer's tag table, so the ref count will be equal to one.

If tag_name is NULL, the tag is anonymous.

If tag_name is non-NULL, a tag called tag_name must not already exist in the tag table for this buffer.

The first_property_name argument and subsequent arguments are a list of properties to set on the tag, as with g_object_set().

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

Deletes text between start and end. The order of start and end is not actually relevant; 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.

Deletes all editable text in the given range. Calls 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.

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 AddMark. Use Gtk.Gtk.TextMark.GetDeleted to find out if a mark has been removed from its buffer. The "mark-deleted" signal will be emitted as notification after the mark is deleted.

Deletes the mark named name; the mark must exist. See DeleteMark for details.

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).

This function deserializes rich text in format format and inserts it at iter.

formats to be used must be registered using RegisterDeserializeFormat or RegisterDeserializeTagset beforehand.

This functions returns the value set with DeserializeSetCanCreateTags

Use this function to allow a rich text deserialization function to create new tags in the receiving buffer. Note that using this function is almost always a bad idea, because the rich text functions you register should know how to map the rich text format they handler to your text buffers set of tags.

The ability of creating new (arbitrary!) tags in the receiving buffer is meant for special rich text formats like the internal one that is registered using RegisterDeserializeTagset, because that format is essentially a dump of the internal structure of the source buffer, including its tag names.

You should allow creation of tags only if you know what you are doing, e.g. if you defined a tagset name for your application suite's text buffers and you know that it's fine to receive new tags from these buffers, because you know that your application can handle the newly created tags.

Should be paired with a call to BeginUserAction. See that function for a full explanation.

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

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.

This function returns the list of targets this text buffer can provide for copying and as DND source. The targets in the list are added with info values from the Gtk.Gtk.TextBufferTargetInfo.T enum, using Gtk.Gtk.TargetList.AddRichTextTargets and Gtk.Gtk.TargetList.AddTextTargets.

This function returns the rich text deserialize formats registered with buffer using RegisterDeserializeFormat or RegisterDeserializeTagset

Initializes iter with the "end iterator," one past the last valid character in the text buffer. If dereferenced with Gtk.Gtk.TextIter.GetChar, the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call GetStartIter to get character position 0) to the end iterator.

Indicates whether the buffer has some text currently selected.

Returns the mark that represents the cursor (insertion point). Equivalent to calling GetMark to get the mark named "insert", but very slightly more efficient, and involves less typing.

Obtains the location of anchor within buffer.

Initializes iter to the start of the given line.

Obtains an iterator pointing to byte_index within the given line. byte_index must be the start of a UTF-8 character, and must not be beyond the end of the line. Note bytes, not characters; UTF-8 may encode one character as multiple bytes.

Obtains an iterator pointing to char_offset within the given line. The char_offset must exist, offsets off the end of the line are not allowed. Note characters, not bytes; UTF-8 may encode one character as multiple bytes.

Initializes iter with the current position of mark.

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.

Obtains the number of lines in the buffer. This value is cached, so the function is very fast.

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

Indicates whether the buffer has been modified since the last call to SetModified set the modification flag to FALSE. Used for example to enable a "save" function in a text editor.

This function returns the list of targets this text buffer supports for pasting and as DND destination. The targets in the list are added with info values from the Gtk.Gtk.TextBufferTargetInfo.T enum, using Gtk.Gtk.TargetList.AddRichTextTargets and Gtk.Gtk.TargetList.AddTextTargets.

Returns the mark that represents the selection bound. Equivalent to calling GetMark 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. GetSelectionBounds is another convenient function for handling the selection, if you just want to know whether there's a selection and what its bounds are.

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.

This function returns the rich text serialize formats registered with buffer using RegisterSerializeFormat or RegisterSerializeTagset

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 GetText. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.

Initialized iter with the first position in the text buffer. This is the same as using GetIterAtOffset to get the iter at character offset 0.

Get the Gtk.Gtk.TextTagTable.T associated with this buffer.

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 GetSlice.

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.

Simply calls Insert, using the current cursor position as the insertion point.

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 GetSlice and GetText. Consider CreateChildAnchor as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.

Like 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 Gtk.Gtk.TextView.GetEditable is appropriate here.

Calls InsertInteractive 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 Gtk.Gtk.TextView.GetEditable is appropriate here.

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 pixbufs, but the "text" variants do not. e.g. see GetSlice and GetText.

Copies text, tags, and pixbufs between start and end (the order of start and end doesn't matter) and inserts the copy at iter. 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.

Same as InsertRange, 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 Gtk.Gtk.TextView.GetEditable is appropriate here.

Inserts text into buffer at iter, applying the list of tags to the newly-inserted text. The last tag specified must be NULL to terminate the list. Equivalent to calling Insert, then ApplyTag on the inserted text; InsertWithTags is just a convenience function.

Same as InsertWithTags, but allows you to pass in tag names instead of tag objects.

Moves mark to the new location where. Emits the "mark-set" signal as notification of the move.

Moves the mark named name (which must exist) to location where. See MoveMark for details.

Pastes the contents of a clipboard at the insertion point, or at override_location. (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.)

This function moves the "insert" and "selection_bound" marks simultaneously. If you move them to the same place in two steps with MoveMark, 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.

This function registers a rich text deserialization function along with its mime_type with the passed buffer.

This function registers GTK+'s internal rich text serialization format with the passed buffer. See RegisterSerializeTagset for details.

This function registers a rich text serialization function along with its mime_type with the passed buffer.

This function registers GTK+'s internal rich text serialization format with the passed buffer. The internal format does not comply to any standard rich text format and only works between T instances. It is capable of serializing all of a text buffer's tags and embedded pixbufs.

This function is just a wrapper around RegisterSerializeFormat. The mime type used for registering is "application/x-gtk-text-buffer-rich-text", or "application/x-gtk-text-buffer-rich-text;format=tagset_name" if a tagset_name was passed.

The tagset_name can be used to restrict the transfer of rich text to buffers with compatible sets of tags, in order to avoid unknown tags from being pasted. It is probably the common case to pass an identifier != NULL here, since the NULL tagset requires the receiving buffer to deal with with pasting of arbitrary tags.

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.

Removes a Gtk.Gtk.Clipboard.T added with AddSelectionClipboard.

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.

Calls Gtk.Gtk.TextTagTable.Lookup on the buffer's tag table to get a Gtk.Gtk.TextTag.T, then calls RemoveTag.

This function moves the "insert" and "selection_bound" marks simultaneously. If you move them in two steps with MoveMark, 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.

This function serializes the portion of text between start and end in the rich text format represented by format.

formats to be used must be registered using RegisterSerializeFormat or RegisterSerializeTagset beforehand.

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 toggled on the modified bit again. When the modified bit flips, the buffer emits a "modified-changed" signal.

Deletes current contents of buffer, and inserts text instead. If len is -1, text must be nul-terminated. text must be valid UTF-8.

This function unregisters a rich text format that was previously registered using RegisterDeserializeFormat or RegisterDeserializeTagset.

This function unregisters a rich text format that was previously registered using RegisterSerializeFormat or RegisterSerializeTagset