gtk.TextIter.TextIter Class Reference

List of all members.

Detailed Description

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


Public Member Functions

GtkTextItergetTextIterStruct ()
 this (GtkTextIter *gtkTextIter)
 Sets our main struct and passes it to the parent class.
 this ()
TextBuffer getBuffer ()
 Returns the GtkTextBuffer this iterator is associated with.
TextIter copy ()
 Creates a dynamically-allocated copy of an iterator.
void free ()
 Free an iterator allocated on the heap.
int getOffset ()
 Returns the character offset of an iterator.
int getLine ()
 Returns the line number containing the iterator.
int getLineOffset ()
 Returns the character offset of the iterator, counting from the start of a newline-terminated line.
int getLineIndex ()
 Returns the byte index of the iterator, counting from the start of a newline-terminated line.
int getVisibleLineIndex ()
 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.
int getVisibleLineOffset ()
 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.
gunichar getChar ()
 Returns the Unicode character at this iterator.
char[] getSlice (TextIter end)
 Returns the text in the given range.
char[] getText (TextIter end)
 Returns text in the given range.
char[] getVisibleSlice (TextIter end)
 Like gtk_text_iter_get_slice(), but invisible text is not included.
char[] getVisibleText (TextIter end)
 Like gtk_text_iter_get_text(), but invisible text is not included.
Pixbuf getPixbuf ()
 If the element at iter is a pixbuf, the pixbuf is returned (with no new reference count added).
ListSG getMarks ()
 Returns a list of all GtkTextMark at this location.
ListSG getToggledTags (int toggledOn)
 Returns a list of GtkTextTag that are toggled on or off at this point.
TextChildAnchor getChildAnchor ()
 If the location at iter contains a child anchor, the anchor is returned (with no new reference count added).
int beginsTag (TextTag tag)
 Returns TRUE if tag is toggled on at exactly this point.
int endsTag (TextTag tag)
 Returns TRUE if tag is toggled off at exactly this point.
int togglesTag (TextTag tag)
 This is equivalent to (gtk_text_iter_begins_tag() || gtk_text_iter_ends_tag()), i.e.
int hasTag (TextTag tag)
 Returns TRUE if iter is within a range tagged with tag.
ListSG getTags ()
 Returns a list of tags that apply to iter, in ascending order of priority (highest-priority tags are last).
int editable (int defaultSetting)
 Returns whether the character at iter is within an editable region of text.
int canInsert (int defaultEditability)
 Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at iter would be editable.
int startsWord ()
 Determines whether iter begins a natural-language word.
int endsWord ()
 Determines whether iter ends a natural-language word.
int insideWord ()
 Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace).
int startsLine ()
 Returns TRUE if iter begins a paragraph, i.e.
int endsLine ()
 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).
int startsSentence ()
 Determines whether iter begins a sentence.
int endsSentence ()
 Determines whether iter ends a sentence.
int insideSentence ()
 Determines whether iter is inside a sentence (as opposed to in between two sentences, e.g.
int isCursorPosition ()
 See gtk_text_iter_forward_cursor_position() or PangoLogAttr or pango_break() for details on what a cursor position is.
int getCharsInLine ()
 Returns the number of characters in the line containing iter, including the paragraph delimiters.
int getBytesInLine ()
 Returns the number of bytes in the line containing iter, including the paragraph delimiters.
int getAttributes (TextAttributes values)
 Computes the effect of any tags applied to this spot in the text.
PangoLanguagegetLanguage ()
 A convenience wrapper around gtk_text_iter_get_attributes(), which returns the language in effect at iter.
int isEnd ()
 Returns TRUE if iter is the end iterator, i.e.
int isStart ()
 Returns TRUE if iter is the first iterator in the buffer, that is if iter has a character offset of 0.
int forwardChar ()
 Moves iter forward by one character offset.
int backwardChar ()
 Moves backward by one character offset.
int forwardChars (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).
int backwardChars (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).
int forwardLine ()
 Moves iter to the start of the next line.
int backwardLine ()
 Moves iter to the start of the previous line.
int forwardLines (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).
int backwardLines (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).
int forwardWordEnds (int count)
 Calls gtk_text_iter_forward_word_end() up to count times.
int backwardWordStarts (int count)
 Calls gtk_text_iter_backward_word_start() up to count times.
int forwardWordEnd ()
 Moves forward to the next word end.
int backwardWordStart ()
 Moves backward to the previous word start.
int forwardCursorPosition ()
 Moves iter forward by a single cursor position.
int backwardCursorPosition ()
 Like gtk_text_iter_forward_cursor_position(), but moves backward.
int forwardCursorPositions (int count)
 Moves up to count cursor positions.
int backwardCursorPositions (int count)
 Moves up to count cursor positions.
int backwardSentenceStart ()
 Moves backward to the previous sentence start; if iter is already at the start of a sentence, moves backward to the next one.
int backwardSentenceStarts (int count)
 Calls gtk_text_iter_backward_sentence_start() up to count times, or until it returns FALSE.
int forwardSentenceEnd ()
 Moves forward to the next sentence end.
int forwardSentenceEnds (int count)
 Calls gtk_text_iter_forward_sentence_end() count times (or until gtk_text_iter_forward_sentence_end() returns FALSE).
int forwardVisibleWordEnds (int count)
 Calls gtk_text_iter_forward_visible_word_end() up to count times.
int backwardVisibleWordStarts (int count)
 Calls gtk_text_iter_backward_visible_word_start() up to count times.
int forwardVisibleWordEnd ()
 Moves forward to the next visible word end.
int backwardVisibleWordStart ()
 Moves backward to the previous visible word start.
int forwardVisibleCursorPosition ()
 Moves iter forward to the next visible cursor position.
int backwardVisibleCursorPosition ()
 Moves iter forward to the previous visible cursor position.
int forwardVisibleCursorPositions (int count)
 Moves up to count visible cursor positions.
int backwardVisibleCursorPositions (int count)
 Moves up to count visible cursor positions.
int forwardVisibleLine ()
 Moves iter to the start of the next visible line.
int backwardVisibleLine ()
 Moves iter to the start of the previous visible line.
int forwardVisibleLines (int count)
 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).
int backwardVisibleLines (int count)
 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).
void setOffset (int charOffset)
 Sets iter to point to char_offset.
void setLine (int lineNumber)
 Moves iterator iter to the start of the line line_number.
void setLineOffset (int charOnLine)
 Moves iter within a line, to a new character (not byte) offset.
void setLineIndex (int byteOnLine)
 Same as gtk_text_iter_set_line_offset(), but works with a byte index.
void setVisibleLineIndex (int byteOnLine)
 Like gtk_text_iter_set_line_index(), but the index is in visible bytes, i.e.
void setVisibleLineOffset (int charOnLine)
 Like gtk_text_iter_set_line_offset(), but the offset is in visible characters, i.e.
void forwardToEnd ()
 Moves iter forward to the "end iterator," which points one past the last valid character in the buffer.
int forwardToLineEnd ()
 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.
int forwardToTagToggle (TextTag tag)
 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.
int backwardToTagToggle (TextTag tag)
 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.
int forwardFindChar (GtkTextCharPredicate pred, void *userData, TextIter limit)
 Advances iter, calling pred on each character.
int backwardFindChar (GtkTextCharPredicate pred, void *userData, TextIter limit)
 Same as gtk_text_iter_forward_find_char(), but goes backward from iter.
int forwardSearch (char[] str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit)
 Searches forward for str.
int backwardSearch (char[] str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit)
 Same as gtk_text_iter_forward_search(), but moves backward.
int equal (TextIter rhs)
 Tests whether two iterators are equal, using the fastest possible mechanism.
int compare (TextIter rhs)
 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.
int inRange (TextIter start, TextIter end)
 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 Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkTextItergtkTextIter
 the main Gtk struct


Constructor & Destructor Documentation

gtk.TextIter.TextIter.this ( GtkTextIter gtkTextIter  ) 

Sets our main struct and passes it to the parent class.

gtk.TextIter.TextIter.this (  ) 


Member Function Documentation

int gtk.TextIter.TextIter.backwardChar (  ) 

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_backward_char() returns FALSE for convenience when writing loops. iter: an iterator Returns: whether movement was possible

int gtk.TextIter.TextIter.backwardChars ( 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).

The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. iter: an iterator count: number of characters to move Returns: whether iter moved and is dereferenceable

int gtk.TextIter.TextIter.backwardCursorPosition (  ) 

Like gtk_text_iter_forward_cursor_position(), but moves backward.

iter: a GtkTextIter Returns: TRUE if we moved

int gtk.TextIter.TextIter.backwardCursorPositions ( int  count  ) 

Moves up to count cursor positions.

See gtk_text_iter_forward_cursor_position() for details. iter: a GtkTextIter count: number of positions to move Returns: TRUE if we moved and the new position is dereferenceable

int gtk.TextIter.TextIter.backwardFindChar ( GtkTextCharPredicate  pred,
void *  userData,
TextIter  limit 
)

Same as gtk_text_iter_forward_find_char(), but goes backward from iter.

iter: a GtkTextIter pred: function to be called on each character user_data: user data for pred limit: search limit, or NULL for none Returns: whether a match was found

int gtk.TextIter.TextIter.backwardLine (  ) 

Moves iter to the start of the previous line.

Returns TRUE if iter could be moved; i.e. if iter was at character offset 0, this function returns FALSE. Therefore if iter was already on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns TRUE. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) iter: an iterator Returns: whether iter moved

int gtk.TextIter.TextIter.backwardLines ( 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).

The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves forward by 0 - count lines. iter: a GtkTextIter count: number of lines to move backward Returns: whether iter moved and is dereferenceable

int gtk.TextIter.TextIter.backwardSearch ( char[]  str,
GtkTextSearchFlags  flags,
TextIter  matchStart,
TextIter  matchEnd,
TextIter  limit 
)

Same as gtk_text_iter_forward_search(), but moves backward.

iter: a GtkTextIter where the search begins str: search string flags: bitmask of flags affecting the search match_start: return location for start of match, or NULL match_end: return location for end of match, or NULL limit: location of last possible match_start, or NULL for start of buffer Returns: whether a match was found

int gtk.TextIter.TextIter.backwardSentenceStart (  ) 

Moves backward to the previous sentence start; if iter is already at the start of a sentence, moves backward to the next one.

Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator

int gtk.TextIter.TextIter.backwardSentenceStarts ( int  count  ) 

Calls gtk_text_iter_backward_sentence_start() up to count times, or until it returns FALSE.

If count is negative, moves forward instead of backward. iter: a GtkTextIter count: number of sentences to move Returns: TRUE if iter moved and is not the end iterator

int gtk.TextIter.TextIter.backwardToTagToggle ( TextTag  tag  ) 

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. iter: a GtkTextIter tag: a GtkTextTag, or NULL Returns: whether we found a tag toggle before iter

int gtk.TextIter.TextIter.backwardVisibleCursorPosition (  ) 

Moves iter forward to the previous visible cursor position.

See gtk_text_iter_backward_cursor_position() for details. iter: a GtkTextIter Returns: TRUE if we moved and the new position is dereferenceable Since 2.4

int gtk.TextIter.TextIter.backwardVisibleCursorPositions ( int  count  ) 

Moves up to count visible cursor positions.

See gtk_text_iter_backward_cursor_position() for details. iter: a GtkTextIter count: number of positions to move Returns: TRUE if we moved and the new position is dereferenceable Since 2.4

int gtk.TextIter.TextIter.backwardVisibleLine (  ) 

Moves iter to the start of the previous visible line.

Returns TRUE if iter could be moved; i.e. if iter was at character offset 0, this function returns FALSE. Therefore if iter was already on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns TRUE. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) iter: an iterator Returns: whether iter moved Since 2.8

int gtk.TextIter.TextIter.backwardVisibleLines ( int  count  ) 

Moves count visible lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer).

The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves forward by 0 - count lines. iter: a GtkTextIter count: number of lines to move backward Returns: whether iter moved and is dereferenceable Since 2.8

int gtk.TextIter.TextIter.backwardVisibleWordStart (  ) 

Moves backward to the previous visible word start.

(If iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator Since 2.4

int gtk.TextIter.TextIter.backwardVisibleWordStarts ( int  count  ) 

Calls gtk_text_iter_backward_visible_word_start() up to count times.

iter: a GtkTextIter count: number of times to move Returns: TRUE if iter moved and is not the end iterator Since 2.4

int gtk.TextIter.TextIter.backwardWordStart (  ) 

Moves backward to the previous word start.

(If iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator

int gtk.TextIter.TextIter.backwardWordStarts ( int  count  ) 

Calls gtk_text_iter_backward_word_start() up to count times.

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

int gtk.TextIter.TextIter.beginsTag ( TextTag  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 start of the tagged range; gtk_text_iter_has_tag() tells you whether an iterator is within a tagged range. iter: an iterator tag: a GtkTextTag, or NULL Returns: whether iter is the start of a range tagged with tag

int gtk.TextIter.TextIter.canInsert ( int  defaultEditability  ) 

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_text_buffer_insert_interactive() uses this function to decide whether insertions are allowed at a given position. iter: an iterator default_editability: TRUE if text is editable by default Returns: whether text inserted at iter would be editable

int gtk.TextIter.TextIter.compare ( TextIter  rhs  ) 

A qsort()-style function that returns negative if lhs is less than rhs, positive if lhs is greater than rhs, and 0 if they're equal.

Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer. lhs: a GtkTextIter rhs: another GtkTextIter Returns: -1 if lhs is less than rhs, 1 if lhs is greater, 0 if they are equal

TextIter gtk.TextIter.TextIter.copy (  ) 

Creates a dynamically-allocated copy of an iterator.

This function is not useful in applications, because iterators can be copied with a simple assignment (GtkTextIter i = j;). The function is used by language bindings. iter: an iterator Returns: a copy of the iter, free with gtk_text_iter_free()

int gtk.TextIter.TextIter.editable ( int  defaultSetting  ) 

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. 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. iter: an iterator default_setting: TRUE if text is editable by default Returns: whether iter is inside an editable range

int gtk.TextIter.TextIter.endsLine (  ) 

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
of a
pair will not be counted as the end of a line, the line ends before the . The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there. iter: an iterator Returns: whether iter is at the end of a line

int gtk.TextIter.TextIter.endsSentence (  ) 

Determines whether iter ends a sentence.

Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). iter: a GtkTextIter Returns: TRUE if iter is at the end of a sentence.

int gtk.TextIter.TextIter.endsTag ( TextTag  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 end of the tagged range; gtk_text_iter_has_tag() tells you whether an iterator is within a tagged range. iter: an iterator tag: a GtkTextTag, or NULL Returns: whether iter is the end of a range tagged with tag

int gtk.TextIter.TextIter.endsWord (  ) 

Determines whether iter ends a natural-language word.

Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter is at the end of a word

int gtk.TextIter.TextIter.equal ( TextIter  rhs  ) 

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_text_iter_compare(). lhs: a GtkTextIter rhs: another GtkTextIter Returns: TRUE if the iterators point to the same place in the buffer

int gtk.TextIter.TextIter.forwardChar (  ) 

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 FALSE for convenience when writing loops. iter: an iterator Returns: whether iter moved and is dereferenceable

int gtk.TextIter.TextIter.forwardChars ( 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).

The return value indicates whether the new position of iter is different from its original position, and dereferenceable (the last iterator in the buffer is not dereferenceable). If count is 0, the function does nothing and returns FALSE. iter: an iterator count: number of characters to move, may be negative Returns: whether iter moved and is dereferenceable

int gtk.TextIter.TextIter.forwardCursorPosition (  ) 

Moves iter forward by a single cursor position.

Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all characters. The most common example for European languages would be a carriage return/newline sequence. For some Unicode characters, the equivalent of say the letter "a" with an accent mark will be represented as two characters, first the letter then a "combining mark" that causes the accent to be rendered; so the cursor can't go between those two characters. See also the PangoLogAttr structure and pango_break() function. iter: a GtkTextIter Returns: TRUE if we moved and the new position is dereferenceable

int gtk.TextIter.TextIter.forwardCursorPositions ( int  count  ) 

Moves up to count cursor positions.

See gtk_text_iter_forward_cursor_position() for details. iter: a GtkTextIter count: number of positions to move Returns: TRUE if we moved and the new position is dereferenceable

int gtk.TextIter.TextIter.forwardFindChar ( GtkTextCharPredicate  pred,
void *  userData,
TextIter  limit 
)

Advances iter, calling pred on each character.

If pred returns TRUE, returns TRUE and stops scanning. If pred never returns TRUE, iter is set to limit if limit is non-NULL, otherwise to the end iterator. iter: a GtkTextIter pred: a function to be called on each character user_data: user data for pred limit: search limit, or NULL for none Returns: whether a match was found

int gtk.TextIter.TextIter.forwardLine (  ) 

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. iter: an iterator Returns: whether iter can be dereferenced

int gtk.TextIter.TextIter.forwardLines ( 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).

The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves backward by 0 - count lines. iter: a GtkTextIter count: number of lines to move forward Returns: whether iter moved and is dereferenceable

int gtk.TextIter.TextIter.forwardSearch ( char[]  str,
GtkTextSearchFlags  flags,
TextIter  matchStart,
TextIter  matchEnd,
TextIter  limit 
)

Searches forward for str.

Any match is returned by setting match_start to the first character of the match and match_end to the first character after the match. The search will not continue past limit. Note that a search is a linear or O(n) operation, so you may wish to use limit to avoid locking up your UI on large buffers. If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisible text interspersed in str. i.e. str will be a possibly-noncontiguous subsequence of the matched range. similarly, if you specify GTK_TEXT_SEARCH_TEXT_ONLY, the match may have pixbufs or child widgets mixed inside the matched range. If these flags are not given, the match must be exact; the special 0xFFFC character in str will match embedded pixbufs or child widgets. iter: start of search str: a search string flags: flags affecting how the search is done match_start: return location for start of match, or NULL match_end: return location for end of match, or NULL limit: bound for the search, or NULL for the end of the buffer Returns: whether a match was found

int gtk.TextIter.TextIter.forwardSentenceEnd (  ) 

Moves forward to the next sentence end.

(If iter is at the end of a sentence, moves to the next end of sentence.) Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator

int gtk.TextIter.TextIter.forwardSentenceEnds ( int  count  ) 

Calls gtk_text_iter_forward_sentence_end() count times (or until gtk_text_iter_forward_sentence_end() returns FALSE).

If count is negative, moves backward instead of forward. iter: a GtkTextIter count: number of sentences to move Returns: TRUE if iter moved and is not the end iterator

void gtk.TextIter.TextIter.forwardToEnd (  ) 

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. iter: a GtkTextIter

int gtk.TextIter.TextIter.forwardToLineEnd (  ) 

Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character.

If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns FALSE. iter: a GtkTextIter Returns: TRUE if we moved and the new location is not the end iterator

int gtk.TextIter.TextIter.forwardToTagToggle ( TextTag  tag  ) 

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. iter: a GtkTextIter tag: a GtkTextTag, or NULL Returns: whether we found a tag toggle after iter

int gtk.TextIter.TextIter.forwardVisibleCursorPosition (  ) 

Moves iter forward to the next visible cursor position.

See gtk_text_iter_forward_cursor_position() for details. iter: a GtkTextIter Returns: TRUE if we moved and the new position is dereferenceable Since 2.4

int gtk.TextIter.TextIter.forwardVisibleCursorPositions ( int  count  ) 

Moves up to count visible cursor positions.

See gtk_text_iter_forward_cursor_position() for details. iter: a GtkTextIter count: number of positions to move Returns: TRUE if we moved and the new position is dereferenceable Since 2.4

int gtk.TextIter.TextIter.forwardVisibleLine (  ) 

Moves iter to the start of the next visible line.

Returns TRUE if there was a next line to move to, and FALSE if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer. iter: an iterator Returns: whether iter can be dereferenced Since 2.8

int gtk.TextIter.TextIter.forwardVisibleLines ( int  count  ) 

Moves count visible lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer).

The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then FALSE is returned. If count is 0, the function does nothing and returns FALSE. If count is negative, moves backward by 0 - count lines. iter: a GtkTextIter count: number of lines to move forward Returns: whether iter moved and is dereferenceable Since 2.8

int gtk.TextIter.TextIter.forwardVisibleWordEnd (  ) 

Moves forward to the next visible word end.

(If iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator Since 2.4

int gtk.TextIter.TextIter.forwardVisibleWordEnds ( int  count  ) 

Calls gtk_text_iter_forward_visible_word_end() up to count times.

iter: a GtkTextIter count: number of times to move Returns: TRUE if iter moved and is not the end iterator Since 2.4

int gtk.TextIter.TextIter.forwardWordEnd (  ) 

Moves forward to the next word end.

(If iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter moved and is not the end iterator

int gtk.TextIter.TextIter.forwardWordEnds ( int  count  ) 

Calls gtk_text_iter_forward_word_end() up to count times.

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

void gtk.TextIter.TextIter.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. iter: a dynamically-allocated iterator

int gtk.TextIter.TextIter.getAttributes ( TextAttributes  values  ) 

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_text_view_get_default_attributes(). 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. iter: an iterator values: a GtkTextAttributes to be filled in Returns: TRUE if values was modified

TextBuffer gtk.TextIter.TextIter.getBuffer (  ) 

Returns the GtkTextBuffer this iterator is associated with.

iter: an iterator Returns: the buffer

int gtk.TextIter.TextIter.getBytesInLine (  ) 

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

iter: an iterator Returns: number of bytes in the line

gunichar gtk.TextIter.TextIter.getChar (  ) 

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. iter: an iterator Returns: a Unicode character, or 0 if iter is not dereferenceable

int gtk.TextIter.TextIter.getCharsInLine (  ) 

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

iter: an iterator Returns: number of characters in the line

TextChildAnchor gtk.TextIter.TextIter.getChildAnchor (  ) 

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

Otherwise, NULL is returned. iter: an iterator Returns: the anchor at iter

PangoLanguage* gtk.TextIter.TextIter.getLanguage (  ) 

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(). iter: an iterator Returns: language in effect at iter

int gtk.TextIter.TextIter.getLine (  ) 

Returns the line number containing the iterator.

Lines in a GtkTextBuffer are numbered beginning with 0 for the first line in the buffer. iter: an iterator Returns: a line number

int gtk.TextIter.TextIter.getLineIndex (  ) 

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. iter: an iterator Returns: distance from start of line, in bytes

int gtk.TextIter.TextIter.getLineOffset (  ) 

Returns the character offset of the iterator, counting from the start of a newline-terminated line.

The first character on the line has offset 0. iter: an iterator Returns: offset from start of line

ListSG gtk.TextIter.TextIter.getMarks (  ) 

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. iter: an iterator Returns: list of GtkTextMark

int gtk.TextIter.TextIter.getOffset (  ) 

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. iter: an iterator Returns: a character offset

Pixbuf gtk.TextIter.TextIter.getPixbuf (  ) 

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

Otherwise, NULL is returned. iter: an iterator Returns: the pixbuf at iter

char [] gtk.TextIter.TextIter.getSlice ( TextIter  end  ) 

Returns the text in the given range.

A "slice" is an array of characters encoded in UTF-8 format, including the Unicode "unknown" character 0xFFFC for iterable non-character elements in the buffer, such as images. Because images are encoded in the slice, byte and character offsets in the returned array will correspond to byte offsets in the text buffer. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer. start: iterator at start of a range end: iterator at end of a range Returns: slice of text from the buffer

void* gtk.TextIter.TextIter.getStruct (  )  [protected]

the main Gtk struct as a void*

ListSG gtk.TextIter.TextIter.getTags (  ) 

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. iter: a GtkTextIter Returns: list of GtkTextTag

char [] gtk.TextIter.TextIter.getText ( TextIter  end  ) 

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(). start: iterator at start of a range end: iterator at end of a range Returns: array of characters from the buffer

GtkTextIter* gtk.TextIter.TextIter.getTextIterStruct (  ) 

ListSG gtk.TextIter.TextIter.getToggledTags ( int  toggledOn  ) 

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. iter: an iterator toggled_on: TRUE to get toggled-on tags Returns: tags toggled at this point

int gtk.TextIter.TextIter.getVisibleLineIndex (  ) 

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

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

int gtk.TextIter.TextIter.getVisibleLineOffset (  ) 

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

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

char [] gtk.TextIter.TextIter.getVisibleSlice ( TextIter  end  ) 

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. start: iterator at start of range end: iterator at end of range Returns: slice of text from the buffer

char [] gtk.TextIter.TextIter.getVisibleText ( TextIter  end  ) 

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. start: iterator at start of range end: iterator at end of range Returns: string containing visible text in the range

int gtk.TextIter.TextIter.hasTag ( TextTag  tag  ) 

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

iter: an iterator tag: a GtkTextTag Returns: whether iter is tagged with tag

int gtk.TextIter.TextIter.inRange ( TextIter  start,
TextIter  end 
)

Checks whether iter falls in the range [start, end).

start and end must be in ascending order. iter: a GtkTextIter start: start of range end: end of range Returns: TRUE if iter is in the range

int gtk.TextIter.TextIter.insideSentence (  ) 

Determines whether iter is inside a sentence (as opposed to in between two sentences, e.g.

after a period and before the first letter of the next sentence). Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). iter: a GtkTextIter Returns: TRUE if iter is inside a sentence.

int gtk.TextIter.TextIter.insideWord (  ) 

Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace).

Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter is inside a word

int gtk.TextIter.TextIter.isCursorPosition (  ) 

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

iter: a GtkTextIter Returns: TRUE if the cursor can be placed at iter

int gtk.TextIter.TextIter.isEnd (  ) 

Returns TRUE if iter is the end iterator, i.e.

one past the last dereferenceable iterator in the buffer. gtk_text_iter_is_end() is the most efficient way to check whether an iterator is the end iterator. iter: an iterator Returns: whether iter is the end iterator

int gtk.TextIter.TextIter.isStart (  ) 

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

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

void gtk.TextIter.TextIter.order ( TextIter  second  ) 

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. first: a GtkTextIter second: another GtkTextIter

void gtk.TextIter.TextIter.setLine ( int  lineNumber  ) 

Moves iterator iter to the start of the line line_number.

If line_number is negative or larger than the number of lines in the buffer, moves iter to the start of the last line in the buffer. iter: a GtkTextIter line_number: line number (counted from 0)

void gtk.TextIter.TextIter.setLineIndex ( int  byteOnLine  ) 

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. iter: a GtkTextIter byte_on_line: a byte index relative to the start of iter's current line

void gtk.TextIter.TextIter.setLineOffset ( int  charOnLine  ) 

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. iter: a GtkTextIter char_on_line: a character offset relative to the start of iter's current line

void gtk.TextIter.TextIter.setOffset ( int  charOffset  ) 

Sets iter to point to char_offset.

char_offset counts from the start of the entire text buffer, starting with 0. iter: a GtkTextIter char_offset: a character number

void gtk.TextIter.TextIter.setVisibleLineIndex ( int  byteOnLine  ) 

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. iter: a GtkTextIter byte_on_line: a byte index

void gtk.TextIter.TextIter.setVisibleLineOffset ( int  charOnLine  ) 

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. iter: a GtkTextIter char_on_line: a character offset

int gtk.TextIter.TextIter.startsLine (  ) 

Returns TRUE if iter begins a paragraph, i.e.

if 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. iter: an iterator Returns: whether iter begins a line

int gtk.TextIter.TextIter.startsSentence (  ) 

Determines whether iter begins a sentence.

Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). iter: a GtkTextIter Returns: TRUE if iter is at the start of a sentence.

int gtk.TextIter.TextIter.startsWord (  ) 

Determines whether iter begins a natural-language word.

Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). iter: a GtkTextIter Returns: TRUE if iter is at the start of a word

int gtk.TextIter.TextIter.togglesTag ( TextTag  tag  ) 

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. iter: an iterator tag: a GtkTextTag, or NULL Returns: whether tag is toggled on or off at iter


Member Data Documentation

GtkTextIter* gtk.TextIter.TextIter.gtkTextIter [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo