Text buffer iterator
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.
<gtk-text-iter>) ⇒ (ret <gtk-text-buffer>)Returns the
<gtk-text-buffer>this iterator is associated with.
- iter
- an iterator
- ret
- the buffer
<gtk-text-iter>) ⇒ (ret <gtk-text-iter>)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 used by language bindings.
- iter
- an iterator
- ret
- a copy of the iter, free with
gtk-text-iter-free
<gtk-text-iter>) ⇒ (ret int)Returns the character offset of an iterator. Each character in a
<gtk-text-buffer>has an offset, starting with 0 for the first character in the buffer. Usegtk-text-buffer-get-iter-at-offsetto convert an offset back into an iterator.
- iter
- an iterator
- ret
- a character offset
<gtk-text-iter>) ⇒ (ret int)Returns the line number containing the iterator. Lines in a
<gtk-text-buffer>are numbered beginning with 0 for the first line in the buffer.
- iter
- an iterator
- ret
- a line number
<gtk-text-iter>) ⇒ (ret int)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.
- iter
- an iterator
- ret
- offset from start of line
<gtk-text-iter>) ⇒ (ret int)Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that
<gtk-text-buffer>encodes text in UTF-8, and that characters can require a variable number of bytes to represent.
- iter
- an iterator
- ret
- distance from start of line, in bytes
<gtk-text-iter>) ⇒ (ret unsigned-int32)Returns the Unicode character at this iterator. (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 buffer, the Unicode "unknown" character 0xFFFC is returned. If invoked on the end iterator, zero is returned; zero is not a valid Unicode character. So you can write a loop which ends when
gtk-text-iter-get-charreturns 0.
- iter
- an iterator
- ret
- a Unicode character, or 0 if iter is not dereferenceable
<gtk-text-iter>) (end <gtk-text-iter>) ⇒ (ret mchars)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 buffer, such as images. Because images are encoded in the slice, byte and character offsets in the returned array will correspond to byte offsets in the text buffer. 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.
- start
- iterator at start of a range
- end
- iterator at end of a range
- ret
- slice of text from the buffer
<gtk-text-iter>) (end <gtk-text-iter>) ⇒ (ret mchars)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 the buffer. If you want offsets to correspond, see
gtk-text-iter-get-slice.
- start
- iterator at start of a range
- end
- iterator at end of a range
- ret
- array of characters from the buffer
<gtk-text-iter>) (end <gtk-text-iter>) ⇒ (ret mchars)Like
gtk-text-iter-get-slice, but invisible text is not included. Invisible text is usually invisible because a<gtk-text-tag>with the "invisible" attribute turned on has been applied to it.
- start
- iterator at start of range
- end
- iterator at end of range
- ret
- slice of text from the buffer
<gtk-text-iter>) (end <gtk-text-iter>) ⇒ (ret mchars)Like
gtk-text-iter-get-text, but invisible text is not included. Invisible text is usually invisible because a<gtk-text-tag>with the "invisible" attribute turned on has been applied to it.
- start
- iterator at start of range
- end
- iterator at end of range
- ret
- string containing visible text in the range
<gtk-text-iter>) ⇒ (ret <gdk-pixbuf>)If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added). Otherwise, ‘
#f’ is returned.
- iter
- an iterator
- ret
- the pixbuf at iter
<gtk-text-iter>) ⇒ (ret gslist-of)Returns a list of all
<gtk-text-mark>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 marks can exist in the same place. The returned list is not in any meaningful order.
- iter
- an iterator
- ret
- list of
<gtk-text-mark>
<gtk-text-iter>) (toggled_on bool) ⇒ (ret gslist-of)Returns a list of
<gtk-text-tag>that are toggled on or off at this point. (If toggled-on is ‘#t’, the list contains tags that are toggled on.) If a tag is toggled on at iter, then some non-empty range of characters following iter has that tag applied to it. If a tag is toggled off, then some non-empty range following iter does not have the tag applied to it.
- iter
- an iterator
- toggled-on
- ‘
#t’ to get toggled-on tags- ret
- tags toggled at this point
<gtk-text-iter>) ⇒ (ret <gtk-text-child-anchor>)If the location at iter contains a child anchor, the anchor is returned (with no new reference count added). Otherwise, ‘
#f’ is returned.
- iter
- an iterator
- ret
- the anchor at iter
<gtk-text-iter>) (tag <gtk-text-tag>) ⇒ (ret bool)Returns ‘
#t’ if tag is toggled on at exactly this point. If tag is ‘#f’, returns ‘#t’ if any tag is toggled on at this point. Note that thegtk-text-iter-begins-tagreturns ‘#t’ if iter is the start of the tagged range;gtk-text-iter-has-tagtells you whether an iterator is within a tagged range.
- iter
- an iterator
- tag
- a
<gtk-text-tag>, or ‘#f’- ret
- whether iter is the start of a range tagged with tag
<gtk-text-iter>) (tag <gtk-text-tag>) ⇒ (ret bool)Returns ‘
#t’ if tag is toggled off at exactly this point. If tag is ‘#f’, returns ‘#t’ if any tag is toggled off at this point. Note that thegtk-text-iter-ends-tagreturns ‘#t’ if iter is the end of the tagged range;gtk-text-iter-has-tagtells you whether an iterator is within a tagged range.
- iter
- an iterator
- tag
- a
<gtk-text-tag>, or ‘#f’- ret
- whether iter is the end of a range tagged with tag
<gtk-text-iter>) (tag <gtk-text-tag>) ⇒ (ret bool)This is equivalent to (
gtk-text-iter-begins-tag||gtk-text-iter-ends-tag), i.e. it tells you whether a range with tag applied to it begins or ends at iter.
- iter
- an iterator
- tag
- a
<gtk-text-tag>, or ‘#f’- ret
- whether tag is toggled on or off at iter
<gtk-text-iter>) (tag <gtk-text-tag>) ⇒ (ret bool)Returns ‘
#t’ if iter is within a range tagged with tag.
- iter
- an iterator
- tag
- a
<gtk-text-tag>- ret
- whether iter is tagged with tag
<gtk-text-iter>) ⇒ (ret gslist-of)Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last). The
<gtk-text-tag>in the list don't have a reference added, but you have to free the list itself.
- iter
- a
<gtk-text-iter>- ret
- list of
<gtk-text-tag>
<gtk-text-iter>) (default_setting bool) ⇒ (ret bool)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
<gtk-text-view>. This function is simply a convenience wrapper aroundgtk-text-iter-get-attributes. If no tags applied to this text affect editability, default-setting will be returned.You don't want to use this function to decide whether text can be inserted at iter, because for insertion you don't want to know whether the char at iter is inside an editable range, you want to know whether a new character inserted at iter would be inside an editable range. Use
gtk-text-iter-can-insertto handle this case.
- iter
- an iterator
- default-setting
- ‘
#t’ if text is editable by default- ret
- whether iter is inside an editable range
<gtk-text-iter>) (default_editability bool) ⇒ (ret bool)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 user should be allowed to insert text at iter.
gtk-text-buffer-insert-interactiveuses this function to decide whether insertions are allowed at a given position.
- iter
- an iterator
- default-editability
- ‘
#t’ if text is editable by default- ret
- whether text inserted at iter would be editable
<gtk-text-iter>) ⇒ (ret bool)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 algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is at the start of a word
<gtk-text-iter>) ⇒ (ret bool)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 algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is at the end of a word
<gtk-text-iter>) ⇒ (ret bool)Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace). 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 algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is inside a word
<gtk-text-iter>) ⇒ (ret bool)Returns ‘
#t’ if iter begins a paragraph, i.e. ifgtk-text-iter-get-line-offsetwould return 0. However this function is potentially more efficient thangtk-text-iter-get-line-offsetbecause it doesn't have to compute the offset, it just has to see whether it's 0.
- iter
- an iterator
- ret
- whether iter begins a line
<gtk-text-iter>) ⇒ (ret bool)Returns ‘
#t’ 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 Unicode paragraph separator character). Note that an iterator pointing to the \n of a \r\n pair will not be counted as the end of a line, the line ends before the \r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there.
- iter
- an iterator
- ret
- whether iter is at the end of a line
<gtk-text-iter>) ⇒ (ret bool)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 algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is at the start of a sentence.
<gtk-text-iter>) ⇒ (ret bool)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 algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is at the end of a sentence.
<gtk-text-iter>) ⇒ (ret bool)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 Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter is inside a sentence.
<gtk-text-iter>) ⇒ (ret bool)See
gtk-text-iter-forward-cursor-positionor<pango-log-attr>orpango-breakfor details on what a cursor position is.
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if the cursor can be placed at iter
<gtk-text-iter>) ⇒ (ret int)Returns the number of characters in the line containing iter, including the paragraph delimiters.
- iter
- an iterator
- ret
- number of characters in the line
<gtk-text-iter>) ⇒ (ret int)Returns the number of bytes in the line containing iter, including the paragraph delimiters.
- iter
- an iterator
- ret
- number of bytes in the line
<gtk-text-iter>) (values <gtk-text-attributes>) ⇒ (ret bool)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 obtain the defaults from
gtk-text-view-get-default-attributes.
gtk-text-iter-get-attributeswill modify values, applying the effects of any tags present at iter. If any tags affected values, the function returns ‘#t’.
- iter
- an iterator
- values
- a
<gtk-text-attributes>to be filled in- ret
- ‘
#t’ if values was modified
<gtk-text-iter>) ⇒ (ret <pango-language>)A convenience wrapper around
gtk-text-iter-get-attributes, which returns the language in effect at iter. If no tags affecting language apply to iter, the return value is identical to that ofgtk-get-default-language.
- iter
- an iterator
- ret
- language in effect at iter
<gtk-text-iter>) ⇒ (ret bool)Returns ‘
#t’ if iter is the end iterator, i.e. one past the last dereferenceable iterator in the buffer.gtk-text-iter-is-endis the most efficient way to check whether an iterator is the end iterator.
- iter
- an iterator
- ret
- whether iter is the end iterator
<gtk-text-iter>) ⇒ (ret bool)Returns ‘
#t’ if iter is the first iterator in the buffer, that is if iter has a character offset of 0.
- iter
- an iterator
- ret
- whether iter is the first in the buffer
<gtk-text-iter>) ⇒ (ret bool)Moves iter forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so
gtk-text-iter-forward-charmay actually move onto an image instead of a character, if you have images in your buffer. If iter is the end iterator or one character before it, iter will now point at the end iterator, andgtk-text-iter-forward-charreturns ‘#f’ for convenience when writing loops.
- iter
- an iterator
- ret
- whether iter moved and is dereferenceable
<gtk-text-iter>) ⇒ (ret bool)Moves backward by one character offset. Returns ‘
#t’ if movement was possible; if iter was the first in the buffer (character offset 0),gtk-text-iter-backward-charreturns ‘#f’ for convenience when writing loops.
- iter
- an iterator
- ret
- whether movement was possible
<gtk-text-iter>) (count int) ⇒ (ret bool)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 different from its original position, and dereferenceable (the last iterator in the buffer is not dereferenceable). If count is 0, the function does nothing and returns ‘
#f’.
- iter
- an iterator
- count
- number of characters to move, may be negative
- ret
- whether iter moved and is dereferenceable
<gtk-text-iter>) (count int) ⇒ (ret bool)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 moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then ‘
#f’ is returned. If count is 0, the function does nothing and returns ‘#f’.
- iter
- an iterator
- count
- number of characters to move
- ret
- whether iter moved and is dereferenceable
<gtk-text-iter>) ⇒ (ret bool)Moves iter to the start of the next line. Returns ‘
#t’ if there was a next line to move to, and ‘#f’ if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer.
- iter
- an iterator
- ret
- whether iter can be dereferenced
<gtk-text-iter>) ⇒ (ret bool)Moves iter to the start of the previous line. Returns ‘
#t’ if iter could be moved; i.e. if iter was at character offset 0, this function returns ‘#f’. Therefore if iter was already on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns ‘#t’. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.)
- iter
- an iterator
- ret
- whether iter moved
<gtk-text-iter>) (count int) ⇒ (ret bool)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 onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then ‘
#f’ is returned. If count is 0, the function does nothing and returns ‘#f’. If count is negative, moves backward by 0 - count lines.
- iter
- a
<gtk-text-iter>- count
- number of lines to move forward
- ret
- whether iter moved and is dereferenceable
<gtk-text-iter>) (count int) ⇒ (ret bool)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 onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then ‘
#f’ is returned. If count is 0, the function does nothing and returns ‘#f’. If count is negative, moves forward by 0 - count lines.
- iter
- a
<gtk-text-iter>- count
- number of lines to move backward
- ret
- whether iter moved and is dereferenceable
<gtk-text-iter>) (count int) ⇒ (ret bool)Calls
gtk-text-iter-forward-word-endup to count times.
- iter
- a
<gtk-text-iter>- count
- number of times to move
- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) (count int) ⇒ (ret bool)Calls
gtk-text-iter-backward-word-startup to count times.
- iter
- a
<gtk-text-iter>- count
- number of times to move
- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) ⇒ (ret bool)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 (if not, the correct fix would be to the Pango word break algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) ⇒ (ret bool)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 any language (if not, the correct fix would be to the Pango word break algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) ⇒ (ret bool)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 language (if not, the correct fix would be to the Pango text boundary algorithms).
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) (count int) ⇒ (ret bool)Calls
gtk-text-iter-forward-sentence-endcount times (or untilgtk-text-iter-forward-sentence-endreturns ‘#f’). If count is negative, moves backward instead of forward.
- iter
- a
<gtk-text-iter>- count
- number of sentences to move
- ret
- ‘
#t’ if iter moved and is not the end iterator
<gtk-text-iter>) ⇒ (ret bool)Moves iter to the start of the next visible line. Returns ‘
#t’ if there was a next line to move to, and ‘#f’ if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer.
- iter
- an iterator
- ret
- whether iter can be dereferenced
Since 2.8
<gtk-text-iter>) ⇒ (ret bool)Moves iter to the start of the previous visible line. Returns ‘
#t’ if iter could be moved; i.e. if iter was at character offset 0, this function returns ‘#f’. Therefore if iter was already on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns ‘#t’. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.)
- iter
- an iterator
- ret
- whether iter moved
Since 2.8
<gtk-text-iter>) (count int) ⇒ (ret bool)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 moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then ‘
#f’ is returned. If count is 0, the function does nothing and returns ‘#f’. If count is negative, moves backward by 0 - count lines.
- iter
- a
<gtk-text-iter>- count
- number of lines to move forward
- ret
- whether iter moved and is dereferenceable
Since 2.8
<gtk-text-iter>) (char_offset int)Sets iter to point to char-offset. char-offset counts from the start of the entire text buffer, starting with 0.
- iter
- a
<gtk-text-iter>- char-offset
- a character number
<gtk-text-iter>) (line_number int)Moves iterator iter to the start of the line line-number. If line-number is negative or larger than the number of lines in the buffer, moves iter to the start of the last line in the buffer.
- iter
- a
<gtk-text-iter>- line-number
- line number (counted from 0)
<gtk-text-iter>) (char_on_line int)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 the next line. See
gtk-text-iter-set-line-indexif you have a byte index rather than a character offset.
- iter
- a
<gtk-text-iter>- char-on-line
- a character offset relative to the start of iter's current line
<gtk-text-iter>) (byte_on_line int)Same as
gtk-text-iter-set-line-offset, 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.
- iter
- a
<gtk-text-iter>- byte-on-line
- a byte index relative to the start of iter's current line
<gtk-text-iter>)Moves iter forward to the "end iterator," which points one past the last valid character in the buffer.
gtk-text-iter-get-charcalled on the end iterator returns 0, which is convenient for writing loops.
- iter
- a
<gtk-text-iter>
<gtk-text-iter>) ⇒ (ret bool)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 character. If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns ‘
#f’.
- iter
- a
<gtk-text-iter>- ret
- ‘
#t’ if we moved and the new location is not the end iterator
<gtk-text-iter>) (tag <gtk-text-tag>) ⇒ (ret bool)Moves forward to the next toggle (on or off) of the
<gtk-text-tag>tag, or to the next toggle of any tag if tag is ‘#f’. If no matching tag toggles are found, returns ‘#f’, otherwise ‘#t’. Does not return toggles located at iter, only toggles after iter. Sets iter to the location of the toggle, or to the end of the buffer if no toggle is found.
- iter
- a
<gtk-text-iter>- tag
- a
<gtk-text-tag>, or ‘#f’- ret
- whether we found a tag toggle after iter
<gtk-text-iter>) (str mchars) (flags <gtk-text-search-flags>) (match_start <gtk-text-iter>) (match_end <gtk-text-iter>) (limit <gtk-text-iter>) ⇒ (ret bool)Searches forward for str. Any match is returned by setting match-start to the first character of the match and match-end to the first character after the match. The search will not continue past limit. Note that a search is a linear or O(n) operation, so you may wish to use limit to avoid locking up your UI on large buffers.
If the
<gtk-text-search-visible-only>flag is present, the match may have invisible text interspersed in str. i.e. str will be a possibly-noncontiguous subsequence of the matched range. similarly, if you specify<gtk-text-search-text-only>, the match may have pixbufs or child widgets mixed inside the matched range. If these flags are not given, the match must be exact; the special 0xFFFC character in str will match embedded pixbufs or child widgets.
- iter
- start of search
- str
- a search string
- flags
- flags affecting how the search is done
- match-start
- return location for start of match, or ‘
#f’- match-end
- return location for end of match, or ‘
#f’- limit
- bound for the search, or ‘
#f’ for the end of the buffer- ret
- whether a match was found
<gtk-text-iter>) (str mchars) (flags <gtk-text-search-flags>) (match_start <gtk-text-iter>) (match_end <gtk-text-iter>) (limit <gtk-text-iter>) ⇒ (ret bool)Same as
gtk-text-iter-forward-search, but moves backward.
- iter
- a
<gtk-text-iter>where the search begins- str
- search string
- flags
- bitmask of flags affecting the search
- match-start
- return location for start of match, or ‘
#f’- match-end
- return location for end of match, or ‘
#f’- limit
- location of last possible match-start, or ‘
#f’ for start of buffer- ret
- whether a match was found
<gtk-text-iter>) (rhs <gtk-text-iter>) ⇒ (ret bool)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 and comparing the offsets yourself. Also, it's a bit faster than
gtk-text-iter-compare.
- lhs
- a
<gtk-text-iter>- rhs
- another
<gtk-text-iter>- ret
- ‘
#t’ if the iterators point to the same place in the buffer
<gtk-text-iter>) (rhs <gtk-text-iter>) ⇒ (ret int)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 character in the buffer is less than the second character in the buffer.
- lhs
- a
<gtk-text-iter>- rhs
- another
<gtk-text-iter>- ret
- -1 if lhs is less than rhs, 1 if lhs is greater, 0 if they are equal
<gtk-text-iter>) (start <gtk-text-iter>) (end <gtk-text-iter>) ⇒ (ret bool)Checks whether iter falls in the range [start, end). start and end must be in ascending order.
- iter
- a
<gtk-text-iter>- start
- start of range
- end
- end of range
- ret
- ‘
#t’ if iter is in the range
<gtk-text-iter>) (second <gtk-text-iter>)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 automatically on your behalf, so there's no real reason to call it yourself in those cases. There are some exceptions, such as
gtk-text-iter-in-range, that expect a pre-sorted range.
- first
- a
<gtk-text-iter>- second
- another
<gtk-text-iter>