![]() |
![]() |
TODO: Maybe we should have separate iterators for words, lines, and sentences.
Public Types | |
typedef std::bidirectional_iterator_tag | iterator_category |
typedef gunichar | value_type |
typedef int | difference_type |
typedef value_type | reference |
typedef void | pointer |
Public Member Functions | |
TextIter () | |
TextIter (const GtkTextIter* gobject) | |
GtkTextIter* | gobj () |
Provides access to the underlying C instance. | |
const GtkTextIter* | gobj () const |
Provides access to the underlying C instance. | |
TextIter& | operator++ () |
Alias for forward_char(). | |
const TextIter | operator++ (int) |
TextIter& | operator-- () |
Alias for backward_char(). | |
const TextIter | operator-- (int) |
value_type | operator* () const |
Alias for get_char(). | |
operator bool () const | |
Alias for !is_end(). | |
Glib::RefPtr<TextBuffer> | get_buffer () const |
Returns the Gtk::TextBuffer this iterator is associated with. | |
int | get_offset () const |
Returns the character offset of an iterator. | |
int | get_line () const |
Returns the line number containing the iterator. | |
int | get_line_offset () const |
Returns the character offset of the iterator, counting from the start of a newline-terminated line. | |
int | get_line_index () const |
Returns the byte index of the iterator, counting from the start of a newline-terminated line. | |
int | get_visible_line_offset () const |
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. | |
int | get_visible_line_index () const |
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. | |
gunichar | get_char () const |
Returns the Unicode character at this iterator. | |
Glib::ustring | get_slice (const TextIter& end) const |
Returns the text in the given range. | |
Glib::ustring | get_text (const TextIter& end) const |
Returns text in the given range. | |
Glib::ustring | get_visible_slice (const TextIter& end) const |
Like gtk_text_iter_get_slice(), but invisible text is not included. | |
Glib::ustring | get_visible_text (const TextIter& end) const |
Like gtk_text_iter_get_text(), but invisible text is not included. | |
Glib::RefPtr<Gdk::Pixbuf> | get_pixbuf () const |
If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added). | |
Glib::SListHandle< Glib::RefPtr< TextMark > > | get_marks () const |
Returns a list of all Gtk::TextMark at this location. | |
Glib::RefPtr<TextChildAnchor> | get_child_anchor () const |
If the location at iter contains a child anchor, the anchor is returned (with no new reference count added). | |
Glib::SListHandle< Glib::RefPtr< TextTag > > | get_toggled_tags (bool toggled_on=true) const |
Returns a list of Gtk::TextTag that are toggled on or off at this point. | |
bool | begins_tag (const Glib::RefPtr<TextTag>& tag) const |
Returns true if tag is toggled on at exactly this point. | |
bool | ends_tag (const Glib::RefPtr<TextTag>& tag) const |
Returns true if tag is toggled off at exactly this point. | |
bool | toggles_tag (const Glib::RefPtr<TextTag>& tag) const |
This is equivalent to (gtk_text_iter_begins_tag() || gtk_text_iter_ends_tag()), i.e. it tells you whether a range with tag applied to it begins or ends at iter . | |
bool | has_tag (const Glib::RefPtr<TextTag>& tag) const |
Returns true if iter is within a range tagged with tag . | |
Glib::SListHandle< Glib::RefPtr< TextTag > > | get_tags () const |
Returns a list of tags that apply to iter , in ascending order of priority (highest-priority tags are last). | |
bool | editable (bool default_setting=true) const |
Returns whether the character at iter is within an editable region of text. | |
bool | can_insert (bool default_editability=true) const |
Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at iter would be editable. | |
bool | starts_word () const |
Determines whether iter begins a natural-language word. | |
bool | ends_word () const |
Determines whether iter ends a natural-language word. | |
bool | inside_word () const |
Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace). | |
bool | starts_sentence () const |
Determines whether iter begins a sentence. | |
bool | ends_sentence () const |
Determines whether iter ends a sentence. | |
bool | inside_sentence () const |
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). | |
bool | starts_line () const |
Returns true if iter begins a paragraph, i.e. if gtk_text_iter_get_line_offset() would return 0. | |
bool | ends_line () const |
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). | |
bool | is_cursor_position () const |
See gtk_text_iter_forward_cursor_position() or Pango::LogAttr or pango_break() for details on what a cursor position is. | |
int | get_chars_in_line () const |
Returns the number of characters in the line containing iter , including the paragraph delimiters. | |
int | get_bytes_in_line () const |
Returns the number of bytes in the line containing iter , including the paragraph delimiters. | |
bool | get_attributes (TextAttributes& values) const |
Pango::Language | get_language () const |
A convenience wrapper around gtk_text_iter_get_attributes(), which returns the language in effect at iter . | |
bool | is_end () const |
Returns true if iter is the end iterator, i.e. one past the last dereferenceable iterator in the buffer. | |
bool | is_start () const |
Returns true if iter is the first iterator in the buffer, that is if iter has a character offset of 0. | |
bool | forward_char () |
Moves iter forward by one character offset. | |
bool | backward_char () |
Moves backward by one character offset. | |
bool | forward_chars (int count) |
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). | |
bool | backward_chars (int count) |
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). | |
bool | forward_line () |
Moves iter to the start of the next line. | |
bool | backward_line () |
Moves iter to the start of the previous line. | |
bool | forward_lines (int count) |
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). | |
bool | backward_lines (int count) |
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). | |
bool | forward_word_end () |
Moves forward to the next word end. | |
bool | backward_word_start () |
Moves backward to the previous word start. | |
bool | forward_word_ends (int count) |
Calls gtk_text_iter_forward_word_end() up to count times. | |
bool | backward_word_starts (int count) |
Calls gtk_text_iter_backward_word_start() up to count times. | |
bool | forward_sentence_end () |
Moves forward to the next sentence end. | |
bool | backward_sentence_start () |
Moves backward to the previous sentence start; if iter is already at the start of a sentence, moves backward to the next one. | |
bool | forward_sentence_ends (int count) |
Calls gtk_text_iter_forward_sentence_end() count times (or until gtk_text_iter_forward_sentence_end() returns false ). | |
bool | backward_sentence_starts (int count) |
Calls gtk_text_iter_backward_sentence_start() up to count times, or until it returns false . | |
bool | forward_cursor_position () |
Moves iter forward by a single cursor position. | |
bool | backward_cursor_position () |
Like gtk_text_iter_forward_cursor_position(), but moves backward. | |
bool | forward_cursor_positions (int count) |
Moves up to count cursor positions. | |
bool | backward_cursor_positions (int count) |
Moves up to count cursor positions. | |
void | set_offset (int char_offset) |
Sets iter to point to char_offset . | |
void | set_line (int line_number) |
Moves iterator iter to the start of the line line_number . | |
void | set_line_offset (int char_on_line) |
Moves iter within a line, to a new character (not byte) offset. | |
void | set_line_index (int byte_on_line) |
Same as gtk_text_iter_set_line_offset(), but works with a byte index. | |
void | forward_to_end () |
Moves iter forward to the "end iterator," which points one past the last valid character in the buffer. | |
bool | forward_to_line_end () |
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. | |
void | set_visible_line_offset (int char_on_line) |
Like gtk_text_iter_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. | |
void | set_visible_line_index (int byte_on_line) |
Like gtk_text_iter_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. | |
bool | forward_to_tag_toggle (const Glib::RefPtr<TextTag>& tag) |
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 0 . | |
bool | backward_to_tag_toggle (const Glib::RefPtr<TextTag>& tag) |
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 0 . | |
template <class Predicate> bool | forward_find_char (const Predicate& predicate, const TextIter& limit) |
template <class Predicate> bool | forward_find_char (const Predicate& predicate) |
template <class Predicate> bool | backward_find_char (const Predicate& predicate, const TextIter& limit) |
template <class Predicate> bool | backward_find_char (const Predicate& predicate) |
bool | forward_search (const Glib::ustring& str, TextSearchFlags flags, TextIter& match_start, TextIter& match_end, const TextIter& limit) const |
Searches forward for str . | |
bool | backward_search (const Glib::ustring& str, TextSearchFlags flags, TextIter& match_start, TextIter& match_end, const TextIter& limit) const |
Same as gtk_text_iter_forward_search(), but moves backward. | |
int | compare (const TextIter& rhs) const |
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. | |
bool | in_range (const TextIter& start, const TextIter& end) const |
Checks whether iter falls in the range [ start , end ). | |
void | order (TextIter& second) |
Swaps the value of first and second if second comes before first in the buffer. | |
Protected Attributes | |
GtkTextIter | gobject_ |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator== (const TextIter& lhs, const TextIter& rhs) |
bool | operator!= (const TextIter& lhs, const TextIter& rhs) |
bool | operator< (const TextIter& lhs, const TextIter& rhs) |
bool | operator> (const TextIter& lhs, const TextIter& rhs) |
bool | operator<= (const TextIter& lhs, const TextIter& rhs) |
bool | operator>= (const TextIter& lhs, const TextIter& rhs) |
Gtk::TextIter& | wrap (GtkTextIter* object) |
const Gtk::TextIter& | wrap (const GtkTextIter* object) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Moves backward by one character offset.
Returns
|
|
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
|
|
Like gtk_text_iter_forward_cursor_position(), but moves backward.
|
|
Moves up to count cursor positions. See gtk_text_iter_forward_cursor_position() for details.
|
|
|
|
|
|
Moves iter to the start of the previous line.
Returns
|
|
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
|
|
Same as gtk_text_iter_forward_search(), but moves backward.
|
|
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).
|
|
Calls gtk_text_iter_backward_sentence_start() up to count times, or until it returns If count is negative, moves forward instead of backward.
|
|
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
If no matching tag toggles are found, returns
|
|
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).
|
|
Calls gtk_text_iter_backward_word_start() up to count times.
|
|
Returns
If tag is
|
|
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::TextBuffer::insert_interactive() uses this function to decide whether insertions are allowed at a given position.
|
|
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.
|
|
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::TextView. This function is simply a convenience wrapper around gtk_text_iter_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 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 gtk_text_iter_can_insert() to handle this case.
|
|
Returns
Note that an iterator pointing to the
|
|
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).
|
|
Returns
If tag is
|
|
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).
|
|
Moves iter forward by one character offset.
Note that images embedded in the buffer occupy 1 character slot, so gtk_text_iter_forward_char() 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 gtk_text_iter_forward_char() returns
|
|
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
|
|
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 Pango::LogAttr structure and pango_break() function.
|
|
Moves up to count cursor positions. See gtk_text_iter_forward_cursor_position() for details.
|
|
|
|
|
|
Moves iter to the start of the next line.
Returns
|
|
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
|
|
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.
|
|
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).
|
|
Calls gtk_text_iter_forward_sentence_end() count times (or until gtk_text_iter_forward_sentence_end() returns If count is negative, moves backward instead of forward.
|
|
Moves iter forward to the "end iterator," which points one past the last valid character in the buffer. gtk_text_iter_get_char() called on the end iterator returns 0, which is convenient for writing loops. |
|
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
|
|
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
If no matching tag toggles are found, returns
|
|
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).
|
|
Calls gtk_text_iter_forward_word_end() up to count times.
|
|
|
|
Returns the Gtk::TextBuffer this iterator is associated with.
|
|
Returns the number of bytes in the line containing iter , including the paragraph delimiters.
|
|
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 gtk_text_iter_get_char() returns 0.
|
|
Returns the number of characters in the line containing iter , including the paragraph delimiters.
|
|
If the location at iter contains a child anchor, the anchor is returned (with no new reference count added).
Otherwise,
|
|
A convenience wrapper around gtk_text_iter_get_attributes(), 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_get_default_language().
|
|
Returns the line number containing the iterator. Lines in a Gtk::TextBuffer are numbered beginning with 0 for the first line in the buffer.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added).
Otherwise,
|
|
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.
|
|
Returns a list of tags that apply to iter , in ascending order of priority (highest-priority tags are last).
|
|
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_text_iter_get_slice().
|
|
Returns a list of Gtk::TextTag that are toggled on or off at this point.
(If toggled_on is
|
|
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.
|
|
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.
|
|
Like gtk_text_iter_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.
|
|
Like gtk_text_iter_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.
|
|
Provides access to the underlying C instance.
|
|
Provides access to the underlying C instance.
|
|
Returns
|
|
Checks whether iter falls in the range [ start , end ). start and end must be in ascending order.
|
|
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).
|
|
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).
|
|
See gtk_text_iter_forward_cursor_position() or Pango::LogAttr or pango_break() for details on what a cursor position is.
|
|
Returns gtk_text_iter_is_end() is the most efficient way to check whether an iterator is the end iterator.
|
|
Returns
|
|
Alias for get_char().
|
|
Alias for !is_end().
|
|
|
|
Alias for forward_char().
|
|
|
|
Alias for backward_char().
|
|
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 gtk_text_iter_in_range(), that expect a pre-sorted range.
|
|
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.
|
|
Same as gtk_text_iter_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.
|
|
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 gtk_text_iter_set_line_index() if you have a byte index rather than a character offset.
|
|
Sets iter to point to char_offset . char_offset counts from the start of the entire text buffer, starting with 0.
|
|
Like gtk_text_iter_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.
|
|
Like gtk_text_iter_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.
|
|
Returns However this function is potentially more efficient than gtk_text_iter_get_line_offset() because it doesn't have to compute the offset, it just has to see whether it's 0.
|
|
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).
|
|
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).
|
|
This is equivalent to (gtk_text_iter_begins_tag() || gtk_text_iter_ends_tag()), i.e. it tells you whether a range with tag applied to it begins or ends at iter .
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|