Creates a new text buffer.

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

Gets the number of characters in the buffer. The character count is cached, so this function is very fast.

Get the TextTagTable associated with this buffer.

Inserts text at position iter. Emits the insertText signal; insertion actually occurs in the default handler for the signal. iter is invalidated when insertion occurs (because the buffer contents change).

Inserts text at position iter. Similar to textBufferInsert but uses ByteString buffers.

• The passed-in buffer must contain a valid UTF-8 encoded string.

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

Simply calls textBufferInsert, using the current cursor position as the insertion point. Similar to textBufferInsertAtCursor but uses ByteString buffers.

• The passed-in buffer must contain a valid UTF-8 encoded string.

Like textBufferInsert, 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).

If no tag is at the specified position, use the default value def to decide if the text should be inserted. This value could be set to the result of textViewGetEditable.

Similar to textBufferInsertInteractive but uses ByteString buffers.

• The passed-in buffer must contain a valid UTF-8 encoded string.

Calls textBufferInsertInteractive at the cursor position.

Similar to textBufferInsertInteractiveAtCursor but uses ByteString buffers.

• The passed-in buffer must contain a valid UTF-8 encoded string.

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 applyTag signals, so expect those.

Same as textBufferInsertRange, but does nothing if the insertion point isn't editable. The defaultEditable parameter indicates whether the text is editable at iter if no tags enclosing iter affect editability. Typically the result of textViewGetEditable is appropriate here.

Deletes text between start and end. The order of start and end is not actually relevant; textBufferDelete will reorder them. This function actually emits the deleteRange 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 textBufferDelete 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 current contents of buffer, and inserts text instead. Similar to textBufferSetText but uses ByteString buffers.

• The passed-in buffer must contain a valid UTF-8 encoded string.

Returns the text in the range [start,end). Similar to textBufferGetText but uses ByteString buffers.

• The returned buffer is a UTF-8 encoded string.

Returns the text in the range [start,end). Similar to textBufferGetSlice but uses ByteString buffers.

• The returned buffer is a UTF-8 encoded string.

Deletes current contents of buffer, and inserts text instead.

Returns the text in the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if includeHiddenChars is False. Does not include characters representing embedded images, so character indexes into the returned string do not correspond to character indexes into the buffer. Contrast with textBufferGetSlice.

Returns the text in the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if includeHiddenChars is False. The returned string includes a (chr 0xFFFC) character whenever the buffer contains embedded images, so character indexes into the returned string do correspond to character indexes into the buffer. Contrast with textBufferGetText. Note that (chr 0xFFFC) can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.

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" (chr 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 textBufferGetSlice and textBufferGetText.

Creates a mark at position where. If markName is Nothing, the mark is anonymous; otherwise, the mark can be retrieved by name using textBufferGetMark. 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 (leftGravity = 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).

Emits the markSet signal as notification of the mark's initial placement.

Adds the mark at position given by the TextIter. The mark may not be added to any other buffer.

Emits the markSet signal as notification of the mark's initial placement.

Moves mark to the new location where. Emits the markSet signal as notification of the move.

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

Deletes mark, so that it's no longer located anywhere in the buffer. Most operations on mark become invalid. There is no way to undelete a mark. textMarkGetDeleted will return True after this function has been called on a mark; textMarkGetDeleted indicates that a mark no longer belongs to a buffer. The markDeleted signal will be emitted as notification after the mark is deleted.

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

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

Returns the mark that represents the cursor (insertion point). Equivalent to calling liftM fromJust $ textBufferGetMark "insert", but very slightly more efficient, and involves less typing.

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

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

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

Emits the removeTag 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 textTagTableLookup on the buffer's tag table to get a TextTag, then calls textBufferApplyTag.

Calls textTagTableLookup on the buffer's tag table to get a TextTag, then calls textBufferRemoveTag.

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.

Obtains an iterator pointing to charOffset within the given line. The charOffset must exist, offsets off the end of the line are not allowed.

Creates an iterator pointing to a position charOffset chars from the start of the entire buffer. If charOffset is -1 or greater than the number of characters in the buffer, the end iterator is returned, that is the iterator one past the last valid character in the buffer.

Create an iterator at a specific line.

Create an iterator from a mark.

Create an iterator at the first position in the text buffer. This is the same as using textBufferGetIterAtOffset to get the iter at character offset 0.

Returns the "end iterator," one past the last valid character in the text buffer. If dereferenced with textIterGetChar, the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call textBufferGetStartIter to get character position 0) to the end iterator.

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

It is often more convenient to use onModifiedChanged.

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 textBufferSetModified 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 modifiedChanged signal.

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

Check if a selection exists.

Returns the bounds of the selection (if the selection has length 0, then start and end will be the same). start and end will be in ascending order.

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

• Available since Gtk+ version 2.4

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

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

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

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.

• Available since Gtk+ version 2.6

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" (chr 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 textBufferGetSlice and textBufferGetText. Consider textBufferCreateChildAnchor as a more convenient alternative to this function.

This is a convenience function which simply creates a child anchor with textBufferChildAnchorNew and inserts it into the buffer with textBufferInsertChildAnchor.

Obtains the location of anchor within buffer.

Pastes the contents of a clipboard at the given 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.)

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

Copies the currently-selected text to a clipboard.

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

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

Removes a Clipboard added with textBufferAddSelectionClipboard.

Text Tag Table.

The text content of the buffer. Without child widgets and images, see textBufferGetText for more information.

Default value: ""

The 'modified' property. See textBufferGetModified and textBufferSetModified

A TextTag was applied to a region of text.

A new atomic user action is started.

• Together with endUserAction these signals can be used to build an undo stack.

Emitted when the contents of the buffer change.

A range of text is about to be deleted.

An atomic action has ended.

• see beginUserAction

A Pixbuf is inserted into the buffer.

• See note in bufferInsertText.

The insertChildAnchor signal is emitted to insert a TextChildAnchor in a TextBuffer. Insertion actually occurs in the default handler.

• See note in bufferInsertText.

Some text is inserted. Insertion actually occurs in the default handler.

• The function connected to this handler may not modify the buffer since this would invalidate the iterator. If this function replaces the default handler, it needs to stop the emission of this signal in order to prevent the default handler from running. If additional text should be inserted, this can be done using the after function to connect.

A TextMark within the buffer was deleted.

A TextMark was inserted into the buffer.

The pasteDone signal is emitted after paste operation has been completed. This is useful to properly scroll the view to the end of the pasted text. See textBufferPasteClipboard for more details.

The textbuffer has changed.