gtk.text_iter
Module for [TextIter] class
class TextIter
Types 1
classTextIter : gobject.boxed.Boxed
An iterator for the contents of a [gtk.text_buffer.TextBuffer].
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.
Methods
void assign(gtk.text_iter.TextIter other)Assigns the value of other to iter.bool backwardChar()Moves backward by one character offset.bool backwardChars(int count)Moves count characters backward, if possible.bool backwardCursorPosition()Like [gtk.text_iter.TextIter.forwardCursorPosition], but moves backward. Returns: true if we movedbool backwardCursorPositions(int count)Moves up to count cursor positions.bool backwardFindChar(gtk.types.TextCharPredicate pred, gtk.text_iter.TextIter limit = null)Same as [gtk.text_iter.TextIter.forwardFindChar], but goes backward from iter.bool backwardLine()Moves iter to the start of the previous line.bool backwardLines(int count)Moves count lines backward, if possible.bool backwardSearch(string str, gtk.types.TextSearchFlags flags, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, gtk.text_iter.TextIter limit = null)Same as [gtk.text_iter.TextIter.forwardSearch], but moves backward.bool backwardSentenceStart()Moves backward to the previous sentence start.bool backwardSentenceStarts(int count)Calls [gtk.text_iter.TextIter.backwardSentenceStart] up to count times.bool backwardToTagToggle(gtk.text_tag.TextTag tag = null)Moves backward to the next toggle (on or off) of the tag, or to the next toggle of any tag if tag is null.bool backwardVisibleCursorPosition()Moves iter backward to the previous visible cursor position.bool backwardVisibleCursorPositions(int count)Moves up to count visible cursor positions.bool backwardVisibleLine()Moves iter to the start of the previous visible line.bool backwardVisibleLines(int count)Moves count visible lines backward, if possible.bool backwardVisibleWordStart()Moves backward to the previous visible word start.bool backwardVisibleWordStarts(int count)Calls [gtk.text_iter.TextIter.backwardVisibleWordStart] up to count times.bool backwardWordStart()Moves backward to the previous word start.bool backwardWordStarts(int count)Calls [gtk.text_iter.TextIter.backwardWordStart] up to count times.bool canInsert(bool defaultEditability)Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at iter would be editable.int compare(gtk.text_iter.TextIter rhs)A qsort()-style function that returns negative if lhs is less than rhs, positive if lhs is greater than rhs, and 0 if they’re equal.gtk.text_iter.TextIter copy()Creates a dynamically-allocated copy of an iterator.bool editable(bool defaultSetting)Returns whether the character at iter is within an editable region of text.bool endsLine()Returns true if iter points to the start of the paragraph delimiter characters for a line.bool endsSentence()Determines whether iter ends a sentence.bool endsTag(gtk.text_tag.TextTag tag = null)Returns true if tag is toggled off at exactly this point.bool endsWord()Determines whether iter ends a natural-language word.bool equal(gtk.text_iter.TextIter rhs)Tests whether two iterators are equal, using the fastest possible mechanism.bool forwardChar()Moves iter forward by one character offset.bool forwardChars(int count)Moves count characters if possible.bool forwardCursorPosition()Moves iter forward by a single cursor position.bool forwardCursorPositions(int count)Moves up to count cursor positions.bool forwardFindChar(gtk.types.TextCharPredicate pred, gtk.text_iter.TextIter limit = null)Advances iter, calling pred on each character.bool forwardLine()Moves iter to the start of the next line.bool forwardLines(int count)Moves count lines forward, if possible.bool forwardSearch(string str, gtk.types.TextSearchFlags flags, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, gtk.text_iter.TextIter limit = null)Searches forward for str.bool forwardSentenceEnd()Moves forward to the next sentence end.bool forwardSentenceEnds(int count)Calls [gtk.text_iter.TextIter.forwardSentenceEnd] count times.void forwardToEnd()Moves iter forward to the “end iterator”, which points one past the last valid character in the buffer.bool forwardToLineEnd()Moves the iterator to point to the paragraph delimiter characters.bool forwardToTagToggle(gtk.text_tag.TextTag tag = null)Moves forward to the next toggle (on or off) of the tag, or to the next toggle of any tag if tag is null.bool forwardVisibleCursorPosition()Moves iter forward to the next visible cursor position.bool forwardVisibleCursorPositions(int count)Moves up to count visible cursor positions.bool forwardVisibleLine()Moves iter to the start of the next visible line.bool forwardVisibleLines(int count)Moves count visible lines forward, if possible.bool forwardVisibleWordEnd()Moves forward to the next visible word end.bool forwardVisibleWordEnds(int count)Calls [gtk.text_iter.TextIter.forwardVisibleWordEnd] up to count times.bool forwardWordEnd()Moves forward to the next word end.bool forwardWordEnds(int count)Calls [gtk.text_iter.TextIter.forwardWordEnd] up to count times.gtk.text_buffer.TextBuffer getBuffer()Returns the [gtk.text_buffer.TextBuffer] this iterator is associated with. Returns: the bufferint getBytesInLine()Returns the number of bytes in the line containing iter, including the paragraph delimiters. Returns: number of bytes in the linedchar getChar()The Unicode character at this iterator is returned.int getCharsInLine()Returns the number of characters in the line containing iter, including the paragraph delimiters. Returns: number of characters in the linegtk.text_child_anchor.TextChildAnchor getChildAnchor()If the location at iter contains a child anchor, the anchor is returned.pango.language.Language getLanguage()Returns the language in effect at iter.int getLine()Returns the line number containing the iterator.int getLineIndex()Returns the byte index of the iterator, counting from the start of a newline-terminated line.int getLineOffset()Returns the character offset of the iterator, counting from the start of a newline-terminated line.gtk.text_mark.TextMark[] getMarks()Returns a list of all [gtk.text_mark.TextMark] at this location.int getOffset()Returns the character offset of an iterator.gdk.paintable.Paintable getPaintable()If the element at iter is a paintable, the paintable is returned.string getSlice(gtk.text_iter.TextIter end)Returns the text in the given range.gtk.text_tag.TextTag[] getTags()Returns a list of tags that apply to iter, in ascending order of priority.string getText(gtk.text_iter.TextIter end)Returns text in the given range.gtk.text_tag.TextTag[] getToggledTags(bool toggledOn)Returns a list of [gtk.text_tag.TextTag] that are toggled on or off at this point.int getVisibleLineIndex()Returns the number of bytes from the start of the line to the given iter, not counting bytes that are invisible due to tags with the “invisible” flag toggled on. Returns: byte index of iter wit...int getVisibleLineOffset()Returns the offset in characters from the start of the line to the given iter, not counting characters that are invisible due to tags with the “invisible” flag toggled on. Returns: offset in vi...string getVisibleSlice(gtk.text_iter.TextIter end)Returns visible text in the given range.string getVisibleText(gtk.text_iter.TextIter end)Returns visible text in the given range.bool hasTag(gtk.text_tag.TextTag tag)Returns true if iter points to a character that is part of a range tagged with tag.bool inRange(gtk.text_iter.TextIter start, gtk.text_iter.TextIter end)Checks whether iter falls in the range [start, end).bool insideSentence()Determines whether iter is inside a sentence (as opposed to in between two sentences, e.g. after a period and before the first letter of the next sentence).bool insideWord()Determines whether the character pointed by iter is part of a natural-language word (as opposed to say inside some whitespace).bool isCursorPosition()Determine if iter is at a cursor position.bool isEnd()Returns true if iter is the end iterator.bool isStart()Returns true if iter is the first iterator in the buffer. Returns: whether iter is the first in the buffervoid order(gtk.text_iter.TextIter second)Swaps the value of first and second if second comes before first in the buffer.void setLine(int lineNumber)Moves iterator iter to the start of the line line_number.void setLineIndex(int byteOnLine)Same as [gtk.text_iter.TextIter.setLineOffset], but works with a byte index. The given byte index must be at the start of a character, it can’t be in the middle of a UTF-8 encoded character.void setLineOffset(int charOnLine)Moves iter within a line, to a new character (not byte) offset.void setOffset(int charOffset)Sets iter to point to char_offset.void setVisibleLineIndex(int byteOnLine)Like [gtk.text_iter.TextIter.setLineIndex], but the index is in visible bytes, i.e. text with a tag making it invisible is not counted in the index.void setVisibleLineOffset(int charOnLine)Like [gtk.text_iter.TextIter.setLineOffset], but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset.bool startsLine()Returns true if iter begins a paragraph.bool startsSentence()Determines whether iter begins a sentence.bool startsTag(gtk.text_tag.TextTag tag = null)Returns true if tag is toggled on at exactly this point.bool startsWord()Determines whether iter begins a natural-language word.bool togglesTag(gtk.text_tag.TextTag tag = null)Gets whether a range with tag applied to it begins or ends at iter.