TextIter

An iterator for the contents of a GtkTextBuffer.

You may wish to begin by reading the text widget conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.

class TextIter {

GtkTextIter* gtkTextIter;

bool ownedRef;

GtkTextIter* getTextIterStruct(bool transferOwnership);

void* getStruct();

this(GtkTextIter* gtkTextIter, bool ownedRef);

static GType getType();

void assign(TextIter other);

bool backwardChar();

bool backwardChars(int count);

bool backwardCursorPosition();

bool backwardCursorPositions(int count);

bool backwardFindChar(GtkTextCharPredicate pred, void* userData, TextIter limit);

bool backwardLine();

bool backwardLines(int count);

bool backwardSearch(string str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit);

bool backwardSentenceStart();

bool backwardSentenceStarts(int count);

bool backwardToTagToggle(TextTag tag);

bool backwardVisibleCursorPosition();

bool backwardVisibleCursorPositions(int count);

bool backwardVisibleLine();

bool backwardVisibleLines(int count);

bool backwardVisibleWordStart();

bool backwardVisibleWordStarts(int count);

bool backwardWordStart();

bool backwardWordStarts(int count);

bool canInsert(bool defaultEditability);

int compare(TextIter rhs);

TextIter copy();

bool editable(bool defaultSetting);

bool endsLine();

bool endsSentence();

bool endsTag(TextTag tag);

bool endsWord();

bool equal(TextIter rhs);

bool forwardChar();

bool forwardChars(int count);

bool forwardCursorPosition();

bool forwardCursorPositions(int count);

bool forwardFindChar(GtkTextCharPredicate pred, void* userData, TextIter limit);

bool forwardLine();

bool forwardLines(int count);

bool forwardSearch(string str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit);

bool forwardSentenceEnd();

bool forwardSentenceEnds(int count);

void forwardToEnd();

bool forwardToLineEnd();

bool forwardToTagToggle(TextTag tag);

bool forwardVisibleCursorPosition();

bool forwardVisibleCursorPositions(int count);

bool forwardVisibleLine();

bool forwardVisibleLines(int count);

bool forwardVisibleWordEnd();

bool forwardVisibleWordEnds(int count);

bool forwardWordEnd();

bool forwardWordEnds(int count);

TextBuffer getBuffer();

int getBytesInLine();

dchar getChar();

int getCharsInLine();

TextChildAnchor getChildAnchor();

PgLanguage getLanguage();

int getLine();

int getLineIndex();

int getLineOffset();

ListSG getMarks();

int getOffset();

PaintableIF getPaintable();

string getSlice(TextIter end);

ListSG getTags();

string getText(TextIter end);

ListSG getToggledTags(bool toggledOn);

int getVisibleLineIndex();

int getVisibleLineOffset();

string getVisibleSlice(TextIter end);

string getVisibleText(TextIter end);

bool hasTag(TextTag tag);

bool inRange(TextIter start, TextIter end);

bool insideSentence();

bool insideWord();

bool isCursorPosition();

bool isEnd();

bool isStart();

void order(TextIter second);

void setLine(int lineNumber);

void setLineIndex(int byteOnLine);

void setLineOffset(int charOnLine);

void setOffset(int charOffset);

void setVisibleLineIndex(int byteOnLine);

void setVisibleLineOffset(int charOnLine);

bool startsLine();

bool startsSentence();

bool startsTag(TextTag tag);

bool startsWord();

bool togglesTag(TextTag tag);

}

Constructors

this this(GtkTextIter* gtkTextIter, bool ownedRef): Sets our main struct and passes it to the parent class.
this this()

Destructor

~this ~this(): Undocumented in source.

Members

Functions

assign void assign(TextIter other): Assigns the value of @other to @iter.
backwardChar bool backwardChar(): Moves backward by one character offset.
backwardChars bool backwardChars(int count): Moves @count characters backward, if possible.
backwardCursorPosition bool backwardCursorPosition(): Like gtk_text_iter_forward_cursor_position(), but moves backward.
backwardCursorPositions bool backwardCursorPositions(int count): Moves up to @count cursor positions.
backwardFindChar bool backwardFindChar(GtkTextCharPredicate pred, void* userData, TextIter limit): Same as gtk_text_iter_forward_find_char(), but goes backward from @iter.
backwardLine bool backwardLine(): Moves @iter to the start of the previous line.
backwardLines bool backwardLines(int count): Moves @count lines backward, if possible.
backwardSearch bool backwardSearch(string str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit): Same as gtk_text_iter_forward_search(), but moves backward.
backwardSentenceStart bool backwardSentenceStart(): Moves backward to the previous sentence start.
backwardSentenceStarts bool backwardSentenceStarts(int count): Calls gtk_text_iter_backward_sentence_start() up to @count times.
backwardToTagToggle bool backwardToTagToggle(TextTag tag): Moves backward to the next toggle (on or off) of the @tag, or to the next toggle of any tag if @tag is %NULL.
backwardVisibleCursorPosition bool backwardVisibleCursorPosition(): Moves @iter forward to the previous visible cursor position.
backwardVisibleCursorPositions bool backwardVisibleCursorPositions(int count): Moves up to @count visible cursor positions.
backwardVisibleLine bool backwardVisibleLine(): Moves @iter to the start of the previous visible line.
backwardVisibleLines bool backwardVisibleLines(int count): Moves @count visible lines backward, if possible.
backwardVisibleWordStart bool backwardVisibleWordStart(): Moves backward to the previous visible word start.
backwardVisibleWordStarts bool backwardVisibleWordStarts(int count): Calls gtk_text_iter_backward_visible_word_start() up to @count times.
backwardWordStart bool backwardWordStart(): Moves backward to the previous word start.
backwardWordStarts bool backwardWordStarts(int count): Calls gtk_text_iter_backward_word_start() up to @count times.
canInsert bool canInsert(bool defaultEditability): Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at @iter would be editable.
compare 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.
copy TextIter copy(): Creates a dynamically-allocated copy of an iterator.
editable bool editable(bool defaultSetting): Returns whether the character at @iter is within an editable region of text.
endsLine bool endsLine(): Returns %TRUE if @iter points to the start of the paragraph delimiter characters for a line.
endsSentence bool endsSentence(): Determines whether @iter ends a sentence.
endsTag bool endsTag(TextTag tag): Returns %TRUE if @tag is toggled off at exactly this point.
endsWord bool endsWord(): Determines whether @iter ends a natural-language word.
equal bool equal(TextIter rhs): Tests whether two iterators are equal, using the fastest possible mechanism.
forwardChar bool forwardChar(): Moves @iter forward by one character offset.
forwardChars bool forwardChars(int count): Moves @count characters if possible.
forwardCursorPosition bool forwardCursorPosition(): Moves @iter forward by a single cursor position.
forwardCursorPositions bool forwardCursorPositions(int count): Moves up to @count cursor positions.
forwardFindChar bool forwardFindChar(GtkTextCharPredicate pred, void* userData, TextIter limit): Advances @iter, calling @pred on each character.
forwardLine bool forwardLine(): Moves @iter to the start of the next line.
forwardLines bool forwardLines(int count): Moves @count lines forward, if possible.
forwardSearch bool forwardSearch(string str, GtkTextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit): Searches forward for @str.
forwardSentenceEnd bool forwardSentenceEnd(): Moves forward to the next sentence end.
forwardSentenceEnds bool forwardSentenceEnds(int count): Calls gtk_text_iter_forward_sentence_end() @count times.
forwardToEnd void forwardToEnd(): Moves @iter forward to the “end iterator”, which points one past the last valid character in the buffer.
forwardToLineEnd bool forwardToLineEnd(): Moves the iterator to point to the paragraph delimiter characters.
forwardToTagToggle bool forwardToTagToggle(TextTag tag): Moves forward to the next toggle (on or off) of the @tag, or to the next toggle of any tag if @tag is %NULL.
forwardVisibleCursorPosition bool forwardVisibleCursorPosition(): Moves @iter forward to the next visible cursor position.
forwardVisibleCursorPositions bool forwardVisibleCursorPositions(int count): Moves up to @count visible cursor positions.
forwardVisibleLine bool forwardVisibleLine(): Moves @iter to the start of the next visible line.
forwardVisibleLines bool forwardVisibleLines(int count): Moves @count visible lines forward, if possible.
forwardVisibleWordEnd bool forwardVisibleWordEnd(): Moves forward to the next visible word end.
forwardVisibleWordEnds bool forwardVisibleWordEnds(int count): Calls gtk_text_iter_forward_visible_word_end() up to @count times.
forwardWordEnd bool forwardWordEnd(): Moves forward to the next word end.
forwardWordEnds bool forwardWordEnds(int count): Calls gtk_text_iter_forward_word_end() up to @count times.
free void free(): Free an iterator allocated on the heap.
getBuffer TextBuffer getBuffer(): Returns the GtkTextBuffer this iterator is associated with.
getBytesInLine int getBytesInLine(): Returns the number of bytes in the line containing @iter, including the paragraph delimiters.
getChar dchar getChar(): The Unicode character at this iterator is returned.
getCharsInLine int getCharsInLine(): Returns the number of characters in the line containing @iter, including the paragraph delimiters.
getChildAnchor TextChildAnchor getChildAnchor(): If the location at @iter contains a child anchor, the anchor is returned.
getLanguage PgLanguage getLanguage(): Returns the language in effect at @iter.
getLine int getLine(): Returns the line number containing the iterator.
getLineIndex int getLineIndex(): Returns the byte index of the iterator, counting from the start of a newline-terminated line.
getLineOffset int getLineOffset(): Returns the character offset of the iterator, counting from the start of a newline-terminated line.
getMarks ListSG getMarks(): Returns a list of all GtkTextMark at this location.
getOffset int getOffset(): Returns the character offset of an iterator.
getPaintable PaintableIF getPaintable(): If the element at @iter is a paintable, the paintable is returned.
getSlice string getSlice(TextIter end): Returns the text in the given range.
getStruct void* getStruct(): the main Gtk struct as a void*
getTags ListSG getTags(): Returns a list of tags that apply to @iter, in ascending order of priority.
getText string getText(TextIter end): Returns text in the given range.
getTextIterStruct GtkTextIter* getTextIterStruct(bool transferOwnership): Get the main Gtk struct
getToggledTags ListSG getToggledTags(bool toggledOn): Returns a list of GtkTextTag that are toggled on or off at this point.
getVisibleLineIndex 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.
getVisibleLineOffset 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.
getVisibleSlice string getVisibleSlice(TextIter end): Returns visible text in the given range.
getVisibleText string getVisibleText(TextIter end): Returns visible text in the given range.
hasTag bool hasTag(TextTag tag): Returns %TRUE if @iter points to a character that is part of a range tagged with @tag.
inRange bool inRange(TextIter start, TextIter end): Checks whether @iter falls in the range [@start, @end).
insideSentence bool 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).
insideWord bool insideWord(): Determines whether the character pointed by @iter is part of a natural-language word (as opposed to say inside some whitespace).
isCursorPosition bool isCursorPosition(): Determine if @iter is at a cursor position.
isEnd bool isEnd(): Returns %TRUE if @iter is the end iterator.
isStart bool isStart(): Returns %TRUE if @iter is the first iterator in the buffer.
order void order(TextIter second): Swaps the value of @first and @second if @second comes before @first in the buffer.
setLine void setLine(int lineNumber): Moves iterator @iter to the start of the line @line_number.
setLineIndex void 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.
setLineOffset void setLineOffset(int charOnLine): Moves @iter within a line, to a new character (not byte) offset.
setOffset void setOffset(int charOffset): Sets @iter to point to @char_offset.
setVisibleLineIndex void 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.
setVisibleLineOffset void 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.
startsLine bool startsLine(): Returns %TRUE if @iter begins a paragraph.
startsSentence bool startsSentence(): Determines whether @iter begins a sentence.
startsTag bool startsTag(TextTag tag): Returns %TRUE if @tag is toggled on at exactly this point.
startsWord bool startsWord(): Determines whether @iter begins a natural-language word.
togglesTag bool togglesTag(TextTag tag): Gets whether a range with @tag applied to it begins or ends at @iter.

Static functions

getType GType getType()

Variables

gtkTextIter GtkTextIter* gtkTextIter;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.

Meta

Source

See Implementation

gtk TextIter classes

TextIter