ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc'ed TextIter and the rest of TextView

Browse source 
svn path=/trunk/gtk-sharp/; revision=31352
This commit is contained in:
John Luke 2004-07-22 00:03:35 +00:00
parent 8de889da0e
commit f579d4098e
4 changed files with 309 additions and 258 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2004-07-21 John Luke <jluke@cfl.rr.com>
* en/Gtk/TextView.xml:
* en/Gtk/TextIter.xml: documented the rest
2004-07-16 John Luke <jluke@cfl.rr.com> 2004-07-16 John Luke <jluke@cfl.rr.com>
* en/Pango/*: doc'ed some more pango stuff * en/Pango/*: doc'ed some more pango stuff

6
doc/en/Gtk/TextChildAnchor.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>A spot in the buffer where child widgets can be "anchored" (inserted inline, as if they were characters).</summary>
<remarks>To be added</remarks> <remarks>The anchor can have multiple widgets anchored, to allow for multiple views.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -61,7 +61,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Creates a new TextChildAnchor</summary> <summary>Creates a new TextChildAnchor</summary>
<returns>To be added: an object of type 'Gtk.TextChildAnchor'</returns> <returns>a new <see cref="T:Gtk.TextChildAnchor" /></returns>
<remarks> <remarks>
<para> <para>
To create a new <see cref="T:Gtk.TextChildAnchor" />, you To create a new <see cref="T:Gtk.TextChildAnchor" />, you

520
doc/en/Gtk/TextIter.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Text buffer iterator</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns an empty <see cref="T:Gtk.TextIter" /></summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal method</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>To be added: an object of type 'Gtk.TextIter'</returns> <returns>a new <see cref="T:Gtk.TextIter" /></returns>
<remarks>To be added</remarks> <remarks>This is an internal method and should not be used by user code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardToTagToggle"> <Member MemberName="BackwardToTagToggle">
@ -57,10 +57,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves backward to the next toggle (on or off) of the <see cref="T:Gtk.TextTag" /> tag, or to the next toggle of any tag if tag is <see langword="null" />.</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /> or <see langword="null" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether we found a tag toggle before iter</returns>
<remarks>To be added</remarks> <remarks>If no matching tag toggles are found, returns <see langword="false" />, otherwise <see langword="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.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -71,9 +71,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates a dynamically-allocated copy of an iterator.</summary>
<returns>To be added: an object of type 'Gtk.TextIter'</returns> <returns>a <see cref="T:Gtk.TextIter" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardWordStart"> <Member MemberName="BackwardWordStart">
@ -84,9 +84,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves backward to the previous word start.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>(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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardSentenceEnd"> <Member MemberName="ForwardSentenceEnd">
@ -97,9 +98,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves forward to the next sentence end.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Order"> <Member MemberName="Order">
@ -112,9 +114,9 @@
<Parameter Name="second" Type="Gtk.TextIter" /> <Parameter Name="second" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Swaps the value of first and second if second comes before first in the buffer.</summary>
<param name="second">To be added: an object of type 'Gtk.TextIter'</param> <param name="second">another <see cref="T:Gtk.TextIter" /></param>
<remarks>To be added</remarks> <remarks>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 <see cref="M:Gtk.TextIter.InRange()" />, that expect a pre-sorted range.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardCursorPositions"> <Member MemberName="BackwardCursorPositions">
@ -127,10 +129,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves back <paramref name="count" /> cursor positions.</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of positions to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if we moved and the new position is dereferenceable</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardLine"> <Member MemberName="BackwardLine">
@ -143,7 +146,7 @@
<Docs> <Docs>
<summary>Moves the iterator backward one line</summary> <summary>Moves the iterator backward one line</summary>
<returns>true if the operation succeeded.</returns> <returns>true if the operation succeeded.</returns>
<remarks>To be added</remarks> <remarks>Returns <see langword="true" /> if iter could be moved; i.e. if iter was at character offset 0, this function returns <see langword="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 <see langword="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.)</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetVisibleSlice"> <Member MemberName="GetVisibleSlice">
@ -156,10 +159,10 @@
<Parameter Name="end" Type="Gtk.TextIter" /> <Parameter Name="end" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Like <see cref="M:Gtk.TextIter.GetSlice()" />, but invisible text is not included.</summary>
<param name="end">To be added: an object of type 'Gtk.TextIter'</param> <param name="end"> iterator at end of range</param>
<returns>To be added: an object of type 'string'</returns> <returns> slice of text from the buffer</returns>
<remarks>To be added</remarks> <remarks> Invisible text is usually invisible because a <see cref="T:Gtk.TextTag" /> with the "invisible" attribute turned on has been applied to it.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetSlice"> <Member MemberName="GetSlice">
@ -172,10 +175,10 @@
<Parameter Name="end" Type="Gtk.TextIter" /> <Parameter Name="end" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the text in the given range.</summary>
<param name="end">To be added: an object of type 'Gtk.TextIter'</param> <param name="end"> iterator at end of a range</param>
<returns>To be added: an object of type 'string'</returns> <returns> slice of text from the buffer</returns>
<remarks>To be added</remarks> <remarks>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.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardWordEnd"> <Member MemberName="ForwardWordEnd">
@ -186,9 +189,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves forward to the next word end.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>(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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardFindChar"> <Member MemberName="ForwardFindChar">
@ -203,12 +207,12 @@
<Parameter Name="limit" Type="Gtk.TextIter" /> <Parameter Name="limit" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Advances iter, calling pred on each character.</summary>
<param name="pred">To be added: an object of type 'Gtk.TextCharPredicate'</param> <param name="pred"> a function to be called on each character</param>
<param name="user_data">To be added: an object of type 'IntPtr'</param> <param name="user_data"> user data for pred</param>
<param name="limit">To be added: an object of type 'Gtk.TextIter'</param> <param name="limit"> search limit, or <see langword="null" /> for none</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether a match was found</returns>
<remarks>To be added</remarks> <remarks>If pred returns <see langword="true" />, returns <see langword="true" /> and stops scanning. If pred never returns <see langword="true" />, iter is set to limit if limit is non-<see langword="null" />, otherwise to the end iterator.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EndsWord"> <Member MemberName="EndsWord">
@ -219,9 +223,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether iter ends a natural-language word.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is at the end of a word</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Editable"> <Member MemberName="Editable">
@ -234,10 +239,18 @@
<Parameter Name="default_setting" Type="System.Boolean" /> <Parameter Name="default_setting" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns whether the character at iter is within an editable region of text.</summary>
<param name="default_setting">To be added: an object of type 'bool'</param> <param name="default_setting">
<returns>To be added: an object of type 'bool'</returns> <see langword="true" /> if text is editable by default</param>
<remarks>To be added</remarks> <returns> whether iter is inside an editable range</returns>
<remarks>
<para>
Non-editable text is "locked" and cannot be changed by the user via <see cref="T:Gtk.TextView" />. This function is simply a convenience wrapper around <see cref="M:Gtk.TextIter.GetAttributes()" />. If no tags applied to this text effect editability, <paramref name="default_setting" /> will be returned.
</para>
<para>
You do not want to use this function to decide whether text can be inserted at iter, because for insertion you do not 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 <see cref="M:Gtk.TextIter.CanInsert()" /> to handle this case.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardChar"> <Member MemberName="ForwardChar">
@ -248,9 +261,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves iter forward by one character offset.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks> <remarks>Note that images embedded in the buffer occupy 1 character slot, so this 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 return <see langword="false" /> for convenience when writing loops.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardLines"> <Member MemberName="BackwardLines">
@ -266,7 +279,7 @@
<summary>Moves the iterator back a number of lines.</summary> <summary>Moves the iterator back a number of lines.</summary>
<param name="count">number of lines to move backwards.</param> <param name="count">number of lines to move backwards.</param>
<returns>true if the operation succeeded.</returns> <returns>true if the operation succeeded.</returns>
<remarks>To be added</remarks> <remarks>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 <see langword="false" /> is returned. If count is 0, the function does nothing and returns <see langword="false" />. If count is negative, moves forward by 0 - count lines.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EndsLine"> <Member MemberName="EndsLine">
@ -279,7 +292,7 @@
<Docs> <Docs>
<summary>Returns true if the iterator is at the end of a line.</summary> <summary>Returns true if the iterator is at the end of a line.</summary>
<returns>true if the iterator is at the end of a line.</returns> <returns>true if the iterator is at the end of a line.</returns>
<remarks>To be added</remarks> <remarks>Returns <see langword="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 \n of a \r\n pair will not be counted as the end of a line, the line ends before the \r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Free"> <Member MemberName="Free">
@ -290,8 +303,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes of resources held by the iter.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardSentenceStarts"> <Member MemberName="BackwardSentenceStarts">
@ -304,10 +317,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Calls <see cref="M:Gtk.TextIter.BackwardSentenceStart()" /> up to <paramref name="count" /> times, or until it returns <see langword="false" />.</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of sentences to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>If <paramref name="count" /> is negative, moves forward instead of backward.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardToEnd"> <Member MemberName="ForwardToEnd">
@ -318,8 +332,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves iter forward to the "end iterator," which points one past the last valid character in the buffer.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardFindChar"> <Member MemberName="BackwardFindChar">
@ -334,12 +348,12 @@
<Parameter Name="limit" Type="Gtk.TextIter" /> <Parameter Name="limit" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Same as <see cref="M:Gtk.TextIter.ForwardFindChar()" />, but goes backward from iter.</summary>
<param name="pred">To be added: an object of type 'Gtk.TextCharPredicate'</param> <param name="pred"> function to be called on each character</param>
<param name="user_data">To be added: an object of type 'IntPtr'</param> <param name="user_data"> user data for pred</param>
<param name="limit">To be added: an object of type 'Gtk.TextIter'</param> <param name="limit"> search limit, or <see langword="null" /> for none</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether a match was found</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardCursorPositions"> <Member MemberName="ForwardCursorPositions">
@ -352,10 +366,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves up <paramref name="count" /> cursor positions.</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of positions to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if we moved and the new position is dereferenceable</returns>
<remarks>See <see cref="M:Gtk.TextIter.ForwardCursorPosition()" /> for details.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Equal"> <Member MemberName="Equal">
@ -368,10 +383,11 @@
<Parameter Name="rhs" Type="Gtk.TextIter" /> <Parameter Name="rhs" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Tests whether two iterators are equal, using the fastest possible mechanism.</summary>
<param name="rhs">To be added: an object of type 'Gtk.TextIter'</param> <param name="rhs">another <see cref="T:Gtk.TextIter" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if the iterators point to the same place in the buffer</returns>
<remarks>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 <see cref="M:Gtk.TextIter.Compare()" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TogglesTag"> <Member MemberName="TogglesTag">
@ -384,10 +400,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary> whether tag is either toggled on or off at iter</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /> or <see langword="null" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether tag is toggled on or off at iter</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StartsSentence"> <Member MemberName="StartsSentence">
@ -398,9 +414,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether iter begins a sentence.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is at the start of a sentence.</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardToTagToggle"> <Member MemberName="ForwardToTagToggle">
@ -413,10 +430,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves forward to the next toggle (on or off) of the <see cref="T:Gtk.TextTag" /> tag, or to the next toggle of any tag if tag is <see langword="null" />.</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /> or <see langword="null" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether we found a tag toggle after iter</returns>
<remarks>To be added</remarks> <remarks>If no matching tag toggles are found, returns <see langword="false" />, otherwise <see langword="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.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StartsLine"> <Member MemberName="StartsLine">
@ -427,9 +444,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns <see langword="true" /> if iter begins a paragraph.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter begins a line</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardCursorPosition"> <Member MemberName="BackwardCursorPosition">
@ -440,9 +457,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Like <see cref="M:Gtk.TextIter.ForwardCursorPosition()" />, but moves backward.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if we moved</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetAttributes"> <Member MemberName="GetAttributes">
@ -455,10 +473,18 @@
<Parameter Name="values" Type="Gtk.TextAttributes" /> <Parameter Name="values" Type="Gtk.TextAttributes" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Computes the effect of any tags applied to this spot in the text.</summary>
<param name="values">To be added: an object of type 'Gtk.TextAttributes'</param> <param name="values">a <see cref="T:Gtk.TextAttribute" />s</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if values was modified</returns>
<remarks>
<para>
The values parameter should be initialized to the default settings you wish to use if no tags are in effect. You would typically obtain the defaults from <see cref="M:Gtk.TextView.GetDefaultAttributes()" />.
</para>
<para>
<see cref="M:Gtk.TextIter.GetAttributes()" /> will modify values, applying the effects of any tags present at iter. If any tags affected values, the function returns <see langword="true" />.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetText"> <Member MemberName="GetText">
@ -471,10 +497,10 @@
<Parameter Name="end" Type="Gtk.TextIter" /> <Parameter Name="end" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns text in the given range.</summary>
<param name="end">To be added: an object of type 'Gtk.TextIter'</param> <param name="end"> iterator at end of a range</param>
<returns>To be added: an object of type 'string'</returns> <returns> the string from the buffer</returns>
<remarks>To be added</remarks> <remarks>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 <see cref="M:Gtk.TextIter.GetSlice()" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardCursorPosition"> <Member MemberName="ForwardCursorPosition">
@ -485,9 +511,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves iter forward by a single cursor position.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if we moved and the new position is dereferenceable</returns>
<remarks>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 cannot go between those two characters.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardLines"> <Member MemberName="ForwardLines">
@ -500,10 +527,10 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>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).</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of lines to move forward</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter moved and is dereferenceable</returns>
<remarks>To be added</remarks> <remarks>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 <see langword="false" /> is returned. If count is 0, the function does nothing and returns <see langword="false" />. If count is negative, moves backward by 0 - count lines.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardLine"> <Member MemberName="ForwardLine">
@ -514,9 +541,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves iter to the start of the next line.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks> <remarks>Returns <see langword="true" /> if there was a next line to move to, and <see langword="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.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardChars"> <Member MemberName="BackwardChars">
@ -532,7 +559,7 @@
<summary>Moves the iterator back a number of characters.</summary> <summary>Moves the iterator back a number of characters.</summary>
<param name="count">number of characters to move backwards.</param> <param name="count">number of characters to move backwards.</param>
<returns>true if the operation succeeded</returns> <returns>true if the operation succeeded</returns>
<remarks>To be added</remarks> <remarks>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 <see langword="false" /> is returned. If count is 0, the function does nothing and returns <see langword="false" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="HasTag"> <Member MemberName="HasTag">
@ -545,10 +572,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns <see langword="true" /> if iter is within a range tagged with tag.</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter is tagged with tag</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardSentenceStart"> <Member MemberName="BackwardSentenceStart">
@ -559,9 +586,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Moves backward to the previous sentence start; if iter is already at the start of a sentence, moves backward to the next one.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StartsWord"> <Member MemberName="StartsWord">
@ -572,9 +600,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether iter begins a natural-language word.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is at the start of a word</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BeginsTag"> <Member MemberName="BeginsTag">
@ -587,10 +616,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns <see langword="true" /> if tag is toggled on at exactly this point.</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /> or <see langword="null" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter is the start of a range tagged with tag</returns>
<remarks>To be added</remarks> <remarks>If tag is <see langword="null" />, returns <see langword="true" /> if any tag is toggled on at this point. Note that the <see cref="M:Gtk.TextIter.BeginsTag()" /> returns <see langword="true" /> if iter is the start of the tagged range; <see cref="M:Gtk.TextIter.HasTag()" /> tells you whether an iterator is within a tagged range.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetVisibleText"> <Member MemberName="GetVisibleText">
@ -603,10 +632,10 @@
<Parameter Name="end" Type="Gtk.TextIter" /> <Parameter Name="end" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Like <see cref="M:Gtk.TextIter.GetText()" />, but invisible text is not included.</summary>
<param name="end">To be added: an object of type 'Gtk.TextIter'</param> <param name="end"> iterator at end of range</param>
<returns>To be added: an object of type 'string'</returns> <returns> string containing visible text in the range</returns>
<remarks>To be added</remarks> <remarks>Invisible text is usually invisible because a <see cref="T:Gtk.TextTag" /> with the "invisible" attribute turned on has been applied to it.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardToLineEnd"> <Member MemberName="ForwardToLineEnd">
@ -617,9 +646,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>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.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if we moved and the new location is not the end iterator</returns>
<remarks> 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 <see langword="false" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EndsSentence"> <Member MemberName="EndsSentence">
@ -630,9 +660,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether iter ends a sentence.</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is at the end of a sentence.</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardSentenceEnds"> <Member MemberName="ForwardSentenceEnds">
@ -645,10 +676,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Calls <see cref="M:Gtk.TextIter.ForwardSentenceEnd()" /><paramref name="count" /> times (or until it returns <see langword="false" />).</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of sentences to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks>If <paramref name="count" /> is negative, moves backward instead of forward.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsideSentence"> <Member MemberName="InsideSentence">
@ -659,9 +691,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>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).</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is inside a sentence.</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardWordEnds"> <Member MemberName="ForwardWordEnds">
@ -674,10 +707,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Calls <see cref="M:Gtk.TextIter.ForwardWordEnd()" /> up to <paramref name="count" /> times.</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of times to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardChar"> <Member MemberName="BackwardChar">
@ -690,7 +724,7 @@
<Docs> <Docs>
<summary>Moves the iterator back one character</summary> <summary>Moves the iterator back one character</summary>
<returns>true if the operation succeeded</returns> <returns>true if the operation succeeded</returns>
<remarks>To be added</remarks> <remarks>Returns <see langword="true" /> if movement was possible; if iter was the first in the buffer (character offset 0), this returns <see langword="false" /> for convenience when writing loops.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EndsTag"> <Member MemberName="EndsTag">
@ -703,10 +737,10 @@
<Parameter Name="tag" Type="Gtk.TextTag" /> <Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns <see langword="true" /> if tag is toggled off at exactly this point.</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param> <param name="tag">a <see cref="T:Gtk.TextTag" /> or <see langword="null" /></param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter is the end of a range tagged with tag</returns>
<remarks>To be added</remarks> <remarks>If tag is <see langword="null" />, returns <see langword="true" /> if any tag is toggled off at this point. Note that the <see cref="T:Gtk.TextIter.EndsTag()" /> returns <see langword="true" /> if iter is the end of the tagged range; <see cref="T:Gtk.TextIter.HasTag()" /> tells you whether an iterator is within a tagged range.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardChars"> <Member MemberName="ForwardChars">
@ -719,10 +753,10 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>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).</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of characters to move, may be negative</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether iter moved and is dereferenceable</returns>
<remarks>To be added</remarks> <remarks>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 <see langword="false" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CanInsert"> <Member MemberName="CanInsert">
@ -735,10 +769,11 @@
<Parameter Name="default_editability" Type="System.Boolean" /> <Parameter Name="default_editability" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at iter would be editable.</summary>
<param name="default_editability">To be added: an object of type 'bool'</param> <param name="default_editability">
<returns>To be added: an object of type 'bool'</returns> <see langword="true" /> if text is editable by default</param>
<remarks>To be added</remarks> <returns> whether text inserted at iter would be editable</returns>
<remarks>If text inserted at iter would be editable then the user should be allowed to insert text at iter. <see cref="T:Gtk.TextBuffer.InsertInteractive()" /> uses this function to decide whether insertions are allowed at a given position.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Compare"> <Member MemberName="Compare">
@ -751,10 +786,10 @@
<Parameter Name="rhs" Type="Gtk.TextIter" /> <Parameter Name="rhs" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A qsort()-style function that returns negative if lhs is less than rhs, positive if lhs is greater than rhs, and 0 if they are equal.</summary>
<param name="rhs">To be added: an object of type 'Gtk.TextIter'</param> <param name="rhs">another <see cref="T:Gtk.TextIter" /></param>
<returns>To be added: an object of type 'int'</returns> <returns> -1 if lhs is less than rhs, 1 if lhs is greater, 0 if they are equal</returns>
<remarks>To be added</remarks> <remarks>Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsideWord"> <Member MemberName="InsideWord">
@ -765,9 +800,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace).</summary>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is inside a word</returns>
<remarks>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).</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InRange"> <Member MemberName="InRange">
@ -781,11 +817,13 @@
<Parameter Name="end" Type="Gtk.TextIter" /> <Parameter Name="end" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Checks whether iter falls in the range (start, end).</summary>
<param name="start">To be added: an object of type 'Gtk.TextIter'</param> <param name="start"> start of range</param>
<param name="end">To be added: an object of type 'Gtk.TextIter'</param> <param name="end"> end of range</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter is in the range</returns>
<remarks>
<paramref name="start" /> and <paramref name="end" /> must be in ascending order.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardWordStarts"> <Member MemberName="BackwardWordStarts">
@ -798,10 +836,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Calls <see cref="M:Gtk.TextIter.BackwardWordStart()" /> up to <paramref name="count" /> times.</summary>
<param name="count">To be added: an object of type 'int'</param> <param name="count"> number of times to move</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if iter moved and is not the end iterator</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="VisibleLineIndex"> <Member MemberName="VisibleLineIndex">
@ -813,10 +852,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>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.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">a <see cref="T:System.Int32" /></param>
<returns>To be added: an object of type 'int'</returns> <returns> byte index of iter with respect to the start of the line</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChildAnchor"> <Member MemberName="ChildAnchor">
@ -826,9 +865,9 @@
<ReturnType>Gtk.TextChildAnchor</ReturnType> <ReturnType>Gtk.TextChildAnchor</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>If the location at iter contains a child anchor, the anchor is returned. Otherwise, <see langword="null" /> is returned.</summary>
<returns>To be added: an object of type 'Gtk.TextChildAnchor'</returns> <returns> the anchor at iter</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CharsInLine"> <Member MemberName="CharsInLine">
@ -839,7 +878,7 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>Number of characters in the TextIter's line.</summary> <summary>Number of characters in the TextIter's line.</summary>
<returns>Returns the number of characters in the TextIter's current line.</returns> <returns>Returns the number of characters in the TextIter's current line, including the paragraph delimiters.</returns>
<remarks>None.</remarks> <remarks>None.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -855,7 +894,7 @@
<summary>Line number the iterator is currently on.</summary> <summary>Line number the iterator is currently on.</summary>
<param name="value">Moves the iterator to this line number.</param> <param name="value">Moves the iterator to this line number.</param>
<returns>The line number the iterator is currently on.</returns> <returns>The line number the iterator is currently on.</returns>
<remarks>To be added</remarks> <remarks>Lines in a <see cref="T:Gtk.TextBuffer" /> are numbered beginning with 0 for the first line in the buffer.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BytesInLine"> <Member MemberName="BytesInLine">
@ -865,9 +904,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the number of bytes in the line containing iter, including the paragraph delimiters.</summary>
<returns>To be added: an object of type 'int'</returns> <returns> number of bytes in the line</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Char"> <Member MemberName="Char">
@ -904,9 +943,9 @@
<ReturnType>Gdk.Pixbuf</ReturnType> <ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>return the pixbuf at this iter, if it is one.</summary>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns> the pixbuf at iter</returns>
<remarks>To be added</remarks> <remarks>If the element at iter is a <see cref="T:Gdk.Pixbuf" />, the Pixbuf is returned. Otherwise, <see langword="null" /> is returned.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Language"> <Member MemberName="Language">
@ -916,9 +955,9 @@
<ReturnType>Pango.Language</ReturnType> <ReturnType>Pango.Language</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>A convenience wrapper around <see cref="M:Gtk.TextIter.GetAttributes()" />, which returns the language in effect at iter.</summary>
<returns>To be added: an object of type 'Pango.Language'</returns> <returns> language in effect at iter</returns>
<remarks>To be added</remarks> <remarks>If no tags affecting language apply to iter, the return value is identical to that of <see cref="P:Gtk.Global.DefaultLanguage" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LineIndex"> <Member MemberName="LineIndex">
@ -930,10 +969,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the byte index of the iterator, counting from the start of a newline-terminated line.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">a <see cref="T:System.Int32" /></param>
<returns>To be added: an object of type 'int'</returns> <returns> distance from start of line, in bytes</returns>
<remarks>To be added</remarks> <remarks>Remember that <see cref="T:Gtk.TextBuffer" /> encodes text in UTF-8, and that characters can require a variable number of bytes to represent.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LineOffset"> <Member MemberName="LineOffset">
@ -945,10 +984,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns the character offset of the iterator, counting from the start of a newline-terminated line.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">a <see cref="T:System.Int32" /></param>
<returns>To be added: an object of type 'int'</returns> <returns> offset from start of line</returns>
<remarks>To be added</remarks> <remarks>The first character on the line has offset 0.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="VisibleLineOffset"> <Member MemberName="VisibleLineOffset">
@ -960,10 +999,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>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.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">a <see cref="T:System.Int32" /></param>
<returns>To be added: an object of type 'int'</returns> <returns> offset in visible characters from the start of the line</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Buffer"> <Member MemberName="Buffer">
@ -975,7 +1014,7 @@
<Docs> <Docs>
<summary>Obtains the buffer the iter is in</summary> <summary>Obtains the buffer the iter is in</summary>
<returns>containing buffer</returns> <returns>containing buffer</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BackwardSearch"> <Member MemberName="BackwardSearch">
@ -992,14 +1031,14 @@
<Parameter Name="limit" Type="Gtk.TextIter" /> <Parameter Name="limit" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Same as <see cref="M:Gtk.TextIter.ForwardSearch()" />, but moves backward.</summary>
<param name="str">To be added: an object of type 'string'</param> <param name="str"> search string</param>
<param name="flags">To be added: an object of type 'Gtk.TextSearchFlags'</param> <param name="flags"> bitmask of flags affecting the search</param>
<param name="match_start">To be added: an object of type 'Gtk.TextIter&amp;'</param> <param name="match_start"> return location for start of match, or <see langword="null" /></param>
<param name="match_end">To be added: an object of type 'Gtk.TextIter&amp;'</param> <param name="match_end"> return location for end of match, or <see langword="null" /></param>
<param name="limit">To be added: an object of type 'Gtk.TextIter'</param> <param name="limit"> location of last possible match_start, or <see langword="null" /> for start of buffer</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether a match was found</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForwardSearch"> <Member MemberName="ForwardSearch">
@ -1016,14 +1055,21 @@
<Parameter Name="limit" Type="Gtk.TextIter" /> <Parameter Name="limit" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Searches forward for <paramref name="str" />.</summary>
<param name="str">To be added: an object of type 'string'</param> <param name="str"> a search string</param>
<param name="flags">To be added: an object of type 'Gtk.TextSearchFlags'</param> <param name="flags"> flags affecting how the search is done</param>
<param name="match_start">To be added: an object of type 'Gtk.TextIter&amp;'</param> <param name="match_start"> return location for start of match, or <see langword="null" /></param>
<param name="match_end">To be added: an object of type 'Gtk.TextIter&amp;'</param> <param name="match_end"> return location for end of match, or <see langword="null" /></param>
<param name="limit">To be added: an object of type 'Gtk.TextIter'</param> <param name="limit"> bound for the search, or <see langword="null" /> for the end of the buffer</param>
<returns>To be added: an object of type 'bool'</returns> <returns> whether a match was found</returns>
<remarks>To be added</remarks> <remarks>
<para>
Any match is returned by setting <paramref name="match_start" /> to the first character of the match and <paramref name="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.
</para>
<para>
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.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsEnd"> <Member MemberName="IsEnd">
@ -1036,7 +1082,7 @@
<Docs> <Docs>
<summary>Returns true if the iterator is at the end of the parent <see cref="T:Gtk.TextBuffer" /></summary> <summary>Returns true if the iterator is at the end of the parent <see cref="T:Gtk.TextBuffer" /></summary>
<returns>true if the iterator is equal to Buffer.EndIter</returns> <returns>true if the iterator is equal to Buffer.EndIter</returns>
<remarks>To be added</remarks> <remarks>The most efficient way to check whether an iterator is the end iterator.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsStart"> <Member MemberName="IsStart">
@ -1047,9 +1093,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns <see langword="true" /> if iter is the first iterator in the buffer, that is if iter has a character offset of 0.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns> whether iter is the first in the buffer</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsCursorPosition"> <Member MemberName="IsCursorPosition">
@ -1062,7 +1108,7 @@
<Docs> <Docs>
<summary>returns true if the iter is at the caret</summary> <summary>returns true if the iter is at the caret</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>returns true if this iterator equals the iterator returned by Buffer.GetIterAtMark (Buffer.InsertMark)</remarks> <remarks>returns true if this iterator equals the iterator returned by <see cref="M:Gtk.TextBuffer.GetIterAtMark(Buffer.InsertMark)" /></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -1086,9 +1132,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns an array of <see cref="T:Gtk.TextMark" /> at this location.</summary>
<returns>a <see cref="T:Gtk.TextMark[]" /></returns> <returns>a <see cref="T:Gtk.TextMark[]" /></returns>
<remarks>To be added</remarks> <remarks>Because marks are not iterable (they do not 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.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Tags"> <Member MemberName="Tags">
@ -1099,9 +1145,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns an array of tags that apply to iter, in ascending order of priority (highest-priority tags are last).</summary>
<returns>a <see cref="T:Gtk.TextTag[]" /></returns> <returns>a <see cref="T:Gtk.TextTag[]" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetToggledTags"> <Member MemberName="GetToggledTags">
@ -1114,10 +1160,10 @@
<Parameter Name="toggled_on" Type="System.Boolean" /> <Parameter Name="toggled_on" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns an array of <see cref="T:Gtk.TextTag" /> that are toggled on or off at this point.</summary>
<param name="toggled_on">a <see cref="T:System.Boolean" /></param> <param name="toggled_on">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gtk.TextTag[]" /></returns> <returns>tags toggled at this point</returns>
<remarks>To be added</remarks> <remarks>(If toggled_on is <see langword="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.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

36
doc/en/Gtk/TextView.xml
View file

@ -1056,10 +1056,10 @@ class TextViewSample
</Parameters> </Parameters>
<Docs> <Docs>
<summary>This method should be fixed</summary> <summary>This method should be fixed</summary>
<param name="target_iter">To be added: an object of type 'Gtk.TextIter&amp;'</param> <param name="target_iter">a <see cref="T:Gtk.TextIter" /></param>
<param name="y">To be added: an object of type 'int'</param> <param name="y"> a y coordinate</param>
<param name="line_top">To be added: an object of type 'int&amp;'</param> <param name="line_top"> return location for top coordinate of the line</param>
<remarks>To be added</remarks> <remarks>Gets the <see cref="T:Gtk.TextIter" /> at the start of the line containing the coordinate <paramref name="y" />. <paramref name="y" /> is in buffer coordinates, convert from window coordinates with <see cref="M:Gtk.TextView.WindowToBufferCoords()" />. If non-<see langword="null" />, <paramref name="line_top" /> will be filled with the coordinate of the top edge of the line.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MoveChild"> <Member MemberName="MoveChild">
@ -1074,11 +1074,11 @@ class TextViewSample
<Parameter Name="ypos" Type="System.Int32" /> <Parameter Name="ypos" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Updates the position of a child</summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param> <param name="child"> child widget already added to the text view</param>
<param name="xpos">a <see cref="T:System.Int32" /></param> <param name="xpos"> new X position in window coordinates</param>
<param name="ypos">a <see cref="T:System.Int32" /></param> <param name="ypos"> new Y position in window coordinates</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddChildInWindow"> <Member MemberName="AddChildInWindow">
@ -1094,12 +1094,12 @@ class TextViewSample
<Parameter Name="ypos" Type="System.Int32" /> <Parameter Name="ypos" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a child at fixed coordinates in one of the text widget's windows.</summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param> <param name="child">a <see cref="T:Gtk.Widget" /></param>
<param name="which_window">a <see cref="T:Gtk.TextWindowType" /></param> <param name="which_window">a <see cref="T:Gtk.TextWindowType" /></param>
<param name="xpos">a <see cref="T:System.Int32" /></param> <param name="xpos">a <see cref="T:System.Int32" /></param>
<param name="ypos">a <see cref="T:System.Int32" /></param> <param name="ypos">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks>The window must have non-zero size (see <see cref="M:Gtk.TextView.SetBorderWindowSize()" />). Note that the child coordinates are given relative to the <see cref="T:Gdk.Window" /> in question, and that these coordinates have no sane relationship to scrolling. When placing a child in GTK_TEXT_WINDOW_WIDGET, scrolling is irrelevant, the child floats above all scrollable areas. But when placing a child in one of the scrollable windows (border windows or text window), you will need to compute the child's correct position in buffer coordinates any time scrolling occurs or buffer changes occur, and then call <see cref="M:Gtk.TextView.MoveChild()" /> to update the child's position. Unfortunately there is no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes. See bug 64518 on bugzilla.gnome.org for status of fixing this issue.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -1315,11 +1315,11 @@ class TextViewSample
<Parameter Name="y" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Retrieves the iterator at buffer coordinates <paramref name="x" /> and <paramref name="y" />.</summary>
<param name="x">a <see cref="T:System.Int32" /></param> <param name="x"> x position, in buffer coordinates</param>
<param name="y">a <see cref="T:System.Int32" /></param> <param name="y"> y position, in buffer coordinates</param>
<returns>a <see cref="T:Gtk.TextIter" /></returns> <returns>a <see cref="T:Gtk.TextIter" /></returns>
<remarks>To be added</remarks> <remarks>Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with <see cref="M:Gtk.TextView.WindowToBufferCoords()" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetIterLocation"> <Member MemberName="GetIterLocation">
@ -1332,10 +1332,10 @@ class TextViewSample
<Parameter Name="iter" Type="Gtk.TextIter" /> <Parameter Name="iter" Type="Gtk.TextIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets a rectangle which roughly contains the character at iter.</summary>
<param name="iter">a <see cref="T:Gtk.TextIter" /></param> <param name="iter">a <see cref="T:Gtk.TextIter" /></param>
<returns>a <see cref="T:Gdk.Rectangle" /></returns> <returns>a <see cref="T:Gdk.Rectangle" />, which is the bounds of the character at <paramref name="iter" /></returns>
<remarks>To be added</remarks> <remarks>The rectangle position is in buffer coordinates; use <see cref="M:Gtk.TextView.BufferToWindowCoords()" /> to convert these coordinates to coordinates for one of the windows in the text view.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>