Class TextIter

This function is not useful in applications, because iterators can be assigned with GtkTextIter i = j;.

The function is used by language bindings.

Returns %TRUE if movement was possible; if iter was the first in the buffer (character offset 0), this function returns %FALSE for convenience when writing loops.

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 %FALSE is returned. If count is 0, the function does nothing and returns %FALSE.

See [methodGtk.TextIter.forward_cursor_position] for details.

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 not at the start of the line, iter is snapped to the start of the line and the function returns %TRUE. (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.)

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 %FALSE is returned. If count is 0, the function does nothing and returns %FALSE. If count is negative, moves forward by 0 - count lines.

match_end will never be set to a GtkTextIter located after iter, even if there is a possible match_start before or at iter.

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 nearly any language.

If count is negative, moves forward instead of backward.

If no matching tag toggles are found, returns %FALSE, otherwise %TRUE. Does not return toggles located at iter, only toggles before iter. Sets iter to the location of the toggle, or the start of the buffer if no toggle is found.

See [methodGtk.TextIter.backward_cursor_position] for details.

See [methodGtk.TextIter.backward_cursor_position] for details.

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 not at the start of the line, iter is snapped to the start of the line and the function returns %TRUE. (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.)

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 %FALSE is returned. If count is 0, the function does nothing and returns %FALSE. If count is negative, moves forward by 0 - count lines.

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 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 text inserted at iter would be editable then the user should be allowed to insert text at iter. [methodGtk.TextBuffer.insert_interactive] uses this function to decide whether insertions are allowed at a given position.

Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer.

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.

Non-editable text is “locked” and can’t be changed by the user via GtkTextView. 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 [methodGtk.TextIter.can_insert] to handle this case.

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.

Sentence boundaries are determined by Pango and should be correct for nearly any language.

If tag is %NULL, returns %TRUE if any tag is toggled off at this point.

Note that if this function returns %TRUE, it means that iter is at the end of the tagged range, but that the character at iter is outside the tagged range. In other words, unlike [methodGtk.TextIter.starts_tag], if this function returns %TRUE, [methodGtk.TextIter.has_tag] will return %FALSE for the same parameters.

Word breaks are determined by Pango and should be correct for nearly any language.

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 [methodGtk.TextIter.compare].

Note that images embedded in the buffer occupy 1 character slot, so this function may 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, and this function returns %FALSE for convenience when writing loops.

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 %FALSE.

Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all characters. The most common example for European languages would be a carriage return/newline sequence.

For some Unicode characters, the equivalent of say the letter “a” with an accent mark will be represented as two characters, first the letter then a "combining mark" that causes the accent to be rendered; so the cursor can’t go between those two characters.

See also the [structPango.LogAttr] struct and the [funcPango.break] function.

See [methodGtk.TextIter.forward_cursor_position] for details.

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

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 buffer and not dereferenceable, returns %FALSE. Otherwise, returns %TRUE.

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 %FALSE is returned. If count is 0, the function does nothing and returns %FALSE. If count is negative, moves backward by 0 - count lines.

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.

match_start will never be set to a GtkTextIter located before iter, even if there is a possible match_end after or at iter.

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 count is negative, moves backward instead of forward.

gtk_text_iter_get_char() called on the end iterator returns 0, which is convenient for writing loops.

The possible characters are 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 %FALSE.

If no matching tag toggles are found, returns %FALSE, otherwise %TRUE. 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.

See [methodGtk.TextIter.forward_cursor_position] for details.

See [methodGtk.TextIter.forward_cursor_position] for details.

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 iter was already at the end of the buffer.

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 %FALSE is returned. If count is 0, the function does nothing and returns %FALSE. If count is negative, moves backward by 0 - count lines.

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

This function is intended for use in language bindings, and is not especially useful for applications, because iterators can simply be allocated on the stack.

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 this function returns 0.

Otherwise, %NULL is returned.

If no tags affecting language apply to iter, the return value is identical to that of [funcGtk.get_default_language].

Lines in a GtkTextBuffer are numbered beginning with 0 for the first line in the buffer.

Remember that GtkTextBuffer encodes text in UTF-8, and that characters can require a variable number of bytes to represent.

The first character on the line has offset 0.

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.

Each character in a GtkTextBuffer has an offset, starting with 0 for the first character in the buffer. Use [methodGtk,TextBuffer.get_iter_at_offset] to convert an offset back into an iterator.

Otherwise, %NULL is returned.

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 paintable or widget is in the buffer.

The highest-priority tags are last.

The GtkTextTags in the list don’t have a reference added, but you have to free the list itself.

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 [methodGtk.TextIter.get_slice].

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

Like [methodGtk.TextIter.get_slice], but invisible text is not included. Invisible text is usually invisible because a GtkTextTag with the “invisible” attribute turned on has been applied to it.

Like [methodGtk.TextIter.get_text], but invisible text is not included. Invisible text is usually invisible because a GtkTextTag with the “invisible” attribute turned on has been applied to it.

See also [methodGtk.TextIter.starts_tag] and [methodGtk.TextIter.ends_tag].

start and end must be in ascending order.

Sentence boundaries are determined by Pango and should be correct for nearly any language.

Word breaks are determined by Pango and should be correct for nearly any language.

Note that if [methodGtk.TextIter.starts_word] returns %TRUE, then this function returns %TRUE too, since iter points to the first character of the word.

See [methodGtk.TextIter.forward_cursor_position] or [structPango.LogAttr] or [funcPango.break] for details on what a cursor position is.

This means it is one past the last dereferenceable iterator in the buffer. gtk_text_iter_is_end() is the most efficient way to check whether an iterator is the end iterator.

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 [methodGtk.TextIter.in_range], that expect a pre-sorted range.

If line_number is negative or larger than or equal to the number of lines in the buffer, moves iter to the start of the last line in the buffer.

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 [methodGtk.TextIter.set_line_index] if you have a byte index rather than a character offset.

char_offset counts from the start of the entire text buffer, starting with 0.

This is the case if [methodGtk.TextIter.get_line_offset] would return 0. However this function is potentially more efficient than [methodGtk.TextIter.get_line_offset], because it doesn’t have to compute the offset, it just has to see whether it’s 0.

Sentence boundaries are determined by Pango and should be correct for nearly any language.

If tag is %NULL, returns %TRUE if any tag is toggled on at this point.

Note that if this function returns %TRUE, it means that iter is at the beginning of the tagged range, and that the character at iter is inside the tagged range. In other words, unlike [methodGtk.TextIter.ends_tag], if this function returns %TRUE, [methodGtk.TextIter.has_tag will also return %TRUE for the same parameters.

Word breaks are determined by Pango and should be correct for nearly any language.

This is equivalent to (gtk_text_iter_starts_tag() || gtk_text_iter_ends_tag())