TextIter Class Reference

List of all members.

---

Detailed Description

Text iter.

Public Member Functions
	this (GtkTextIter *gtkTextIter)
	Creates a text iter from a GtkTextIter.
GtkTextIter *	getIter ()
	gets the gtk structure
	this ()
	Creates a new TextIter.
	this (TextIter iter)
	Creates a new TextIter from an existing one.
TextBuffer	getBuffer ()
	Get Buffer.
void	free ()
	Free.
gint	getOffset ()
	Get Offset.
gint	getLine ()
	Get Line.
gint	getLineOffset ()
	Get Line Offset.
gint	getLineIndex ()
	Get Line Index.
gint	getVisibleLineOffset ()
	Get Visible Line Offset.
gint	getVisibleLineIndex ()
	Get Visible Line Index.
gunichar	getChar ()
	Get char.
String	getSlice (TextIter start, TextIter end)
	Get Slice.
String	getText (TextIter start, TextIter end)
	Get Text.
String	getVisibleSlice (TextIter start, TextIter end)
	Get Visible Slice.
String	getVisibleText (TextIter start, TextIter end)
	Get Visible Text.
Pixbuf	getPixbuf ()
	get pixbuf
SListG	getMarks ()
	getMarks
TextChildAnchor	getChildAnchor ()
	getChildAnchor
SListG	geToggledTags (gboolean toggled_on)
	Return list of tags toggled at this point(toggled_on determines whether the list is of on-toggles or off-toggles).
bit	beginsTag (TextTag tag)
	Begins Tag.
bit	endsTag (TextTag tag)
	Ends Tag.
bit	togglesTab (TextTag tag)
	Toggles Tab.
bit	hasTag (TextTag tag)
	Has Tag.
SListG	getTags ()
	getTags
bit	editable (bit defaultSetting)
	Editable.
bit	canInsert (bit defaultEditability)
	Can Insert.
bit	startsWord ()
	Starts Word.
bit	endsWord ()
	Ends Word.
bit	insideWord ()
	Inside Word.
bit	startsSentence ()
	Starts Sentence.
bit	endsSentence ()
	Ends Sentence.
bit	insideSentence ()
	Inside Sentence.
bit	startsLine ()
	Starts Line.
bit	endsLine ()
	Ends Line.
bit	isCursorPosition ()
	Is Cursor Position.
gint	getCharsInLine ()
	Get Chars In Line.
gint	getBytesInLine ()
	Get Bytes In Line.
bit	getAttributes (TextAttributes att)
	Get Attributes.
PangoLanguage *	getLanguage ()
	getLanguage
bit	isEnd ()
	Is End.
bit	isStart ()
	Is Start.
bit	forwardChar ()
	Forward Char.
bit	backwardChar ()
	Backward Char.
bit	forwardChars (gint count)
	Forward Chars.
bit	backwardChars (gint count)
	Backward Chars.
bit	forwardLine ()
	Forward Line.
bit	backwardLine ()
	Backward Line.
bit	forwardLines (gint count)
	Forward Lines.
bit	backwardLines (gint count)
	Backward Lines.
bit	forwardLinesEnd ()
	Forward Lines End.
bit	backwardLinesStart ()
	Backward Lines Start.
bit	forwardWordEnds (gint count)
	Forward Word Ends.
bit	backwardWordStart (gint count)
	Backward Word Start.
bit	forwardSentenceEnd ()
	Forward Sentence End.
bit	backwardSentenceStart ()
	Backward Sentence Start.
bit	forwardSentenceEnds (gint count)
	Forward Sentence Ends.
bit	backwardSentenceStarts (gint count)
	Backward Sentence Starts.
bit	forwardCursorPosition ()
	Forward Cursor Position.
bit	backwardCursorPosition ()
	Backward Cursor Position.
bit	forwardCursorPositions (gint count)
	Forward Cursor Positions.
bit	backwardCursorPositions (gint count)
	B ackward Cursor Positions.
void	setOffset (gint charOffset)
	Set Offset.
void	setLine (gint lineNumber)
	Set line.
void	setLineOffset (gint charOnLine)
	Set Line Offset.
void	setLineIndex (gint byteOnLine)
	Set Line Index.
void	forwardToEnd ()
	Forward To End.
bit	forwardToLineEnd ()
	Forward To Line End.
void	setVisibleLineOffset (gint charOnLine)
	Set Visible Line Offset.
void	setVisibleLineIndex (gint byteOnLine)
	Set Visible Line Index.
bit	forwardToTagToggle (TextTag tag)
	Forward To Tag Toggle.
bit	backwardToTagToggle (TextTag tag)
	Backward To Tag Toggle.
bit	forwardFindChar (GtkTextCharPredicate pred, gpointer userData, TextIter limit)
	forwardFindChar
bit	backwardFindChar (GtkTextCharPredicate pred, gpointer userData, TextIter limit)
	Backward Find Char.
bit	forwardSearch (String str, TextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit)
	Forward Search.
bit	backwardSearch (String str, TextSearchFlags flags, TextIter matchStart, TextIter matchEnd, TextIter limit)
	Backward Search.
bit	equal (TextIter lhs, TextIter rhs)
	Tests if lhs and rhs are equal.
gint	compare (TextIter lhs, TextIter rhs)
	Compare.
bit	inRange (TextIter start, TextIter end)
	Check if this iteractor is inside a range.
void	order (TextIter first, TextIter second)
	Put these two in ascending order.
Static Public Member Functions
GType	getType ()
	Gets this class type.

---

Member Function Documentation

bit TextIter.backwardChar (   )

Backward Char. Returns:

bit TextIter.backwardChars (  gint  count  )

Backward Chars. Parameters: count  Returns:

bit TextIter.backwardCursorPosition (   )

Backward Cursor Position. Returns:

bit TextIter.backwardCursorPositions (  gint  count  )

B ackward Cursor Positions. Parameters: count  Returns:

bit TextIter.backwardFindChar (  GtkTextCharPredicate  pred, gpointer  userData, TextIter  limit )

Backward Find Char. Todo: todo Parameters: pred  GtkTextCharPredicate userData  limit  Returns:

bit TextIter.backwardLine (   )

Backward Line. Returns:

bit TextIter.backwardLines (  gint  count  )

Backward Lines. Parameters: count  Returns:

bit TextIter.backwardLinesStart (   )

Backward Lines Start. Returns:

bit TextIter.backwardSearch (  String  str, TextSearchFlags  flags, TextIter  matchStart, TextIter  matchEnd, TextIter  limit )

Backward Search. Parameters: str  flags  matchStart  matchEnd  limit  Returns:

bit TextIter.backwardSentenceStart (   )

Backward Sentence Start. Returns:

bit TextIter.backwardSentenceStarts (  gint  count  )

Backward Sentence Starts. Parameters: count  Returns:

bit TextIter.backwardToTagToggle (  TextTag  tag  )

Backward To Tag Toggle. Parameters: tag  Returns:

bit TextIter.backwardWordStart (  gint  count  )

Backward Word Start. Parameters: count  Returns:

bit TextIter.beginsTag (  TextTag  tag  )

Begins Tag. Parameters: tag  Returns:

bit TextIter.canInsert (  bit  defaultEditability  )

Can Insert. Parameters: defaultEditability  Returns:

gint TextIter.compare (  TextIter  lhs, TextIter  rhs )

Compare. Parameters: lhs  rhs  Returns: 0,-1,2 if

bit TextIter.editable (  bit  defaultSetting  )

Editable. Parameters: defaultSetting  Returns:

bit TextIter.endsLine (   )

Ends Line. Returns:

bit TextIter.endsSentence (   )

Ends Sentence. Returns:

bit TextIter.endsTag (  TextTag  tag  )

Ends Tag. Parameters: tag  Returns:

bit TextIter.endsWord (   )

Ends Word. Returns:

bit TextIter.equal (  TextIter  lhs, TextIter  rhs )

Tests if lhs and rhs are equal. Parameters: lhs  rhs  @ return true if equals

bit TextIter.forwardChar (   )

Forward Char. Returns:

bit TextIter.forwardChars (  gint  count  )

Forward Chars. Parameters: count  Returns:

bit TextIter.forwardCursorPosition (   )

Forward Cursor Position. Returns:

bit TextIter.forwardCursorPositions (  gint  count  )

Forward Cursor Positions. Parameters: count  Returns:

bit TextIter.forwardFindChar (  GtkTextCharPredicate  pred, gpointer  userData, TextIter  limit )

forwardFindChar Todo: todo Parameters: pred  GtkTextCharPredicate userData  limit  Returns:

bit TextIter.forwardLine (   )

Forward Line. Returns:

bit TextIter.forwardLines (  gint  count  )

Forward Lines. Parameters: count  Returns:

bit TextIter.forwardLinesEnd (   )

Forward Lines End. Returns:

bit TextIter.forwardSearch (  String  str, TextSearchFlags  flags, TextIter  matchStart, TextIter  matchEnd, TextIter  limit )

Forward Search. Parameters: str  flags  matchStart  matchEnd  limit  Returns:

bit TextIter.forwardSentenceEnd (   )

Forward Sentence End. Returns:

bit TextIter.forwardSentenceEnds (  gint  count  )

Forward Sentence Ends. Parameters: count  Returns:

void TextIter.forwardToEnd (   )

Forward To End.

bit TextIter.forwardToLineEnd (   )

Forward To Line End. Returns:

bit TextIter.forwardToTagToggle (  TextTag  tag  )

Forward To Tag Toggle. Parameters: tag  Returns:

bit TextIter.forwardWordEnds (  gint  count  )

Forward Word Ends. Parameters: count  Returns:

void TextIter.free (   )

Free.

bit TextIter.getAttributes (  TextAttributes  att  )

Get Attributes. Parameters: att  Returns:

TextBuffer TextIter.getBuffer (   )

Get Buffer. Returns:

gint TextIter.getBytesInLine (   )

Get Bytes In Line. Returns:

gunichar TextIter.getChar (   )

Get char. Returns:

gint TextIter.getCharsInLine (   )

Get Chars In Line. Returns:

TextChildAnchor TextIter.getChildAnchor (   )

getChildAnchor Returns: a new TextChildAnchor

GtkTextIter* TextIter.getIter (   )

gets the gtk structure

PangoLanguage* TextIter.getLanguage (   )

getLanguage Returns: PangoLanguage *

gint TextIter.getLine (   )

Get Line. Returns:

gint TextIter.getLineIndex (   )

Get Line Index. Returns:

gint TextIter.getLineOffset (   )

Get Line Offset. Returns:

SListG TextIter.getMarks (   )

getMarks Returns: SListG with marks

gint TextIter.getOffset (   )

Get Offset. Returns:

SListG TextIter.geToggledTags (  gboolean  toggled_on  )

Return list of tags toggled at this point(toggled_on determines whether the list is of on-toggles or off-toggles).

Pixbuf TextIter.getPixbuf (   )

get pixbuf Returns: Pixbuf

String TextIter.getSlice (  TextIter  start, TextIter  end )

Get Slice. Parameters: start  end  Returns:

SListG TextIter.getTags (   )

getTags Returns:

String TextIter.getText (  TextIter  start, TextIter  end )

Get Text. Parameters: start  end  Returns:

GType TextIter.getType (   )  [static]

Gets this class type. Returns: this class type

gint TextIter.getVisibleLineIndex (   )

Get Visible Line Index. Returns:

gint TextIter.getVisibleLineOffset (   )

Get Visible Line Offset. Returns:

String TextIter.getVisibleSlice (  TextIter  start, TextIter  end )

Get Visible Slice. Parameters: start  end  Returns:

String TextIter.getVisibleText (  TextIter  start, TextIter  end )

Get Visible Text. Parameters: start  end  Returns:

bit TextIter.hasTag (  TextTag  tag  )

Has Tag. Parameters: tag  Returns:

bit TextIter.inRange (  TextIter  start, TextIter  end )

Check if this iteractor is inside a range. Parameters: start  end

bit TextIter.insideSentence (   )

Inside Sentence.

bit TextIter.insideWord (   )

Inside Word. Returns:

bit TextIter.isCursorPosition (   )

Is Cursor Position. Returns:

bit TextIter.isEnd (   )

Is End. Returns:

bit TextIter.isStart (   )

Is Start. Returns:

void TextIter.order (  TextIter  first, TextIter  second )

Put these two in ascending order. Parameters: first  second

void TextIter.setLine (  gint  lineNumber  )

Set line. Parameters: lineNumber

void TextIter.setLineIndex (  gint  byteOnLine  )

Set Line Index. Parameters: byteOnLine

void TextIter.setLineOffset (  gint  charOnLine  )

Set Line Offset. Parameters: charOnLine

void TextIter.setOffset (  gint  charOffset  )

Set Offset. Parameters: charOffset

void TextIter.setVisibleLineIndex (  gint  byteOnLine  )

Set Visible Line Index. Parameters: byteOnLine

void TextIter.setVisibleLineOffset (  gint  charOnLine  )

Set Visible Line Offset. Parameters: charOnLine

bit TextIter.startsLine (   )

Starts Line. Returns:

bit TextIter.startsSentence (   )

Starts Sentence. Returns:

bit TextIter.startsWord (   )

Starts Word. Returns:

TextIter.this (  TextIter  iter  )

Creates a new TextIter from an existing one. Parameters: iter  the iter to copy

TextIter.this (   )

Creates a new TextIter.

TextIter.this (  GtkTextIter *  gtkTextIter  )

Creates a text iter from a GtkTextIter. Parameters: gtkTextIter  the gtk text iter

bit TextIter.togglesTab (  TextTag  tag  )

Toggles Tab. Parameters: tag  Returns:

---