Details
struct GtkTextIter
struct GtkTextIter {
gpointer dummy1;
gpointer dummy2;
gint dummy3;
gint dummy4;
gint dummy5;
gint dummy6;
gint dummy7;
gint dummy8;
gpointer dummy9;
gpointer dummy10;
gint dummy11;
gint dummy12;
}; |
gtk_text_iter_get_buffer ()
Return the GtkTextBuffer this iterator is associated with
gtk_text_iter_copy ()
Create a dynamically-allocated copy of an iterator. This function
is not useful in applications, because iterators can be copied with a
simple assignment (<literal>GtkTextIter i = j;</literal>). The
function is used by language bindings.
gtk_text_iter_free ()
Free an iterator allocated on the heap. This function
is intended for use in language bindings, and is not
especially useful for applications, because iterators can
simply be allocated on the stack.
gtk_text_iter_get_offset ()
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 gtk_text_buffer_get_iter_at_offset() to convert an
offset back into an iterator.
gtk_text_iter_get_line ()
Returns the line number containing the iterator. Lines in
a GtkTextBuffer are numbered beginning with 0 for the first
line in the buffer.
gtk_text_iter_get_line_offset ()
Returns the character offset of the iterator,
counting from the start of a newline-terminated line.
The first character on the line has offset 0.
gtk_text_iter_get_line_index ()
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.
gtk_text_iter_get_char ()
Returns the Unicode character at this iterator. (Equivalent to
operator* on a C++ iterator.) If the iterator points at a
non-character element, such as an image embedded in the buffer, the
Unicode "unknown" character 0xFFFD 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.
gtk_text_iter_get_slice ()
Returns the text in the given range. A "slice" is an array of
characters encoded in UTF-8 format, including the Unicode "unknown"
character 0xFFFD 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 0xFFFD can occur in normal
text as well, so it is not a reliable indicator that a pixbuf or
widget is in the buffer.
gtk_text_iter_get_text ()
Returns <emphasis>text</emphasis> 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().
gtk_text_iter_get_visible_slice ()
Like gtk_text_iter_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.
gtk_text_iter_get_visible_text ()
Like gtk_text_iter_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.
gtk_text_iter_get_pixbuf ()
If the location pointed to by iter contains a pixbuf, the pixbuf
is returned (with no new reference count added). Otherwise,
NULL is returned.
gtk_text_iter_get_marks ()
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.
gtk_text_iter_get_toggled_tags ()
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 <emphasis>not</emphasis> have the tag applied to it.
gtk_text_iter_get_child_anchor ()
GtkTextChildAnchor* gtk_text_iter_get_child_anchor
(const GtkTextIter *iter); |
If the location pointed to by iter contains a child anchor, the
anchor is returned (with no new reference count added). Otherwise,
NULL is returned.
gtk_text_iter_begins_tag ()
Returns TRUE if tag is toggled on at exactly this point. If tag
is NULL, returns TRUE if any tag is toggled on at this point. Note
that the gtk_text_iter_begins_tag() returns TRUE if iter is the
<emphasis>start</emphasis> of the tagged range;
gtk_text_iter_has_tag() tells you whether an iterator is
<emphasis>within</emphasis> a tagged range.
gtk_text_iter_ends_tag ()
Returns TRUE if tag is toggled off at exactly this point. If tag
is NULL, returns TRUE if any tag is toggled off at this point. Note
that the gtk_text_iter_ends_tag() returns TRUE if iter is the
<emphasis>end</emphasis> of the tagged range;
gtk_text_iter_has_tag() tells you whether an iterator is
<emphasis>within</emphasis> a tagged range.
gtk_text_iter_has_tag ()
Returns TRUE if iter is within a range tagged with tag.
gtk_text_iter_get_tags ()
Returns a list of tags that apply to iter, in ascending order of
priority (highest-priority tags are last). The GtkTextTag in the
list don't have a reference added, but you have to free the list
itself.
gtk_text_iter_editable ()
Returns whether iter is within an editable region of text.
Non-editable text is "locked" and can't be changed by the user via
GtkTextView. 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.
gtk_text_iter_starts_line ()
Returns TRUE if iter begins a newline-terminated line,
i.e. gtk_text_iter_get_line_offset() would return 0.
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.
gtk_text_iter_ends_line ()
Returns TRUE if iter points to a newline character.
gtk_text_iter_get_chars_in_line ()
Returns the number of characters in the line containing iter,
including the terminating newline.
gtk_text_iter_get_attributes ()
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.
gtk_text_iter_get_attributes() will modify values, applying the
effects of any tags present at iter. If any tags affected values,
the function returns TRUE.
gtk_text_iter_is_last ()
Returns TRUE if iter is the end iterator, i.e. one past the last
dereferenceable iterator in the buffer. gtk_text_iter_is_last() is
the most efficient way to check whether an iterator is the end
iterator.
gtk_text_iter_is_first ()
Returns TRUE if iter is the first iterator in the buffer, that is
if iter has a character offset of 0.
gtk_text_iter_next_char ()
Moves iter forward by one character offset. Note that images
embedded in the buffer occupy 1 character slot, so
gtk_text_iter_next_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_next_char() returns FALSE for
convenience when writing loops.
gtk_text_iter_prev_char ()
Moves backward by one character offset. Returns TRUE if movement
was possible; if iter was the first in the buffer (character
offset 0), gtk_text_iter_prev_char() returns FALSE for convenience when
writing loops.
gtk_text_iter_forward_chars ()
Moves count characters if possible (if count would move past the
start or end of the buffer, moves to the start or end of the
buffer). The return value indicates whether the new position of
iter is different from its original position, and dereferenceable
(the last iterator in the buffer is not dereferenceable). If count
is 0, the function does nothing and returns FALSE.
gtk_text_iter_backward_chars ()
Moves count characters backward, if possible (if count would move
past the start or end of the buffer, moves to the start or end of
the buffer). The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn't move, or
moved onto the end iterator, then FALSE is returned. If count is 0,
the function does nothing and returns FALSE.
gtk_text_iter_forward_line ()
Moves iter to the start of the next 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.
gtk_text_iter_backward_line ()
Moves iter to the start of the previous line. Returns TRUE if
iter could be moved; i.e. if iter was at character offset 0, this
function returns FALSE. Therefore if iter was already on line 0,
but not at the start of the line, iter is snapped to the start of
the line and the function returns TRUE. (Note that this implies that
in a loop calling this function, the line number may not change on
every iteration, if your first iteration is on line 0.)
gtk_text_iter_forward_lines ()
gtk_text_iter_backward_lines ()
gtk_text_iter_forward_word_ends ()
gtk_text_iter_backward_word_starts ()
gtk_text_iter_forward_word_end ()
gtk_text_iter_backward_word_start ()
gtk_text_iter_set_offset ()
gtk_text_iter_set_line ()
gtk_text_iter_set_line_offset ()
gtk_text_iter_set_line_index ()
gtk_text_iter_forward_to_end ()
gtk_text_iter_forward_to_newline ()
gtk_text_iter_forward_to_tag_toggle ()
Moves forward to the next toggle (on or off) of the
GtkTextTag 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.
gtk_text_iter_backward_to_tag_toggle ()
Moves backward to the next toggle (on or off) of the
GtkTextTag 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.
gtk_text_iter_forward_find_char ()
Advances iter, calling pred on each character. If
pred returns TRUE, returns TRUE and stops scanning.
If pred never returns TRUE, iter is set to limit if
limit is non-NULL, otherwise to the end iterator.
gtk_text_iter_backward_find_char ()
gtk_text_iter_forward_search ()
gtk_text_iter_backward_search ()
gtk_text_iter_in_range ()