About all my projects
NO_TITLE

NO_TITLE

Gnome::Gtk4::N-TextIter

![](images/textiter.png)

Description

An iterator for the contents of a Gnome::Gtk4::TextBuffer.

You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), which gives an overview of all the objects and data types related to the text widget and how they work together.

Record N-TextIter

class N-TextIter:auth<github:MARTIMM>:api<2> is export is repr('CStruct') {

  has gpointer $.dummy1;
  has gpointer $.dummy2;
  has gint $.dummy3;
  has gint $.dummy4;
  has gint $.dummy5;
  has gint $.dummy6;
  has gint $.dummy7;
  has gint $.dummy8;
  has gpointer $.dummy9;
  has gpointer $.dummy10;
  has gint $.dummy11;
  has gint $.dummy12;
  has gint $.dummy13;
  has gpointer $.dummy14;
}

  • dummy1;

  • dummy2;

  • dummy3;

  • dummy4;

  • dummy5;

  • dummy6;

  • dummy7;

  • dummy8;

  • dummy9;

  • dummy10;

  • dummy11;

  • dummy12;

  • dummy13;

  • dummy14;

Class initialization

new

:native-object

Create an object using a native object from elsewhere. See also Gnome::N::TopLevelSupportClass.

multi method new ( N-Object :$native-object! )

Methods

assign

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.

method assign ( CArray[N-TextIter] $other )

  • $other; another Gnome::Gtk4::N-TextIter.

backward-char

Moves backward by one character offset.

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.

method backward-char (--> Bool )

Return value; whether movement was possible.

backward-chars

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

method backward-chars ( Int() $count --> Bool )

  • $count; number of characters to move.

Return value; whether $iter moved and is dereferenceable.

backward-cursor-position

Like .forward-cursor-position(), but moves backward.

method backward-cursor-position (--> Bool )

Return value; True if we moved.

backward-cursor-positions

Moves up to $count cursor positions.

See .forward-cursor-position() for details.

method backward-cursor-positions ( Int() $count --> Bool )

  • $count; number of positions to move.

Return value; True if we moved and the new position is dereferenceable.

backward-find-char

Same as .forward-find-char(), but goes backward from $iter.

method backward-find-char ( &pred, gpointer $user-data, CArray[N-TextIter] $limit --> Bool )

  • &pred; function to be called on each character. Tthe function must be specified with following signature; :( gunichar $ch, gpointer $user-data -- gboolean )>.

  • $user-data; user data for $pred.

  • $limit; search limit.

Return value; whether a match was found.

backward-line

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

method backward-line (--> Bool )

Return value; whether $iter moved.

backward-lines

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

method backward-lines ( Int() $count --> Bool )

  • $count; number of lines to move backward.

Return value; whether $iter moved and is dereferenceable.

Same as .forward-search(), but moves backward. $match-end will never be set to a Gnome::Gtk4::N-TextIter located after $iter, even if there is a possible $match-start before or at $iter.

method backward-search ( Str $str, UInt $flags, CArray[N-TextIter] $match-start, CArray[N-TextIter] $match-end, CArray[N-TextIter] $limit --> Bool )

  • $str; search string.

  • $flags; bitmask of flags affecting the search.

  • $match-start; return location for start of match.

  • $match-end; return location for end of match.

  • $limit; location of last possible $match-start, or undefined for start of buffer.

Return value; whether a match was found.

backward-sentence-start

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

method backward-sentence-start (--> Bool )

Return value; True if $iter moved and is not the end iterator.

backward-sentence-starts

Calls .backward-sentence-start() up to $count times.

If $count is negative, moves forward instead of backward.

method backward-sentence-starts ( Int() $count --> Bool )

  • $count; number of sentences to move.

Return value; True if $iter moved and is not the end iterator.

backward-to-tag-toggle

Moves backward to the next toggle (on or off) of the $tag, or to the next toggle of any tag if $tag is undefined.

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.

method backward-to-tag-toggle ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether we found a tag toggle before $iter.

backward-visible-cursor-position

Moves $iter forward to the previous visible cursor position.

See .backward-cursor-position() for details.

method backward-visible-cursor-position (--> Bool )

Return value; True if we moved and the new position is dereferenceable.

backward-visible-cursor-positions

Moves up to $count visible cursor positions.

See .backward-cursor-position() for details.

method backward-visible-cursor-positions ( Int() $count --> Bool )

  • $count; number of positions to move.

Return value; True if we moved and the new position is dereferenceable.

backward-visible-line

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

method backward-visible-line (--> Bool )

Return value; whether $iter moved.

backward-visible-lines

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

method backward-visible-lines ( Int() $count --> Bool )

  • $count; number of lines to move backward.

Return value; whether $iter moved and is dereferenceable.

backward-visible-word-start

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

method backward-visible-word-start (--> Bool )

Return value; True if $iter moved and is not the end iterator.

backward-visible-word-starts

Calls .backward-visible-word-start() up to $count times.

method backward-visible-word-starts ( Int() $count --> Bool )

  • $count; number of times to move.

Return value; True if $iter moved and is not the end iterator.

backward-word-start

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

method backward-word-start (--> Bool )

Return value; True if $iter moved and is not the end iterator.

backward-word-starts

Calls .backward-word-start() up to $count times.

method backward-word-starts ( Int() $count --> Bool )

  • $count; number of times to move.

Return value; True if $iter moved and is not the end iterator.

can-insert

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. .insert-interactive() in class Gnome::Gtk4::TextBuffer uses this function to decide whether insertions are allowed at a given position.

method can-insert ( Bool() $default-editability --> Bool )

  • $default-editability; True if text is editable by default.

Return value; whether text inserted at $iter would be editable.

compare

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.

method compare ( CArray[N-TextIter] $rhs --> Int )

  • $rhs; another Gnome::Gtk4::N-TextIter.

Return value; -1 if $lhs is less than $rhs, 1 if $lhs is greater, 0 if they are equal.

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 used by language bindings.

method copy (--> CArray[N-TextIter] )

Return value; a copy of the $iter, free with .free().

editable

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 Gnome::Gtk4::TextView. 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 .can-insert() to handle this case.

method editable ( Bool() $default-setting --> Bool )

  • $default-setting; True if text is editable by default.

Return value; whether $iter is inside an editable range.

ends-line

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

method ends-line (--> Bool )

Return value; whether $iter is at the end of a line.

ends-sentence

Determines whether $iter ends a sentence.

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

method ends-sentence (--> Bool )

Return value; True if $iter is at the end of a sentence..

ends-tag

Returns True if $tag is toggled off at exactly this point.

If $tag is undefined, 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 .starts-tag(), if this function returns True, .has-tag() will return False for the same parameters.

method ends-tag ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether $iter is the end of a range tagged with $tag.

ends-word

Determines whether $iter ends a natural-language word.

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

method ends-word (--> Bool )

Return value; True if $iter is at the end of a word.

equal

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

method equal ( CArray[N-TextIter] $rhs --> Bool )

  • $rhs; another Gnome::Gtk4::N-TextIter.

Return value; True if the iterators point to the same place in the buffer.

forward-char

Moves $iter forward by one character offset.

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.

method forward-char (--> Bool )

Return value; whether $iter moved and is dereferenceable.

forward-chars

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

method forward-chars ( Int() $count --> Bool )

  • $count; number of characters to move, may be negative.

Return value; whether $iter moved and is dereferenceable.

forward-cursor-position

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 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 Gnome::Pango::N-LogAttr struct and the .break() in package Gnome::Pango function.

method forward-cursor-position (--> Bool )

Return value; True if we moved and the new position is dereferenceable.

forward-cursor-positions

Moves up to $count cursor positions.

See .forward-cursor-position() for details.

method forward-cursor-positions ( Int() $count --> Bool )

  • $count; number of positions to move.

Return value; True if we moved and the new position is dereferenceable.

forward-find-char

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-undefined, otherwise to the end iterator.

method forward-find-char ( &pred, gpointer $user-data, CArray[N-TextIter] $limit --> Bool )

  • &pred; a function to be called on each character. Tthe function must be specified with following signature; :( gunichar $ch, gpointer $user-data -- gboolean )>.

  • $user-data; user data for $pred.

  • $limit; search limit.

Return value; whether a match was found.

forward-line

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 buffer and not dereferenceable, returns False. Otherwise, returns True.

method forward-line (--> Bool )

Return value; whether $iter can be dereferenced.

forward-lines

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

method forward-lines ( Int() $count --> Bool )

  • $count; number of lines to move forward.

Return value; whether $iter moved and is dereferenceable.

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. $match-start will never be set to a Gnome::Gtk4::N-TextIter located before $iter, even if there is a possible $match-end after or at $iter.

method forward-search ( Str $str, UInt $flags, CArray[N-TextIter] $match-start, CArray[N-TextIter] $match-end, CArray[N-TextIter] $limit --> Bool )

  • $str; a search string.

  • $flags; flags affecting how the search is done.

  • $match-start; return location for start of match.

  • $match-end; return location for end of match.

  • $limit; location of last possible $match-end, or undefined for the end of the buffer.

Return value; whether a match was found.

forward-sentence-end

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.

method forward-sentence-end (--> Bool )

Return value; True if $iter moved and is not the end iterator.

forward-sentence-ends

Calls .forward-sentence-end() $count times.

If $count is negative, moves backward instead of forward.

method forward-sentence-ends ( Int() $count --> Bool )

  • $count; number of sentences to move.

Return value; True if $iter moved and is not the end iterator.

forward-to-end

Moves $iter forward to the “end iterator”, which points one past the last valid character in the buffer.

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

method forward-to-end ( )

forward-to-line-end

Moves the iterator to point to the paragraph delimiter characters.

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.

method forward-to-line-end (--> Bool )

Return value; True if we moved and the new location is not the end iterator.

forward-to-tag-toggle

Moves forward to the next toggle (on or off) of the $tag, or to the next toggle of any tag if $tag is undefined.

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.

method forward-to-tag-toggle ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether we found a tag toggle after $iter.

forward-visible-cursor-position

Moves $iter forward to the next visible cursor position.

See .forward-cursor-position() for details.

method forward-visible-cursor-position (--> Bool )

Return value; True if we moved and the new position is dereferenceable.

forward-visible-cursor-positions

Moves up to $count visible cursor positions.

See .forward-cursor-position() for details.

method forward-visible-cursor-positions ( Int() $count --> Bool )

  • $count; number of positions to move.

Return value; True if we moved and the new position is dereferenceable.

forward-visible-line

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

method forward-visible-line (--> Bool )

Return value; whether $iter can be dereferenced.

forward-visible-lines

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

method forward-visible-lines ( Int() $count --> Bool )

  • $count; number of lines to move forward.

Return value; whether $iter moved and is dereferenceable.

forward-visible-word-end

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 language

method forward-visible-word-end (--> Bool )

Return value; True if $iter moved and is not the end iterator.

forward-visible-word-ends

Calls .forward-visible-word-end() up to $count times.

method forward-visible-word-ends ( Int() $count --> Bool )

  • $count; number of times to move.

Return value; True if $iter moved and is not the end iterator.

forward-word-end

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.

method forward-word-end (--> Bool )

Return value; True if $iter moved and is not the end iterator.

forward-word-ends

Calls .forward-word-end() up to $count times.

method forward-word-ends ( Int() $count --> Bool )

  • $count; number of times to move.

Return value; True if $iter moved and is not the end iterator.

free

Free an iterator allocated on the heap.

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.

method free ( )

get-buffer

Returns the Gnome::Gtk4::TextBuffer this iterator is associated with.

method get-buffer (--> N-Object )

Return value; the buffer.

get-bytes-in-line

Returns the number of bytes in the line containing $iter, including the paragraph delimiters.

method get-bytes-in-line (--> Int )

Return value; number of bytes in the line.

get-char

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

method get-char (--> UInt )

Return value; a Unicode character, or 0 if $iter is not dereferenceable.

get-chars-in-line

Returns the number of characters in the line containing $iter, including the paragraph delimiters.

method get-chars-in-line (--> Int )

Return value; number of characters in the line.

get-child-anchor

If the location at $iter contains a child anchor, the anchor is returned.

Otherwise, undefined is returned.

method get-child-anchor (--> N-Object )

Return value; the anchor at $iter.

get-language This function is not yet available

Returns the language in effect at $iter.

If no tags affecting language apply to $iter, the return value is identical to that of .get-default-language().

method get-language (--> CArray[N-Language]  )

Return value; language in effect at $iter.

get-line

Returns the line number containing the iterator.

Lines in a Gnome::Gtk4::TextBuffer are numbered beginning with 0 for the first line in the buffer.

method get-line (--> Int )

Return value; a line number.

get-line-index

Returns the byte index of the iterator, counting from the start of a newline-terminated line.

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

method get-line-index (--> Int )

Return value; distance from start of line, in bytes.

get-line-offset

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.

method get-line-offset (--> Int )

Return value; offset from start of line.

get-marks

Returns a list of all Gnome::Gtk4::TextMark 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.

method get-marks (--> N-SList )

Return value; list of Gnome::Gtk4::TextMark.

get-offset

Returns the character offset of an iterator.

Each character in a Gnome::Gtk4::TextBuffer has an offset, starting with 0 for the first character in the buffer. Use [method $Gtk,TextBuffer.get_iter_at_offset] to convert an offset back into an iterator.

method get-offset (--> Int )

Return value; a character offset.

get-paintable

If the element at $iter is a paintable, the paintable is returned.

Otherwise, undefined is returned.

method get-paintable (--> N-Object )

Return value; the paintable at $iter.

get-slice

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

method get-slice ( CArray[N-TextIter] $end --> Str )

  • $end; iterator at end of a range.

Return value; slice of text from the buffer.

get-tags

Returns a list of tags that apply to $iter, in ascending order of priority.

The highest-priority tags are last.

The Gnome::Gtk4::TextTags in the list don’t have a reference added, but you have to free the list itself.

method get-tags (--> N-SList )

Return value; list of Gnome::Gtk4::TextTag.

get-text

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 .get-slice().

method get-text ( CArray[N-TextIter] $end --> Str )

  • $end; iterator at end of a range.

Return value; array of characters from the buffer.

get-toggled-tags

Returns a list of Gnome::Gtk4::TextTag 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 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.

method get-toggled-tags ( Bool() $toggled-on --> N-SList )

  • $toggled-on; True to get toggled-on tags.

Return value; tags toggled at this point.

get-visible-line-index

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.

method get-visible-line-index (--> Int )

Return value; byte index of $iter with respect to the start of the line.

get-visible-line-offset

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.

method get-visible-line-offset (--> Int )

Return value; offset in visible characters from the start of the line.

get-visible-slice

Returns visible text in the given range.

Like .get-slice(), but invisible text is not included. Invisible text is usually invisible because a Gnome::Gtk4::TextTag with the “invisible” attribute turned on has been applied to it.

method get-visible-slice ( CArray[N-TextIter] $end --> Str )

  • $end; iterator at end of range.

Return value; slice of text from the buffer.

get-visible-text

Returns visible text in the given range.

Like .get-text(), but invisible text is not included. Invisible text is usually invisible because a Gnome::Gtk4::TextTag with the “invisible” attribute turned on has been applied to it.

method get-visible-text ( CArray[N-TextIter] $end --> Str )

  • $end; iterator at end of range.

Return value; string containing visible text in the range.

has-tag

Returns True if $iter points to a character that is part of a range tagged with $tag.

See also .starts-tag() and .ends-tag().

method has-tag ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether $iter is tagged with $tag.

in-range

Checks whether $iter falls in the range [ $start, $end). $start and $end must be in ascending order.

method in-range ( CArray[N-TextIter] $start, CArray[N-TextIter] $end --> Bool )

  • $start; start of range.

  • $end; end of range.

Return value; True if $iter is in the range.

inside-sentence

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.

method inside-sentence (--> Bool )

Return value; True if $iter is inside a sentence..

inside-word

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

Note that if .starts-word() returns True, then this function returns True too, since $iter points to the first character of the word.

method inside-word (--> Bool )

Return value; True if $iter is inside a word.

is-cursor-position

Determine if $iter is at a cursor position.

See .forward-cursor-position() or Gnome::Pango::N-LogAttr or .break() in package Gnome::Pango for details on what a cursor position is.

method is-cursor-position (--> Bool )

Return value; True if the cursor can be placed at $iter.

is-end

Returns True if $iter is the end iterator.

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

method is-end (--> Bool )

Return value; whether $iter is the end iterator.

is-start

Returns True if $iter is the first iterator in the buffer.

method is-start (--> Bool )

Return value; whether $iter is the first in the buffer.

order

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 .in-range(), that expect a pre-sorted range.

method order ( CArray[N-TextIter] $second )

  • $second; another Gnome::Gtk4::N-TextIter.

set-line

Moves iterator $iter to the start of the line $line-number.

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.

method set-line ( Int() $line-number )

  • $line-number; line number (counted from 0).

set-line-index

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

method set-line-index ( Int() $byte-on-line )

  • $byte-on-line; a byte index relative to the start of $iter’s current line.

set-line-offset

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 .set-line-index() if you have a byte index rather than a character offset.

method set-line-offset ( Int() $char-on-line )

  • $char-on-line; a character offset relative to the start of $iter’s current line.

set-offset

Sets $iter to point to $char-offset. $char-offset counts from the start of the entire text buffer, starting with 0.

method set-offset ( Int() $char-offset )

  • $char-offset; a character number.

set-visible-line-index

Like .set-line-index(), but the index is in visible bytes, i.e. text with a tag making it invisible is not counted in the index.

method set-visible-line-index ( Int() $byte-on-line )

  • $byte-on-line; a byte index.

set-visible-line-offset

Like .set-line-offset(), but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset.

method set-visible-line-offset ( Int() $char-on-line )

  • $char-on-line; a character offset.

starts-line

Returns True if $iter begins a paragraph.

This is the case if .get-line-offset() would return 0. However this function is potentially more efficient than .get-line-offset(), because it doesn’t have to compute the offset, it just has to see whether it’s 0.

method starts-line (--> Bool )

Return value; whether $iter begins a line.

starts-sentence

Determines whether $iter begins a sentence.

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

method starts-sentence (--> Bool )

Return value; True if $iter is at the start of a sentence..

starts-tag

Returns True if $tag is toggled on at exactly this point.

If $tag is undefined, 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 .ends-tag(), if this function returns True, [method $Gtk.TextIter.has_tag will also return True for the same parameters.

method starts-tag ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether $iter is the start of a range tagged with $tag.

starts-word

Determines whether $iter begins a natural-language word.

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

method starts-word (--> Bool )

Return value; True if $iter is at the start of a word.

toggles-tag

Gets whether a range with $tag applied to it begins or ends at $iter.

This is equivalent to (.starts-tag() || .ends-tag())

method toggles-tag ( N-Object() $tag --> Bool )

  • $tag; a Gnome::Gtk4::TextTag.

Return value; whether $tag is toggled on or off at $iter.