Iterates over the contents of a GtkTextBuffer.
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.
procedure Assign (Iter : in out Gtk_Text_Iter; Other : Gtk_Text_Iter)
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.
another GtkTextIter
procedure Backward_Char
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
whether movement was possible
procedure Backward_Chars
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of characters to move
whether Iter moved and is dereferenceable
procedure Backward_Cursor_Position
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
Like [methodGtk.TextIter.forward_cursor_position], but moves backward.
True if we moved
procedure Backward_Cursor_Positions
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Moves up to Count cursor positions. See [methodGtk.TextIter.forward_cursor_position] for details.
number of positions to move
True if we moved and the new position is dereferenceable
function Backward_Find_Char
(Iter : in out Gtk_Text_Iter;
Pred : Gtk_Text_Char_Predicate;
Limit : Gtk_Text_Iter := Null_Text_Iter) return Boolean
Same as [methodGtk.TextIter.forward_find_char], but goes backward from Iter.
function to be called on each character
search limit
whether a match was found
procedure Backward_Line
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.)
whether Iter moved
procedure Backward_Lines
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of lines to move backward
whether Iter moved and is dereferenceable
procedure Backward_Search
(Iter : in out Gtk_Text_Iter;
Str : UTF8_String;
Flags : Gtk_Text_Search_Flags;
Match_Start : out Gtk_Text_Iter;
Match_End : out Gtk_Text_Iter;
Limit : Gtk_Text_Iter := Null_Text_Iter;
Result : out Boolean)
Same as [methodGtk.TextIter.forward_search], but moves backward. Match_End will never be set to a GtkTextIter located after Iter, even if there is a possible Match_Start before or at Iter.
search string
bitmask of flags affecting the search
return location for start of match
return location for end of match
location of last possible Match_Start, or null for start of buffer
whether a match was found
procedure Backward_Sentence_Start
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
True if Iter moved and is not the end iterator
procedure Backward_Sentence_Starts
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.backward_sentence_start] up to Count times. If Count is negative, moves forward instead of backward.
number of sentences to move
True if Iter moved and is not the end iterator
procedure Backward_To_Tag_Toggle
(Iter : in out Gtk_Text_Iter;
Tag : Gtk.Text_Tag.Gtk_Text_Tag := null;
Result : out Boolean)
Moves backward to the next toggle (on or off) of the 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.
a GtkTextTag
whether we found a tag toggle before Iter
procedure Backward_Visible_Cursor_Position
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
Moves Iter backward to the previous visible cursor position. See [methodGtk.TextIter.backward_cursor_position] for details.
True if we moved and the new position is dereferenceable
procedure Backward_Visible_Cursor_Positions
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Moves up to Count visible cursor positions. See [methodGtk.TextIter.backward_cursor_position] for details.
number of positions to move
True if we moved and the new position is dereferenceable
procedure Backward_Visible_Line
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.)
whether Iter moved
procedure Backward_Visible_Lines
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of lines to move backward
whether Iter moved and is dereferenceable
procedure Backward_Visible_Word_Start
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
True if Iter moved and is not the end iterator
procedure Backward_Visible_Word_Starts
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.backward_visible_word_start] up to Count times.
number of times to move
True if Iter moved and is not the end iterator
procedure Backward_Word_Start
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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
True if Iter moved and is not the end iterator
procedure Backward_Word_Starts
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.backward_word_start] up to Count times.
number of times to move
True if Iter moved and is not the end iterator
function Can_Insert
(Iter : Gtk_Text_Iter;
Default_Editability : Boolean) return Boolean
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. [methodGtk.TextBuffer.insert_interactive] uses this function to decide whether insertions are allowed at a given position.
True if text is editable by default
whether text inserted at Iter would be editable
Case_Insensitive : constant Gtk_Text_Search_Flags := 4;
function Compare
(Iter : Gtk_Text_Iter;
Rhs : Gtk_Text_Iter) return Glib.Gint
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.
another GtkTextIter
-1 if Lhs is less than Rhs, 1 if Lhs is greater, 0 if they are equal
procedure Copy (Source : Gtk_Text_Iter; Dest : out Gtk_Text_Iter)
Create a copy of Source.
function Editable
(Iter : Gtk_Text_Iter;
Default_Setting : Boolean) return Boolean
Returns whether the character at Iter is within an editable region of text. Non-editable text is "locked" and can't be changed by the user via GtkTextView. 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.
True if text is editable by default
whether Iter is inside an editable range
function Ends_Line (Iter : Gtk_Text_Iter) return Boolean
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.
whether Iter is at the end of a line
function Ends_Sentence (Iter : Gtk_Text_Iter) return Boolean
Determines whether Iter ends a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language.
True if Iter is at the end of a sentence.
function Ends_Tag
(Iter : Gtk_Text_Iter;
Tag : access Gtk.Text_Tag.Gtk_Text_Tag_Record'Class) return Boolean
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 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.
a GtkTextTag
whether Iter is the end of a range tagged with Tag
function Ends_Word (Iter : Gtk_Text_Iter) return Boolean
Determines whether Iter ends a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language.
True if Iter is at the end of a word
function Equal (Iter : Gtk_Text_Iter; Rhs : Gtk_Text_Iter) return Boolean
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 [methodGtk.TextIter.compare].
another GtkTextIter
True if the iterators point to the same place in the buffer
procedure Forward_Char
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
whether Iter moved and is dereferenceable
procedure Forward_Chars
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of characters to move, may be negative
whether Iter moved and is dereferenceable
procedure Forward_Cursor_Position
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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 [structPango.LogAttr] struct and the [funcPango.break] function.
True if we moved and the new position is dereferenceable
procedure Forward_Cursor_Positions
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Moves up to Count cursor positions. See [methodGtk.TextIter.forward_cursor_position] for details.
number of positions to move
True if we moved and the new position is dereferenceable
function Forward_Find_Char
(Iter : in out Gtk_Text_Iter;
Pred : Gtk_Text_Char_Predicate;
Limit : Gtk_Text_Iter := Null_Text_Iter) return Boolean
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.
a function to be called on each character
search limit
whether a match was found
procedure Forward_Line
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
whether Iter can be dereferenced
procedure Forward_Lines
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of lines to move forward
whether Iter moved and is dereferenceable
procedure Forward_Search
(Iter : in out Gtk_Text_Iter;
Str : UTF8_String;
Flags : Gtk_Text_Search_Flags;
Match_Start : out Gtk_Text_Iter;
Match_End : out Gtk_Text_Iter;
Limit : Gtk_Text_Iter := Null_Text_Iter;
Result : out Boolean)
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 GtkTextIter located before Iter, even if there is a possible Match_End after or at Iter.
a search string
flags affecting how the search is done
return location for start of match
return location for end of match
location of last possible Match_End, or null for the end of the buffer
whether a match was found
procedure Forward_Sentence_End
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
True if Iter moved and is not the end iterator
procedure Forward_Sentence_Ends
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.forward_sentence_end] Count times. If Count is negative, moves backward instead of forward.
number of sentences to move
True if Iter moved and is not the end iterator
procedure Forward_To_End (Iter : in out Gtk_Text_Iter)
Moves Iter forward to the "end iterator", which points one past the last valid character in the buffer. [methodGtk.TextIter.get_char] called on the end iterator returns 0, which is convenient for writing loops.
procedure Forward_To_Line_End
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
True if we moved and the new location is not the end iterator
procedure Forward_To_Tag_Toggle
(Iter : in out Gtk_Text_Iter;
Tag : Gtk.Text_Tag.Gtk_Text_Tag := null;
Result : out Boolean)
Moves forward to the next toggle (on or off) of the 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.
a GtkTextTag
whether we found a tag toggle after Iter
procedure Forward_Visible_Cursor_Position
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
Moves Iter forward to the next visible cursor position. See [methodGtk.TextIter.forward_cursor_position] for details.
True if we moved and the new position is dereferenceable
procedure Forward_Visible_Cursor_Positions
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Moves up to Count visible cursor positions. See [methodGtk.TextIter.forward_cursor_position] for details.
number of positions to move
True if we moved and the new position is dereferenceable
procedure Forward_Visible_Line
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
whether Iter can be dereferenced
procedure Forward_Visible_Lines
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
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.
number of lines to move forward
whether Iter moved and is dereferenceable
procedure Forward_Visible_Word_End
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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
True if Iter moved and is not the end iterator
procedure Forward_Visible_Word_Ends
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.forward_visible_word_end] up to Count times.
number of times to move
True if Iter moved and is not the end iterator
procedure Forward_Word_End
(Iter : in out Gtk_Text_Iter;
Result : out Boolean)
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.
True if Iter moved and is not the end iterator
procedure Forward_Word_Ends
(Iter : in out Gtk_Text_Iter;
Count : Glib.Gint;
Result : out Boolean)
Calls [methodGtk.TextIter.forward_word_end] up to Count times.
number of times to move
True if Iter moved and is not the end iterator
function From_Object_Free
(B : not null access Gtk_Text_Iter) return Gtk_Text_Iter
Return the underlying object and free the pointer. This is meant to be used internally by GtkAda, and should not in general be called by user code.
function Get_Bytes_In_Line (Iter : Gtk_Text_Iter) return Glib.Gint
Returns the number of bytes in the line containing Iter, including the paragraph delimiters.
number of bytes in the line
function Get_Char (Iter : Gtk_Text_Iter) return Gunichar
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.
a Unicode character, or 0 if Iter is not dereferenceable
function Get_Char (Iter : Gtk_Text_Iter) return Character
Return the character immediately following Iter. If Iter is at the end of the buffer, then return ASCII.NUL. Note that this function assumes that the text is encoded in ASCII format. If this is not the case, use the Get_Char function that returns a Gunichar instead.
function Get_Chars_In_Line (Iter : Gtk_Text_Iter) return Glib.Gint
Returns the number of characters in the line containing Iter, including the paragraph delimiters.
number of characters in the line
function Get_Language
(Iter : Gtk_Text_Iter) return Pango.Language.Pango_Language
Returns the language in effect at Iter. If no tags affecting language apply to Iter, the return value is identical to that of [funcGtk.get_default_language].
language in effect at Iter. Has transfer-ownership='full'.
function Get_Line (Iter : Gtk_Text_Iter) return Glib.Gint
Returns the line number containing the iterator. Lines in a GtkTextBuffer are numbered beginning with 0 for the first line in the buffer.
a line number
function Get_Line_Index (Iter : Gtk_Text_Iter) return Glib.Gint
Returns the byte index of the iterator, counting from the start of a newline-terminated line. Remember that GtkTextBuffer encodes text in UTF-8, and that characters can require a variable number of bytes to represent.
distance from start of line, in bytes
function Get_Line_Offset (Iter : Gtk_Text_Iter) return Glib.Gint
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.
offset from start of line
function Get_Marks
(Iter : Gtk_Text_Iter) return Glib.Object.Object_List.GSlist
Returns a list of all GtkTextMark at this location. Because marks are not iterable (they don't take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order.
list of GtkTextMark
function Get_Offset (Iter : Gtk_Text_Iter) return Glib.Gint
Returns the character offset of an iterator. Each character in a GtkTextBuffer has an offset, starting with 0 for the first character in the buffer. Use [methodGtk.TextBuffer.get_iter_at_offset] to convert an offset back into an iterator.
a character offset
function Get_Paintable
(Iter : Gtk_Text_Iter) return Gdk.Paintable.Gdk_Paintable
If the element at Iter is a paintable, the paintable is returned. Otherwise, null is returned.
the paintable at Iter
function Get_Slice
(Iter : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return UTF8_String
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.
iterator at end of a range
slice of text from the buffer
function Get_Slice
(Start : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return Gtkada.Types.Chars_Ptr
Same as Get_Slice above, but returns the raw C string. The caller is responsible for freeing the string returned, using Gtkada.Types.g_free.
function Get_Tags
(Iter : Gtk_Text_Iter) return Gtk.Text_Tag.Text_Tag_List.GSlist
Returns a list of tags that apply to Iter, in ascending order of priority. 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.
list of GtkTextTag
function Get_Text
(Iter : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return UTF8_String
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 [methodGtk.TextIter.get_slice].
iterator at end of a range
array of characters from the buffer
procedure Get_Text_Iter
(Val : Glib.Values.GValue;
Iter : out Gtk_Text_Iter)
Extract the iterator from the given GValue. Note that the iterator returned is a copy of the iterator referenced by the give GValue. Modifying the iterator returned does not modify the iterator referenced by the GValue.
function Get_Toggled_Tags
(Iter : Gtk_Text_Iter;
Toggled_On : Boolean) return Gtk.Text_Tag.Text_Tag_List.GSlist
Returns a list of GtkTextTag that are toggled on or off at this point. If Toggled_On is True, the list contains tags that are toggled on. If a tag is toggled on at Iter, then some non-empty 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.
True to get toggled-on tags
tags toggled at this point
function Get_Type return Glib.GType
function Get_Visible_Line_Index (Iter : Gtk_Text_Iter) return Glib.Gint
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.
byte index of Iter with respect to the start of the line
function Get_Visible_Line_Offset (Iter : Gtk_Text_Iter) return Glib.Gint
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.
offset in visible characters from the start of the line
function Get_Visible_Slice
(Iter : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return UTF8_String
Returns visible text in the given range. 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.
iterator at end of range
slice of text from the buffer
function Get_Visible_Text
(Iter : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return UTF8_String
Returns visible text in the given range. 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.
iterator at end of range
string containing visible text in the range
type Gtk_Text_Char_Predicate is access function (Ch : Gunichar) return Boolean;
The predicate function used by gtk_text_iter_forward_find_char and Gtk.Text_Iter.Backward_Find_Char.
a Unicode code point
True if the predicate is satisfied, and the iteration should stop, and False otherwise
type Gtk_Text_Iter is private;
Iterates over the contents of a GtkTextBuffer.
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.
type Gtk_Text_Search_Flags is mod 2 ** Integer'Size;
Flags affecting how a search is done.
If neither GTK_TEXT_SEARCH_VISIBLE_ONLY nor GTK_TEXT_SEARCH_TEXT_ONLY are enabled, the match must be exact; the special 0xFFFC character will match embedded paintables or child widgets.
package Gtk_Text_Search_Flags_Properties is
new Generic_Internal_Flags_Property (Gtk_Text_Search_Flags);
function Has_Tag
(Iter : Gtk_Text_Iter;
Tag : not null access Gtk.Text_Tag.Gtk_Text_Tag_Record'Class)
return Boolean
Returns True if Iter points to a character that is part of a range tagged with Tag. See also [methodGtk.TextIter.starts_tag] and [methodGtk.TextIter.ends_tag].
a GtkTextTag
whether Iter is tagged with Tag
function In_Range
(Iter : Gtk_Text_Iter;
Start : Gtk_Text_Iter;
The_End : Gtk_Text_Iter) return Boolean
Checks whether Iter falls in the range [Start, End). Start and End must be in ascending order.
start of range
end of range
True if Iter is in the range
function Inside_Sentence (Iter : Gtk_Text_Iter) return Boolean
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.
True if Iter is inside a sentence.
function Inside_Word (Iter : Gtk_Text_Iter) return Boolean
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 [methodGtk.TextIter.starts_word] returns True, then this function returns True too, since Iter points to the first character of the word.
True if Iter is inside a word
function Is_Cursor_Position (Iter : Gtk_Text_Iter) return Boolean
Determine if Iter is at a cursor position. See [methodGtk.TextIter.forward_cursor_position] or [structPango.LogAttr] or [funcPango.break] for details on what a cursor position is.
True if the cursor can be placed at Iter
function Is_End (Iter : Gtk_Text_Iter) return Boolean
Returns True if Iter is the end iterator. This means it is one past the last dereferenceable iterator in the buffer. [methodGtk.TextIter.is_end] is the most efficient way to check whether an iterator is the end iterator.
whether Iter is the end iterator
function Is_Start (Iter : Gtk_Text_Iter) return Boolean
Returns True if Iter is the first iterator in the buffer.
whether Iter is the first in the buffer
function Iter_Or_Null (Iter : System.Address) return System.Address
Internal function for GtkAda
Null_Text_Iter : constant Gtk_Text_Iter;
procedure Order (Iter : 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 [methodGtk.TextIter.in_range], that expect a pre-sorted range.
another GtkTextIter
type Property_Gtk_Text_Search_Flags is new Gtk_Text_Search_Flags_Properties.Property;
procedure Set_Line (Iter : in out Gtk_Text_Iter; Line_Number : Glib.Gint)
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.
line number (counted from 0)
procedure Set_Line_Index
(Iter : in out Gtk_Text_Iter;
Byte_On_Line : Glib.Gint)
Same as [methodGtk.TextIter.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.
a byte index relative to the start of Iter's current line
procedure Set_Line_Offset
(Iter : in out Gtk_Text_Iter;
Char_On_Line : Glib.Gint)
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 [methodGtk.TextIter.set_line_index] if you have a byte index rather than a character offset.
a character offset relative to the start of Iter's current line
procedure Set_Offset
(Iter : in out Gtk_Text_Iter;
Char_Offset : Glib.Gint)
Sets Iter to point to Char_Offset. Char_Offset counts from the start of the entire text buffer, starting with 0.
a character number
procedure Set_Text_Iter
(Val : in out Glib.Values.GValue;
Iter : Gtk_Text_Iter)
Set the value of the given GValue to Iter. Note that Iter is stored by reference, which means no copy of Iter is made. Iter should remain allocated as long as Val is being used.
procedure Set_Visible_Line_Index
(Iter : in out Gtk_Text_Iter;
Byte_On_Line : Glib.Gint)
Like [methodGtk.TextIter.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.
a byte index
procedure Set_Visible_Line_Offset
(Iter : in out Gtk_Text_Iter;
Char_On_Line : Glib.Gint)
Like [methodGtk.TextIter.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.
a character offset
function Starts_Line (Iter : Gtk_Text_Iter) return Boolean
Returns True if Iter begins a paragraph. 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.
whether Iter begins a line
function Starts_Sentence (Iter : Gtk_Text_Iter) return Boolean
Determines whether Iter begins a sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language.
True if Iter is at the start of a sentence.
function Starts_Tag
(Iter : Gtk_Text_Iter;
Tag : access Gtk.Text_Tag.Gtk_Text_Tag_Record'Class) return Boolean
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 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.
a GtkTextTag
whether Iter is the start of a range tagged with Tag
function Starts_Word (Iter : Gtk_Text_Iter) return Boolean
Determines whether Iter begins a natural-language word. Word breaks are determined by Pango and should be correct for nearly any language.
True if Iter is at the start of a word
Text_Only : constant Gtk_Text_Search_Flags := 2;
function Toggles_Tag
(Iter : Gtk_Text_Iter;
Tag : access Gtk.Text_Tag.Gtk_Text_Tag_Record'Class) return Boolean
Gets whether a range with Tag applied to it begins or ends at Iter. This is equivalent to (gtk_text_iter_starts_tag || Gtk.Text_Iter.Ends_Tag)
a GtkTextTag
whether Tag is toggled on or off at Iter
Visible_Only : constant Gtk_Text_Search_Flags := 1;