Gtk.TextIter

Fields

Name Type Access Description
dummy1 object r  
dummy10 object r  
dummy11 int r  
dummy12 int r  
dummy13 int r  
dummy14 object r  
dummy2 object r  
dummy3 int r  
dummy4 int r  
dummy5 int r  
dummy6 int r  
dummy7 int r  
dummy8 int r  
dummy9 object r  

Methods

  assign (other)
  backward_char ()
  backward_chars (count)
  backward_cursor_position ()
  backward_cursor_positions (count)
  backward_find_char (pred, user_data, limit)
  backward_line ()
  backward_lines (count)
  backward_search (str, flags, limit)
  backward_sentence_start ()
  backward_sentence_starts (count)
  backward_to_tag_toggle (tag)
  backward_visible_cursor_position ()
  backward_visible_cursor_positions (count)
  backward_visible_line ()
  backward_visible_lines (count)
  backward_visible_word_start ()
  backward_visible_word_starts (count)
  backward_word_start ()
  backward_word_starts (count)
  begins_tag (tag)
  can_insert (default_editability)
  compare (rhs)
  copy ()
  editable (default_setting)
  ends_line ()
  ends_sentence ()
  ends_tag (tag)
  ends_word ()
  equal (rhs)
  forward_char ()
  forward_chars (count)
  forward_cursor_position ()
  forward_cursor_positions (count)
  forward_find_char (pred, user_data, limit)
  forward_line ()
  forward_lines (count)
  forward_search (str, flags, limit)
  forward_sentence_end ()
  forward_sentence_ends (count)
  forward_to_end ()
  forward_to_line_end ()
  forward_to_tag_toggle (tag)
  forward_visible_cursor_position ()
  forward_visible_cursor_positions (count)
  forward_visible_line ()
  forward_visible_lines (count)
  forward_visible_word_end ()
  forward_visible_word_ends (count)
  forward_word_end ()
  forward_word_ends (count)
  free ()
  get_attributes ()
  get_buffer ()
  get_bytes_in_line ()
  get_char ()
  get_chars_in_line ()
  get_child_anchor ()
  get_language ()
  get_line ()
  get_line_index ()
  get_line_offset ()
  get_marks ()
  get_offset ()
  get_pixbuf ()
  get_slice (end)
  get_tags ()
  get_text (end)
  get_toggled_tags (toggled_on)
  get_visible_line_index ()
  get_visible_line_offset ()
  get_visible_slice (end)
  get_visible_text (end)
  has_tag (tag)
  in_range (start, end)
  inside_sentence ()
  inside_word ()
  is_cursor_position ()
  is_end ()
  is_start ()
  order (second)
  set_line (line_number)
  set_line_index (byte_on_line)
  set_line_offset (char_on_line)
  set_offset (char_offset)
  set_visible_line_index (byte_on_line)
  set_visible_line_offset (char_on_line)
  starts_line ()
  starts_sentence ()
  starts_tag (tag)
  starts_word ()
  toggles_tag (tag)

Details

class Gtk.TextIter

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.

assign(other)[source]
Parameters:other (Gtk.TextIter) – another Gtk.TextIter

Assigns the value of other to self. This function is not useful in applications, because iterators can be assigned with GtkTextIter i = j;. The function is used by language bindings.

New in version 3.2.

backward_char()[source]
Returns:whether movement was possible
Return type:bool

Moves backward by one character offset. Returns True if movement was possible; if self was the first in the buffer (character offset 0), Gtk.TextIter.backward_char() returns False for convenience when writing loops.

backward_chars(count)[source]
Parameters:count (int) – number of characters to move
Returns:whether self moved and is dereferenceable
Return type:bool

Moves count characters backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then False is returned. If count is 0, the function does nothing and returns False.

backward_cursor_position()[source]
Returns:True if we moved
Return type:bool

Like Gtk.TextIter.forward_cursor_position(), but moves backward.

backward_cursor_positions(count)[source]
Parameters:count (int) – number of positions to move
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves up to count cursor positions. See Gtk.TextIter.forward_cursor_position() for details.

backward_find_char(pred, user_data, limit)[source]
Parameters:
Returns:

whether a match was found

Return type:

bool

Same as Gtk.TextIter.forward_find_char(), but goes backward from self.

backward_line()[source]
Returns:whether self moved
Return type:bool

Moves self to the start of the previous line. Returns True if self could be moved; i.e. if self was at character offset 0, this function returns False. Therefore if self was already on line 0, but not at the start of the line, self 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.)

backward_lines(count)[source]
Parameters:count (int) – number of lines to move backward
Returns:whether self moved and is dereferenceable
Return type:bool

Moves count lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then False is returned. If count is 0, the function does nothing and returns False. If count is negative, moves forward by 0 - count lines.

Parameters:
Returns:

None if not match was found otherwise a tuple containing:

match_start:start of match
match_end:end of match

Return type:

(match_start: Gtk.TextIter, match_end: Gtk.TextIter) or None

Same as Gtk.TextIter.forward_search(), but moves backward.

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

backward_sentence_start()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves backward to the previous sentence start; if self 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).

backward_sentence_starts(count)[source]
Parameters:count (int) – number of sentences to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.backward_sentence_start() up to count times, or until it returns False. If count is negative, moves forward instead of backward.

backward_to_tag_toggle(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether we found a tag toggle before self
Return type:bool

Moves backward to the next toggle (on or off) of the Gtk.TextTag tag, or to the next toggle of any tag if tag is None. If no matching tag toggles are found, returns False, otherwise True. Does not return toggles located at self, only toggles before self. Sets self to the location of the toggle, or the start of the buffer if no toggle is found.

backward_visible_cursor_position()[source]
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves self forward to the previous visible cursor position. See Gtk.TextIter.backward_cursor_position() for details.

New in version 2.4.

backward_visible_cursor_positions(count)[source]
Parameters:count (int) – number of positions to move
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves up to count visible cursor positions. See Gtk.TextIter.backward_cursor_position() for details.

New in version 2.4.

backward_visible_line()[source]
Returns:whether self moved
Return type:bool

Moves self to the start of the previous visible line. Returns True if self could be moved; i.e. if self was at character offset 0, this function returns False. Therefore if self was already on line 0, but not at the start of the line, self 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.)

New in version 2.8.

backward_visible_lines(count)[source]
Parameters:count (int) – number of lines to move backward
Returns:whether self moved and is dereferenceable
Return type:bool

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.

New in version 2.8.

backward_visible_word_start()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves backward to the previous visible word start. (If self 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).

New in version 2.4.

backward_visible_word_starts(count)[source]
Parameters:count (int) – number of times to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.backward_visible_word_start() up to count times.

New in version 2.4.

backward_word_start()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves backward to the previous word start. (If self 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).

backward_word_starts(count)[source]
Parameters:count (int) – number of times to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.backward_word_start() up to count times.

begins_tag(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether self is the start of a range tagged with tag
Return type:bool

Returns True if tag is toggled on at exactly this point. If tag is None, returns True if any tag is toggled on at this point.

Note that if Gtk.TextIter.begins_tag() returns True, it means that self is at the beginning of the tagged range, and that the character at self is inside the tagged range. In other words, unlike Gtk.TextIter.ends_tag(), if Gtk.TextIter.begins_tag() returns True, Gtk.TextIter.has_tag() will also return True for the same parameters.

Deprecated since version 3.20: Use Gtk.TextIter.starts_tag() instead.

can_insert(default_editability)[source]
Parameters:default_editability (bool) – True if text is editable by default
Returns:whether text inserted at self would be editable
Return type:bool

Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at self would be editable. If text inserted at self would be editable then the user should be allowed to insert text at self. Gtk.TextBuffer.insert_interactive() uses this function to decide whether insertions are allowed at a given position.

compare(rhs)[source]
Parameters:rhs (Gtk.TextIter) – another Gtk.TextIter
Returns:-1 if self is less than rhs, 1 if self is greater, 0 if they are equal
Return type:int

A qsort()-style function that returns negative if self is less than rhs, positive if self 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.

copy()[source]
Returns:a copy of the self, free with Gtk.TextIter.free()
Return type:Gtk.TextIter

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.

editable(default_setting)[source]
Parameters:default_setting (bool) – True if text is editable by default
Returns:whether self is inside an editable range
Return type:bool

Returns whether the character at self is within an editable region of text. Non-editable text is “locked” and can’t be changed by the user via Gtk.TextView. This function is simply a convenience wrapper around Gtk.TextIter.get_attributes(). If no tags applied to this text affect editability, default_setting will be returned.

You don’t want to use this function to decide whether text can be inserted at self, because for insertion you don’t want to know whether the str at self is inside an editable range, you want to know whether a new character inserted at self would be inside an editable range. Use Gtk.TextIter.can_insert() to handle this case.

ends_line()[source]
Returns:whether self is at the end of a line
Return type:bool

Returns True if self 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.

ends_sentence()[source]
Returns:True if self is at the end of a sentence.
Return type:bool

Determines whether self 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).

ends_tag(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether self is the end of a range tagged with tag
Return type:bool

Returns True if tag is toggled off at exactly this point. If tag is None, returns True if any tag is toggled off at this point.

Note that if Gtk.TextIter.ends_tag() returns True, it means that self is at the end of the tagged range, but that the character at self is outside the tagged range. In other words, unlike Gtk.TextIter.starts_tag(), if Gtk.TextIter.ends_tag() returns True, Gtk.TextIter.has_tag() will return False for the same parameters.

ends_word()[source]
Returns:True if self is at the end of a word
Return type:bool

Determines whether self 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).

equal(rhs)[source]
Parameters:rhs (Gtk.TextIter) – another Gtk.TextIter
Returns:True if the iterators point to the same place in the buffer
Return type:bool

Tests whether two iterators are equal, using the fastest possible mechanism. This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator and comparing the offsets yourself. Also, it’s a bit faster than Gtk.TextIter.compare().

forward_char()[source]
Returns:whether self moved and is dereferenceable
Return type:bool

Moves self forward by one character offset. Note that images embedded in the buffer occupy 1 character slot, so Gtk.TextIter.forward_char() may actually move onto an image instead of a character, if you have images in your buffer. If self is the end iterator or one character before it, self will now point at the end iterator, and Gtk.TextIter.forward_char() returns False for convenience when writing loops.

forward_chars(count)[source]
Parameters:count (int) – number of characters to move, may be negative
Returns:whether self moved and is dereferenceable
Return type:bool

Moves count characters if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the new position of self 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.

forward_cursor_position()[source]
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves self 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 Pango.LogAttr-struct and Pango.break_() function.

forward_cursor_positions(count)[source]
Parameters:count (int) – number of positions to move
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves up to count cursor positions. See Gtk.TextIter.forward_cursor_position() for details.

forward_find_char(pred, user_data, limit)[source]
Parameters:
Returns:

whether a match was found

Return type:

bool

Advances self, calling pred on each character. If pred returns True, returns True and stops scanning. If pred never returns True, self is set to limit if limit is non-None, otherwise to the end iterator.

forward_line()[source]
Returns:whether self can be dereferenced
Return type:bool

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

forward_lines(count)[source]
Parameters:count (int) – number of lines to move forward
Returns:whether self moved and is dereferenceable
Return type:bool

Moves count lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then False is returned. If count is 0, the function does nothing and returns False. If count is negative, moves backward by 0 - count lines.

Parameters:
Returns:

If no match was found returns None otherwise a tuple containing:

match_start:start of match
match_end:end of match

Return type:

(match_start: Gtk.TextIter, match_end: Gtk.TextIter) or None

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 Gtk.TextIter located before self, even if there is a possible match_end after or at self.

forward_sentence_end()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves forward to the next sentence end. (If self 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).

forward_sentence_ends(count)[source]
Parameters:count (int) – number of sentences to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.forward_sentence_end() count times (or until Gtk.TextIter.forward_sentence_end() returns False). If count is negative, moves backward instead of forward.

forward_to_end()[source]

Moves self forward to the “end iterator,” which points one past the last valid character in the buffer. Gtk.TextIter.get_char() called on the end iterator returns 0, which is convenient for writing loops.

forward_to_line_end()[source]
Returns:True if we moved and the new location is not the end iterator
Return type:bool

Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character. If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If self 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.

forward_to_tag_toggle(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether we found a tag toggle after self
Return type:bool

Moves forward to the next toggle (on or off) of the Gtk.TextTag tag, or to the next toggle of any tag if tag is None. If no matching tag toggles are found, returns False, otherwise True. Does not return toggles located at self, only toggles after self. Sets self to the location of the toggle, or to the end of the buffer if no toggle is found.

forward_visible_cursor_position()[source]
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves self forward to the next visible cursor position. See Gtk.TextIter.forward_cursor_position() for details.

New in version 2.4.

forward_visible_cursor_positions(count)[source]
Parameters:count (int) – number of positions to move
Returns:True if we moved and the new position is dereferenceable
Return type:bool

Moves up to count visible cursor positions. See Gtk.TextIter.forward_cursor_position() for details.

New in version 2.4.

forward_visible_line()[source]
Returns:whether self can be dereferenced
Return type:bool

Moves self to the start of the next visible line. Returns True if there was a next line to move to, and False if self was simply moved to the end of the buffer and is now not dereferenceable, or if self was already at the end of the buffer.

New in version 2.8.

forward_visible_lines(count)[source]
Parameters:count (int) – number of lines to move forward
Returns:whether self moved and is dereferenceable
Return type:bool

Moves count visible lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn’t move, or moved onto the end iterator, then False is returned. If count is 0, the function does nothing and returns False. If count is negative, moves backward by 0 - count lines.

New in version 2.8.

forward_visible_word_end()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves forward to the next visible word end. (If self 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).

New in version 2.4.

forward_visible_word_ends(count)[source]
Parameters:count (int) – number of times to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.forward_visible_word_end() up to count times.

New in version 2.4.

forward_word_end()[source]
Returns:True if self moved and is not the end iterator
Return type:bool

Moves forward to the next word end. (If self 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).

forward_word_ends(count)[source]
Parameters:count (int) – number of times to move
Returns:True if self moved and is not the end iterator
Return type:bool

Calls Gtk.TextIter.forward_word_end() up to count times.

free()[source]

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.

get_attributes()[source]
Returns:True if values was modified
values:a Gtk.TextAttributes to be filled in
Return type:(bool, values: Gtk.TextAttributes)

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.TextView.get_default_attributes().

Gtk.TextIter.get_attributes() will modify values, applying the effects of any tags present at self. If any tags affected values, the function returns True.

get_buffer()[source]
Returns:the buffer
Return type:Gtk.TextBuffer

Returns the Gtk.TextBuffer this iterator is associated with.

get_bytes_in_line()[source]
Returns:number of bytes in the line
Return type:int

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

get_char()[source]
Returns:a Unicode character, or 0 if self is not dereferenceable
Return type:str

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 Gtk.TextIter.get_char() returns 0.

get_chars_in_line()[source]
Returns:number of characters in the line
Return type:int

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

get_child_anchor()[source]
Returns:the anchor at self
Return type:Gtk.TextChildAnchor

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

get_language()[source]
Returns:language in effect at self
Return type:Pango.Language

A convenience wrapper around Gtk.TextIter.get_attributes(), which returns the language in effect at self. If no tags affecting language apply to self, the return value is identical to that of Gtk.get_default_language().

get_line()[source]
Returns:a line number
Return type:int

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

get_line_index()[source]
Returns:distance from start of line, in bytes
Return type:int

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

get_line_offset()[source]
Returns:offset from start of line
Return type:int

Returns the character offset of the iterator, counting from the start of a newline-terminated line. The first character on the line has offset 0.

get_marks()[source]
Returns:list of Gtk.TextMark
Return type:[Gtk.TextMark]

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

get_offset()[source]
Returns:a character offset
Return type:int

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

get_pixbuf()[source]
Returns:the pixbuf at self
Return type:GdkPixbuf.Pixbuf

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

get_slice(end)[source]
Parameters:end (Gtk.TextIter) – iterator at end of a range
Returns:slice of text from the buffer
Return type:str

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.

get_tags()[source]
Returns:list of Gtk.TextTag
Return type:[Gtk.TextTag]

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

get_text(end)[source]
Parameters:end (Gtk.TextIter) – iterator at end of a range
Returns:array of characters from the buffer
Return type:str

Returns text in the given range. If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and byte offsets in the buffer. If you want offsets to correspond, see Gtk.TextIter.get_slice().

get_toggled_tags(toggled_on)[source]
Parameters:toggled_on (bool) – True to get toggled-on tags
Returns:tags toggled at this point
Return type:[Gtk.TextTag]

Returns a list of Gtk.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 self, then some non-empty range of characters following self has that tag applied to it. If a tag is toggled off, then some non-empty range following self does not have the tag applied to it.

get_visible_line_index()[source]
Returns:byte index of self with respect to the start of the line
Return type:int

Returns the number of bytes from the start of the line to the given self, not counting bytes that are invisible due to tags with the “invisible” flag toggled on.

get_visible_line_offset()[source]
Returns:offset in visible characters from the start of the line
Return type:int

Returns the offset in characters from the start of the line to the given self, not counting characters that are invisible due to tags with the “invisible” flag toggled on.

get_visible_slice(end)[source]
Parameters:end (Gtk.TextIter) – iterator at end of range
Returns:slice of text from the buffer
Return type:str

Like Gtk.TextIter.get_slice(), but invisible text is not included. Invisible text is usually invisible because a Gtk.TextTag with the “invisible” attribute turned on has been applied to it.

get_visible_text(end)[source]
Parameters:end (Gtk.TextIter) – iterator at end of range
Returns:string containing visible text in the range
Return type:str

Like Gtk.TextIter.get_text(), but invisible text is not included. Invisible text is usually invisible because a Gtk.TextTag with the “invisible” attribute turned on has been applied to it.

has_tag(tag)[source]
Parameters:tag (Gtk.TextTag) – a Gtk.TextTag
Returns:whether self is tagged with tag
Return type:bool

Returns True if self points to a character that is part of a range tagged with tag. See also Gtk.TextIter.starts_tag() and Gtk.TextIter.ends_tag().

in_range(start, end)[source]
Parameters:
Returns:

True if self is in the range

Return type:

bool

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

inside_sentence()[source]
Returns:True if self is inside a sentence.
Return type:bool

Determines whether self 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).

inside_word()[source]
Returns:True if self is inside a word
Return type:bool

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

Note that if Gtk.TextIter.starts_word() returns True, then this function returns True too, since self points to the first character of the word.

is_cursor_position()[source]
Returns:True if the cursor can be placed at self
Return type:bool

See Gtk.TextIter.forward_cursor_position() or Pango.LogAttr or Pango.break_() for details on what a cursor position is.

is_end()[source]
Returns:whether self is the end iterator
Return type:bool

Returns True if self is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. Gtk.TextIter.is_end() is the most efficient way to check whether an iterator is the end iterator.

is_start()[source]
Returns:whether self is the first in the buffer
Return type:bool

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

order(second)[source]
Parameters:second (Gtk.TextIter) – another Gtk.TextIter

Swaps the value of self and second if second comes before self in the buffer. That is, ensures that self and second are in sequence. Most text buffer functions that take a range call this automatically on your behalf, so there’s no real reason to call it yourself in those cases. There are some exceptions, such as Gtk.TextIter.in_range(), that expect a pre-sorted range.

set_line(line_number)[source]
Parameters:line_number (int) – line number (counted from 0)

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

set_line_index(byte_on_line)[source]
Parameters:byte_on_line (int) – a byte index relative to the start of self’s current line

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

set_line_offset(char_on_line)[source]
Parameters:char_on_line (int) – a character offset relative to the start of self’s current line

Moves self 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, self moves to the start of the next line. See Gtk.TextIter.set_line_index() if you have a byte index rather than a character offset.

set_offset(char_offset)[source]
Parameters:char_offset (int) – a character number

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

set_visible_line_index(byte_on_line)[source]
Parameters:byte_on_line (int) – a byte index

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

set_visible_line_offset(char_on_line)[source]
Parameters:char_on_line (int) – a character offset

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

starts_line()[source]
Returns:whether self begins a line
Return type:bool

Returns True if self begins a paragraph, i.e. if Gtk.TextIter.get_line_offset() would return 0. However this function is potentially more efficient than Gtk.TextIter.get_line_offset() because it doesn’t have to compute the offset, it just has to see whether it’s 0.

starts_sentence()[source]
Returns:True if self is at the start of a sentence.
Return type:bool

Determines whether self 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).

starts_tag(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether self is the start of a range tagged with tag
Return type:bool

Returns True if tag is toggled on at exactly this point. If tag is None, returns True if any tag is toggled on at this point.

Note that if Gtk.TextIter.starts_tag() returns True, it means that self is at the beginning of the tagged range, and that the character at self is inside the tagged range. In other words, unlike Gtk.TextIter.ends_tag(), if Gtk.TextIter.starts_tag() returns True, Gtk.TextIter.has_tag() will also return True for the same parameters.

New in version 3.20.

starts_word()[source]
Returns:True if self is at the start of a word
Return type:bool

Determines whether self 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).

toggles_tag(tag)[source]
Parameters:tag (Gtk.TextTag or None) – a Gtk.TextTag, or None
Returns:whether tag is toggled on or off at self
Return type:bool

This is equivalent to (Gtk.TextIter.starts_tag() || Gtk.TextIter.ends_tag()), i.e. it tells you whether a range with tag applied to it begins or ends at self.