W Wrapl, The Programming Language

Libraries:Gtk:Gtk:TextIter

Types

T

Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



_Alloc() : Gtk.Gtk.TextIter.T



Methods

:"="(_ @ T, _ @ T)

:BackwardChar(self @ T) : Std.Symbol.T

Moves backward by one character offset. Returns TRUE if movement was possible; if iter was the first in the buffer (character offset 0), BackwardChar returns FALSE for convenience when writing loops.

iter an iterator
Returns whether movement was possible


:BackwardChars(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter an iterator
count number of characters to move
Returns whether iter moved and is dereferenceable


:BackwardCursorPosition(self @ T) : Std.Symbol.T

Like ForwardCursorPosition, but moves backward.

iter a T
Returns TRUE if we moved


:BackwardCursorPositions(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Moves up to count cursor positions. See ForwardCursorPosition for details.

iter a T
count number of positions to move
Returns TRUE if we moved and the new position is dereferenceable


:BackwardFindChar(self @ T, pred @ Std.Function.T, user_data, limit @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

Same as ForwardFindChar, but goes backward from iter.

iter a T
pred function to be called on each character. [scope call]
user_data user data for pred
limit search limit, or NULL for none. [allow-none]
Returns whether a match was found


:BackwardLine(self @ T) : Std.Symbol.T

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

iter an iterator
Returns whether iter moved


:BackwardLines(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter a T
count number of lines to move backward
Returns whether iter moved and is dereferenceable


:BackwardSearch(self @ T, str @ Std.String.T, flags @ Std.Integer.SmallT, match_start @ Gtk.Gtk.TextIter.T, match_end @ Gtk.Gtk.TextIter.T, limit @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

Same as ForwardSearch, but moves backward.

iter a T where the search begins
str search string
flags bitmask of flags affecting the search
match_start return location for start of match, or NULL. [out caller-allocates][allow-none]
match_end return location for end of match, or NULL. [out caller-allocates][allow-none]
limit location of last possible match_start, or NULL for start of buffer. [allow-none]
Returns whether a match was found


:BackwardSentenceStart(self @ T) : Std.Symbol.T

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 (if not, the correct fix would be to the Pango text boundary algorithms).

iter a T
Returns TRUE if iter moved and is not the end iterator


:BackwardSentenceStarts(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls BackwardSentenceStart up to count times, or until it returns FALSE. If count is negative, moves forward instead of backward.

iter a T
count number of sentences to move
Returns TRUE if iter moved and is not the end iterator


:BackwardToTagToggle(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

Moves backward to the next toggle (on or off) of the Gtk.Gtk.TextTag.T 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 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.

iter a T
tag a Gtk.Gtk.TextTag.T, or NULL. [allow-none]
Returns whether we found a tag toggle before iter


:BackwardVisibleCursorPosition(self @ T) : Std.Symbol.T

Moves iter forward to the previous visible cursor position. See BackwardCursorPosition for details.

iter a T
Returns TRUE if we moved and the new position is dereferenceable


:BackwardVisibleCursorPositions(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Moves up to count visible cursor positions. See BackwardCursorPosition for details.

iter a T
count number of positions to move
Returns TRUE if we moved and the new position is dereferenceable


:BackwardVisibleLine(self @ T) : Std.Symbol.T

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

iter an iterator
Returns whether iter moved


:BackwardVisibleLines(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter a T
count number of lines to move backward
Returns whether iter moved and is dereferenceable


:BackwardVisibleWordStart(self @ T) : Std.Symbol.T

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 (if not, the correct fix would be to the Pango word break algorithms).

iter a T
Returns TRUE if iter moved and is not the end iterator


:BackwardVisibleWordStarts(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls BackwardVisibleWordStart up to count times.

iter a T
count number of times to move
Returns TRUE if iter moved and is not the end iterator


:BackwardWordStart(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter moved and is not the end iterator


:BackwardWordStarts(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls BackwardWordStart up to count times.

iter a T
count number of times to move
Returns TRUE if iter moved and is not the end iterator


:BeginsTag(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

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. Note that the BeginsTag returns TRUE if iter is the start of the tagged range; HasTag tells you whether an iterator is within a tagged range.

iter an iterator
tag a Gtk.Gtk.TextTag.T, or NULL. [allow-none]
Returns whether iter is the start of a range tagged with tag


:CanInsert(self @ T, default_editability @ Std.Symbol.T) : Std.Symbol.T

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.Gtk.TextBuffer.InsertInteractive uses this function to decide whether insertions are allowed at a given position.

iter an iterator
default_editability TRUE if text is editable by default
Returns whether text inserted at iter would be editable


:Compare(self @ T, rhs @ Gtk.Gtk.TextIter.T) : Std.Integer.SmallT

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 T
rhs another T
Returns -1 if lhs is less than rhs, 1 if lhs is greater, 0 if they are equal


:Copy(self @ T) : Gtk.Gtk.TextIter.T

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
Returns a copy of the iter, free with Free


:Editable(self @ T, default_setting @ Std.Symbol.T) : Std.Symbol.T

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.Gtk.TextView.T. This function is simply a convenience wrapper around GetAttributes. 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 CanInsert to handle this case.

iter an iterator
default_setting TRUE if text is editable by default
Returns whether iter is inside an editable range


:EndsLine(self @ T) : Std.Symbol.T

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.

iter an iterator
Returns whether iter is at the end of a line


:EndsSentence(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is at the end of a sentence.


:EndsTag(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

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. Note that the EndsTag returns TRUE if iter is the end of the tagged range; HasTag tells you whether an iterator is within a tagged range.

iter an iterator
tag a Gtk.Gtk.TextTag.T, or NULL. [allow-none]
Returns whether iter is the end of a range tagged with tag


:EndsWord(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is at the end of a word


:Equal(self @ T, rhs @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

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.

lhs a T
rhs another T
Returns TRUE if the iterators point to the same place in the buffer


:ForwardChar(self @ T) : Std.Symbol.T

Moves iter forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so ForwardChar 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 ForwardChar returns FALSE for convenience when writing loops.

iter an iterator
Returns whether iter moved and is dereferenceable


:ForwardChars(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter an iterator
count number of characters to move, may be negative
Returns whether iter moved and is dereferenceable


:ForwardCursorPosition(self @ T) : Std.Symbol.T

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 PangoLogAttr structure and pango_break() function.

iter a T
Returns TRUE if we moved and the new position is dereferenceable


:ForwardCursorPositions(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Moves up to count cursor positions. See ForwardCursorPosition for details.

iter a T
count number of positions to move
Returns TRUE if we moved and the new position is dereferenceable


:ForwardFindChar(self @ T, pred @ Std.Function.T, user_data, limit @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

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

iter a T
pred a function to be called on each character. [scope call]
user_data user data for pred
limit search limit, or NULL for none. [allow-none]
Returns whether a match was found


:ForwardLine(self @ T) : Std.Symbol.T

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 dereferencable, returns FALSE. Otherwise, returns TRUE.

iter an iterator
Returns whether iter can be dereferenced


:ForwardLines(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter a T
count number of lines to move forward
Returns whether iter moved and is dereferenceable


:ForwardSearch(self @ T, str @ Std.String.T, flags @ Std.Integer.SmallT, match_start @ Gtk.Gtk.TextIter.T, match_end @ Gtk.Gtk.TextIter.T, limit @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

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 NULL. [out caller-allocates][allow-none]
match_end return location for end of match, or NULL. [out caller-allocates][allow-none]
limit bound for the search, or NULL for the end of the buffer. [allow-none]
Returns whether a match was found


:ForwardSentenceEnd(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter moved and is not the end iterator


:ForwardSentenceEnds(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls ForwardSentenceEnd count times (or until ForwardSentenceEnd returns FALSE). If count is negative, moves backward instead of forward.

iter a T
count number of sentences to move
Returns TRUE if iter moved and is not the end iterator


:ForwardToEnd(self @ T) : Std.Object.T

Moves iter forward to the "end iterator," which points one past the last valid character in the buffer. GetChar called on the end iterator returns 0, which is convenient for writing loops.

iter a T


:ForwardToLineEnd(self @ T) : Std.Symbol.T

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

iter a T
Returns TRUE if we moved and the new location is not the end iterator


:ForwardToTagToggle(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

Moves forward to the next toggle (on or off) of the Gtk.Gtk.TextTag.T 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 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 T
tag a Gtk.Gtk.TextTag.T, or NULL. [allow-none]
Returns whether we found a tag toggle after iter


:ForwardVisibleCursorPosition(self @ T) : Std.Symbol.T

Moves iter forward to the next visible cursor position. See ForwardCursorPosition for details.

iter a T
Returns TRUE if we moved and the new position is dereferenceable


:ForwardVisibleCursorPositions(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Moves up to count visible cursor positions. See ForwardCursorPosition for details.

iter a T
count number of positions to move
Returns TRUE if we moved and the new position is dereferenceable


:ForwardVisibleLine(self @ T) : Std.Symbol.T

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.

iter an iterator
Returns whether iter can be dereferenced


:ForwardVisibleLines(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

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.

iter a T
count number of lines to move forward
Returns whether iter moved and is dereferenceable


:ForwardVisibleWordEnd(self @ T) : Std.Symbol.T

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 (if not, the correct fix would be to the Pango word break algorithms).

iter a T
Returns TRUE if iter moved and is not the end iterator


:ForwardVisibleWordEnds(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls ForwardVisibleWordEnd up to count times.

iter a T
count number of times to move
Returns TRUE if iter moved and is not the end iterator


:ForwardWordEnd(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter moved and is not the end iterator


:ForwardWordEnds(self @ T, count @ Std.Integer.SmallT) : Std.Symbol.T

Calls ForwardWordEnd up to count times.

iter a T
count number of times to move
Returns TRUE if iter moved and is not the end iterator


:Free(self @ T) : Std.Object.T

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.

iter a dynamically-allocated iterator


:GetAttributes(self @ T, values @ Gtk.Gtk.TextAttributes.T) : Std.Symbol.T

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.Gtk.TextView.GetDefaultAttributes.

GetAttributes will modify values, applying the effects of any tags present at iter. If any tags affected values, the function returns TRUE.

iter an iterator
values a Gtk.Gtk.TextAttributes.T to be filled in. [out]
Returns TRUE if values was modified


:GetBuffer(self @ T) : Gtk.Gtk.TextBuffer.T

Returns the Gtk.Gtk.TextBuffer.T this iterator is associated with.

iter an iterator
Returns the buffer. [transfer none]


:GetBytesInLine(self @ T) : Std.Integer.SmallT

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

iter an iterator
Returns number of bytes in the line


:GetChar(self @ T) : Std.Integer.SmallT

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 GetChar returns 0.

iter an iterator
Returns a Unicode character, or 0 if iter is not dereferenceable


:GetCharsInLine(self @ T) : Std.Integer.SmallT

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

iter an iterator
Returns number of characters in the line


:GetChildAnchor(self @ T) : Gtk.Gtk.TextChildAnchor.T

If the location at iter contains a child anchor, the anchor is returned (with no new reference count added). Otherwise, NULL is returned.

iter an iterator
Returns the anchor at iter. [transfer none]


:GetLanguage(self @ T) : Gtk.Pango.Language.T

A convenience wrapper around GetAttributes, which returns the language in effect at iter. If no tags affecting language apply to iter, the return value is identical to that of Gtk.Gtk.Global.GetDefaultLanguage.

iter an iterator
Returns language in effect at iter


:GetLine(self @ T) : Std.Integer.SmallT

Returns the line number containing the iterator. Lines in a Gtk.Gtk.TextBuffer.T are numbered beginning with 0 for the first line in the buffer.

iter an iterator
Returns a line number


:GetLineIndex(self @ T) : Std.Integer.SmallT

Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that Gtk.Gtk.TextBuffer.T encodes text in UTF-8, and that characters can require a variable number of bytes to represent.

iter an iterator
Returns distance from start of line, in bytes


:GetLineOffset(self @ T) : Std.Integer.SmallT

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
Returns offset from start of line


:GetMarks(self @ T) : Std.Object.T

Returns a list of all Gtk.Gtk.TextMark.T 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
Returns list of Gtk.Gtk.TextMark.T. [element-type GtkTextMark][transfer container]


:GetOffset(self @ T) : Std.Integer.SmallT

Returns the character offset of an iterator. Each character in a Gtk.Gtk.TextBuffer.T has an offset, starting with 0 for the first character in the buffer. Use Gtk.Gtk.TextBuffer.GetIterAtOffset to convert an offset back into an iterator.

iter an iterator
Returns a character offset


:GetPixbuf(self @ T) : Gtk.Gdk.Pixbuf.T

If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added). Otherwise, NULL is returned.

iter an iterator
Returns the pixbuf at iter. [transfer none]


:GetSlice(self @ T, end @ Gtk.Gtk.TextIter.T) : Std.String.T

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
Returns slice of text from the buffer


:GetTags(self @ T) : Std.Object.T

Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last). The Gtk.Gtk.TextTag.T in the list don't have a reference added, but you have to free the list itself.

iter a T
Returns list of Gtk.Gtk.TextTag.T. [element-type GtkTextTag][transfer container]


:GetText(self @ T, end @ Gtk.Gtk.TextIter.T) : Std.String.T

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

start iterator at start of a range
end iterator at end of a range
Returns array of characters from the buffer


:GetToggledTags(self @ T, toggled_on @ Std.Symbol.T) : Std.Object.T

Returns a list of Gtk.Gtk.TextTag.T 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.

iter an iterator
toggled_on TRUE to get toggled-on tags
Returns tags toggled at this point. [element-type GtkTextTag][transfer container]


:GetVisibleLineIndex(self @ T) : Std.Integer.SmallT

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.

iter a T
Returns byte index of iter with respect to the start of the line


:GetVisibleLineOffset(self @ T) : Std.Integer.SmallT

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.

iter a T
Returns offset in visible characters from the start of the line


:GetVisibleSlice(self @ T, end @ Gtk.Gtk.TextIter.T) : Std.String.T

Like GetSlice, but invisible text is not included. Invisible text is usually invisible because a Gtk.Gtk.TextTag.T with the "invisible" attribute turned on has been applied to it.

start iterator at start of range
end iterator at end of range
Returns slice of text from the buffer


:GetVisibleText(self @ T, end @ Gtk.Gtk.TextIter.T) : Std.String.T

Like GetText, but invisible text is not included. Invisible text is usually invisible because a Gtk.Gtk.TextTag.T with the "invisible" attribute turned on has been applied to it.

start iterator at start of range
end iterator at end of range
Returns string containing visible text in the range


:HasTag(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

Returns TRUE if iter is within a range tagged with tag.

iter an iterator
tag a Gtk.Gtk.TextTag.T
Returns whether iter is tagged with tag


:InRange(self @ T, start @ Gtk.Gtk.TextIter.T, end @ Gtk.Gtk.TextIter.T) : Std.Symbol.T

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

iter a T
start start of range
end end of range
Returns TRUE if iter is in the range


:InsideSentence(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is inside a sentence.


:InsideWord(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is inside a word


:IsCursorPosition(self @ T) : Std.Symbol.T

See ForwardCursorPosition or PangoLogAttr or pango_break() for details on what a cursor position is.

iter a T
Returns TRUE if the cursor can be placed at iter


:IsEnd(self @ T) : Std.Symbol.T

Returns TRUE if iter is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. IsEnd is the most efficient way to check whether an iterator is the end iterator.

iter an iterator
Returns whether iter is the end iterator


:IsStart(self @ T) : Std.Symbol.T

Returns TRUE if iter is the first iterator in the buffer, that is if iter has a character offset of 0.

iter an iterator
Returns whether iter is the first in the buffer


:Order(self @ T, second @ Gtk.Gtk.TextIter.T) : Std.Object.T

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

first a T
second another T


:SetLine(self @ T, line_number @ Std.Integer.SmallT) : Std.Object.T

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 T
line_number line number (counted from 0)


:SetLineIndex(self @ T, byte_on_line @ Std.Integer.SmallT) : Std.Object.T

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

iter a T
byte_on_line a byte index relative to the start of iter's current line


:SetLineOffset(self @ T, char_on_line @ Std.Integer.SmallT) : Std.Object.T

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 SetLineIndex if you have a byte index rather than a character offset.

iter a T
char_on_line a character offset relative to the start of iter's current line


:SetOffset(self @ T, char_offset @ Std.Integer.SmallT) : Std.Object.T

Sets iter to point to char_offset. char_offset counts from the start of the entire text buffer, starting with 0.

iter a T
char_offset a character number


:SetVisibleLineIndex(self @ T, byte_on_line @ Std.Integer.SmallT) : Std.Object.T

Like SetLineIndex, but the index is in visible bytes, i.e. text with a tag making it invisible is not counted in the index.

iter a T
byte_on_line a byte index


:SetVisibleLineOffset(self @ T, char_on_line @ Std.Integer.SmallT) : Std.Object.T

Like SetLineOffset, but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset.

iter a T
char_on_line a character offset


:StartsLine(self @ T) : Std.Symbol.T

Returns TRUE if iter begins a paragraph, i.e. if GetLineOffset would return 0. However this function is potentially more efficient than GetLineOffset because it doesn't have to compute the offset, it just has to see whether it's 0.

iter an iterator
Returns whether iter begins a line


:StartsSentence(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is at the start of a sentence.


:StartsWord(self @ T) : Std.Symbol.T

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 T
Returns TRUE if iter is at the start of a word


:TogglesTag(self @ T, tag @ Gtk.Gtk.TextTag.T) : Std.Symbol.T

This is equivalent to (BeginsTag || EndsTag), i.e. it tells you whether a range with tag applied to it begins or ends at iter.

iter an iterator
tag a Gtk.Gtk.TextTag.T, or NULL. [allow-none]
Returns whether tag is toggled on or off at iter


:"~="(_ @ T, _ @ T)