gtk.text_iter
Module for [TextIter] class
class TextIter
Types 1
classTextIter : gobject.boxed.Boxed
You may wish to begin by reading the
text widget conceptual overviewwhich 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. This function is not useful in applications, because iterators can be assigned with `GtkTextIter i = j;`. The function is used by language bindings.bool backwardChar()Moves backward by one character offset. Returns true if movement was possible; if iter was the first in the buffer (character offset 0), [gtk.text_iter.TextIter.backwardChar] returns false for conv...bool backwardChars(int count)Moves count characters backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator mov...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. See [gtk.text_iter.TextIter.forwardCursorPosition] for details.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. Returns true if iter could be moved; i.e. if iter was at character offset 0, this function returns false. Therefore if iter was already on line 0, but ...bool backwardLines(int count)Moves count lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved on...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; if iter is already at the start of a sentence, moves backward to the next one. Sentence boundaries are determined by Pango and should be correct for ...bool backwardSentenceStarts(int count)Calls [gtk.text_iter.TextIter.backwardSentenceStart] up to count times, or until it returns false. If count is negative, moves forward instead of backward.bool backwardToTagToggle(gtk.text_tag.TextTag tag = null)Moves backward to the next toggle (on or off) of the #GtkTextTag tag, or to the next toggle of any tag if tag is null. If no matching tag toggles are found, returns false, otherwise true. Does not ...bool backwardVisibleCursorPosition()Moves iter forward to the previous visible cursor position. See [gtk.text_iter.TextIter.backwardCursorPosition] for details. Returns: true if we moved and the new position is dereferenceablebool backwardVisibleCursorPositions(int count)Moves up to count visible cursor positions. See [gtk.text_iter.TextIter.backwardCursorPosition] for details.bool backwardVisibleLine()Moves iter to the start of the previous visible line. Returns true if iter could be moved; i.e. if iter was at character offset 0, this function returns false. Therefore if iter was already on line...bool backwardVisibleLines(int count)Moves count visible lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator ...bool backwardVisibleWordStart()Moves backward to the previous visible word start. (If iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for n...bool backwardVisibleWordStarts(int count)Calls [gtk.text_iter.TextIter.backwardVisibleWordStart] up to count times.bool backwardWordStart()Moves backward to the previous word start. (If iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly an...bool backwardWordStarts(int count)Calls [gtk.text_iter.TextIter.backwardWordStart] up to count times.bool beginsTag(gtk.text_tag.TextTag tag = null)Returns true if tag is toggled on at exactly this point. If tag is null, returns true if any tag is toggled on at this point.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. If text inserted at iter would be editable then the ...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. Ordering is in character offset order, i.e. the first characte...gtk.text_iter.TextIter copy()Creates a dynamically-allocated copy of an iterator. This function is not useful in applications, because iterators can be copied with a simple assignment (`GtkTextIter i = j;`). The function is us...bool editable(bool defaultSetting)Returns whether the character at iter is within an editable region of text. Non-editable text is “locked” and can’t be changed by the user via #GtkTextView. This function is simply a conveni...bool endsLine()Returns true if iter points to the start of the paragraph delimiter characters for a line (delimiters will be either a newline, a carriage return, a carriage return followed by a newline, or a Unic...bool endsSentence()Determines whether iter ends a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algo...bool endsTag(gtk.text_tag.TextTag tag = null)Returns true if tag is toggled off at exactly this point. If tag is null, returns true if any tag is toggled off at this point.bool endsWord()Determines whether iter ends a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break al...bool equal(gtk.text_iter.TextIter rhs)Tests whether two iterators are equal, using the fastest possible mechanism. This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator...bool forwardChar()Moves iter forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so [gtk.textiter.TextIter.forwardChar] may actually move onto an image instead of a char...bool forwardChars(int count)Moves count characters if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the new position of iter is...bool forwardCursorPosition()Moves iter forward by a single cursor position. Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all cha...bool forwardCursorPositions(int count)Moves up to count cursor positions. See [gtk.text_iter.TextIter.forwardCursorPosition] for details.bool forwardFindChar(gtk.types.TextCharPredicate pred, gtk.text_iter.TextIter limit = null)Advances iter, calling pred on each character. If pred returns true, returns true and stops scanning. If pred never returns true, iter is set to limit if limit is non-null, otherwise to the end ite...bool forwardLine()Moves iter to the start of the next line. If the iter is already on the last line of the buffer, moves the iter to the end of the current line. If after the operation, the iter is at the end of the...bool forwardLines(int count)Moves count lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved ont...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. Any match is returned by setting matchstart to the first character of the match and matchend to the first character after the match. The search will not continue past limi...bool forwardSentenceEnd()Moves forward to the next sentence end. (If iter is at the end of a sentence, moves to the next end of sentence.) Sentence boundaries are determined by Pango and should be correct for nearly any l...bool forwardSentenceEnds(int count)Calls [gtk.textiter.TextIter.forwardSentenceEnd] count times (or until [gtk.textiter.TextIter.forwardSentenceEnd] returns false). If count is negative, moves backward instead of forward.void forwardToEnd()Moves iter forward to the “end iterator,” which points one past the last valid character in the buffer. [gtk.text_iter.TextIter.getChar] called on the end iterator returns 0, which is convenien...bool forwardToLineEnd()Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator chara...bool forwardToTagToggle(gtk.text_tag.TextTag tag = null)Moves forward to the next toggle (on or off) of the #GtkTextTag tag, or to the next toggle of any tag if tag is null. If no matching tag toggles are found, returns false, otherwise true. Does not r...bool forwardVisibleCursorPosition()Moves iter forward to the next visible cursor position. See [gtk.text_iter.TextIter.forwardCursorPosition] for details. Returns: true if we moved and the new position is dereferenceablebool forwardVisibleCursorPositions(int count)Moves up to count visible cursor positions. See [gtk.text_iter.TextIter.forwardCursorPosition] for details.bool forwardVisibleLine()Moves iter to the start of the next visible line. Returns true if there was a next line to move to, and false if iter was simply moved to the end of the buffer and is now not dereferenceable, or if...bool forwardVisibleLines(int count)Moves count visible lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator m...bool forwardVisibleWordEnd()Moves forward to the next visible word end. (If iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any ...bool forwardVisibleWordEnds(int count)Calls [gtk.text_iter.TextIter.forwardVisibleWordEnd] up to count times.bool forwardWordEnd()Moves forward to the next word end. (If iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language...bool forwardWordEnds(int count)Calls [gtk.text_iter.TextIter.forwardWordEnd] up to count times.bool getAttributes(out gtk.text_attributes.TextAttributes values)Computes the effect of any tags applied to this spot in the text. The values parameter should be initialized to the default settings you wish to use if no tags are in effect. You’d typically obta...gtk.text_buffer.TextBuffer getBuffer()Returns the #GtkTextBuffer 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. (Equivalent to operator* on a C++ iterator.) If the element at this iterator is a non-character element, such as an image embedded in the buffe...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 (with no new reference count added). Otherwise, null is returned. Returns: the anchor at iterpango.language.Language getLanguage()A convenience wrapper around [gtk.text_iter.TextIter.getAttributes], which returns the language in effect at iter. If no tags affecting language apply to iter, the return value is identical to that...int getLine()Returns the line number containing the iterator. Lines in a #GtkTextBuffer are numbered beginning with 0 for the first line in the buffer. Returns: a line numberint getLineIndex()Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that #GtkTextBuffer encodes text in UTF-8, and that characters can require a variable number o...int getLineOffset()Returns the character offset of the iterator, counting from the start of a newline-terminated line. The first character on the line has offset 0. Returns: offset from start of linegtk.text_mark.TextMark[] getMarks()Returns a list of all #GtkTextMark at this location. Because marks are not iterable (they don’t take up any "space" in the buffer, they are just marks in between iterable locations), multiple mar...int getOffset()Returns the character offset of an iterator. Each character in a #GtkTextBuffer has an offset, starting with 0 for the first character in the buffer. Use [gtk.text_buffer.TextBuffer.getIterAtOffset...gdkpixbuf.pixbuf.Pixbuf getPixbuf()If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added). Otherwise, null is returned. Returns: the pixbuf at iterstring getSlice(gtk.text_iter.TextIter end)Returns the text in the given range. A “slice” is an array of characters encoded in UTF-8 format, including the Unicode “unknown” character 0xFFFC for iterable non-character elements in the...gtk.text_tag.TextTag[] getTags()Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last). The #GtkTextTag in the list don’t have a reference added, but you have to free the list...string getText(gtk.text_iter.TextIter end)Returns text in the given range. If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and byte offsets in ...gtk.text_tag.TextTag[] getToggledTags(bool toggledOn)Returns a list of #GtkTextTag that are toggled on or off at this point. (If toggled_on is true, the list contains tags that are toggled on.) If a tag is toggled on at iter, then some non-empty ran...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)Like [gtk.text_iter.TextIter.getSlice], but invisible text is not included. Invisible text is usually invisible because a #GtkTextTag with the “invisible” attribute turned on has been applied t...string getVisibleText(gtk.text_iter.TextIter end)Like [gtk.text_iter.TextIter.getText], but invisible text is not included. Invisible text is usually invisible because a #GtkTextTag with the “invisible” attribute turned on has been applied to...bool hasTag(gtk.text_tag.TextTag tag)Returns true if iter points to a character that is part of a range tagged with tag. See also [gtk.textiter.TextIter.startsTag] and [gtk.textiter.TextIter.endsTag].bool inRange(gtk.text_iter.TextIter start, gtk.text_iter.TextIter end)Checks whether iter falls in the range [start, end). start and end must be in ascending order.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). Sentence boundaries are determined by P...bool insideWord()Determines whether the character pointed by iter is part of a natural-language word (as opposed to say inside some whitespace). Word breaks are determined by Pango and should be correct for nearly...bool isCursorPosition()See [gtk.textiter.TextIter.forwardCursorPosition] or #PangoLogAttr or [pango.global.break] for details on what a cursor position is. Returns: true if the cursor can be placed at iterbool isEnd()Returns true if iter is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. [gtk.text_iter.TextIter.isEnd] is the most efficient way to check whether an iterator is the...bool isStart()Returns true if iter is the first iterator in the buffer, that is if iter has a character offset of 0. 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. That is, ensures that first and second are in sequence. Most text buffer functions that take a range call this automa...void setLine(int lineNumber)Moves iterator iter to the start of the line linenumber. If linenumber is negative or larger than the number of lines in the buffer, moves iter to the start of the last line in the buffer.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. The given character offset must be less than or equal to the number of characters in the line; if equal, iter moves to the start of t...void setOffset(int charOffset)Sets iter to point to charoffset. charoffset counts from the start of the entire text buffer, starting with 0.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, i.e. if [gtk.textiter.TextIter.getLineOffset] would return 0. However this function is potentially more efficient than [gtk.textiter.TextIter.getLineOffset]...bool startsSentence()Determines whether iter begins a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary al...bool startsTag(gtk.text_tag.TextTag tag = null)Returns true if tag is toggled on at exactly this point. If tag is null, returns true if any tag is toggled on at this point.bool startsWord()Determines whether iter begins a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break ...bool togglesTag(gtk.text_tag.TextTag tag = null)This is equivalent to ([gtk.textiter.TextIter.startsTag] || [gtk.textiter.TextIter.endsTag]), i.e. it tells you whether a range with tag applied to it begins or ends at iter.