2004-12-14 Shane Landrum <epicene@pobox.com>

* en/Gtk/TextTagInfo.xml
	* en/Gtk/TextToggleBody.xml
	* en/Gtk/TextLineSegmentClass.xml
	* en/Gtk/TextPendingScroll.xml
	* en/Gtk/TextView.xml
	* en/Gtk/TextLineSegment.xml: Changed "to be added" to "do not use"
	* en/Gtk/TextIter.xml
	* en/Gtk/TextBuffer.xml : Added docs for remaining TBA items.


svn path=/trunk/gtk-sharp/; revision=37763
This commit is contained in:
Shane Landrum 2004-12-14 22:04:26 +00:00
parent 5f25db65e0
commit 5e4e7b1498
9 changed files with 143 additions and 96 deletions

View file

@ -1,3 +1,14 @@
2004-12-14 Shane Landrum <epicene@pobox.com>
* en/Gtk/TextTagInfo.xml
* en/Gtk/TextToggleBody.xml
* en/Gtk/TextLineSegmentClass.xml
* en/Gtk/TextPendingScroll.xml
* en/Gtk/TextView.xml
* en/Gtk/TextLineSegment.xml: Changed "to be added" to "do not use"
* en/Gtk/TextIter.xml
* en/Gtk/TextBuffer.xml : Added docs for remaining TBA items.
2004-12-12 Shane Landrum <epicene@pobox.com>
* en/Gtk/ToolItem.xml

View file

@ -1691,11 +1691,20 @@
<Parameter Name="bound" Type="Gtk.TextIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> This function moves the <paramref name="insert"/> and
<paramref name="selection_bound"/> marks simultaneously.
</summary>
<param name="ins">a <see cref="T:Gtk.TextIter" /></param>
<param name="bound">a <see cref="T:Gtk.TextIter" /></param>
<remarks>To be added</remarks>
<remarks>
If you move them in two steps
with <see cref="M:Gtk.TextBuffer.MoveMark"/>, you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff
to be recalculated. This function moves them as a unit, which can
be optimized.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -1176,10 +1176,13 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Moves up to <paramref name="count"/> visible cursor positions.
</summary>
<param name="count">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if the iter was moved and is in a dereferenceable position.</returns>
<remarks>
See <see cref="M:Gtk.TextIter.ForwardCursorPosition"/> for details.
</remarks>
</Docs>
</Member>
<Member MemberName="BackwardVisibleWordStarts">
@ -1192,10 +1195,10 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Calls <see cref="M:Gtk.TextIter.BackwardVisibleWordStart"/> up to <paramref name="count"/> times.</summary>
<param name="count">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if the iterator moved and is not at the end of the text.</returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="ForwardVisibleCursorPosition">
@ -1206,9 +1209,9 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Moves the iterator forward to the next visible cursor position.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>See <see cref="M:Gtk.TextIter.ForwardCursorPosition"/> for details.</remarks>
</Docs>
</Member>
<Member MemberName="BackwardVisibleCursorPositions">
@ -1221,10 +1224,10 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Moves backward up to <paramref name="count"/> visible cursor positions.</summary>
<param name="count">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if the cursor was moved and is in a dereferenceable position.</returns>
<remarks>See <see cref="M:Gtk.TextIter.BackwardCursorPosition"/> for details.</remarks>
</Docs>
</Member>
<Member MemberName="ForwardVisibleWordEnd">
@ -1235,9 +1238,17 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>
Moves forward to the next visible word end.
(If the iterator is currently on a
word end, moves forward to the next one after that.)
</summary>
<returns>a <see cref="T:System.Boolean" />, true if the iterator moved and is not at the end.</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>
</Member>
<Member MemberName="BackwardVisibleCursorPosition">
@ -1248,9 +1259,10 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Moves the iterator back to the previous visible cursor position.
</summary>
<returns>a <see cref="T:System.Boolean" />, true if the iter moved and the new position is dereferenceable</returns>
<remarks>See <see cref="M:Gtk.TextIter.BackwardCursorPosition"/> for details.</remarks>
</Docs>
</Member>
<Member MemberName="ForwardVisibleWordEnds">
@ -1263,10 +1275,18 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Moves forward to the next visible word end. (If the
iterator is currently on a word end, moves forward to the next
one after that.)
</summary>
<param name="count">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if the iterator moved and is not at the end.</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>
</Member>
<Member MemberName="BackwardVisibleWordStart">
@ -1277,10 +1297,17 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Moves backward to the previous visible word start. (If the iterator is currently
on a word start, moves backward to the next one after that.)
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<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>
</Member>
</Members>
</Type>
</Type>

View file

@ -11,7 +11,7 @@
<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>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks>Do not use</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="Split">
@ -41,10 +41,10 @@
<Parameter Name="iter" Type="Gtk.TextIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">To be added: an object of type 'Gtk.TextIter'</param>
<returns>To be added: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="iter">Do not use: an object of type 'Gtk.TextIter'</param>
<returns>Do not use: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="New">
@ -57,10 +57,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="raw">Do not use: an object of type 'IntPtr'</param>
<returns>Do not use: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="next">
@ -70,9 +70,9 @@
<ReturnType>Gtk.TextLineSegment</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<returns>Do not use: an object of type 'Gtk.TextLineSegment'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="type">
@ -82,9 +82,9 @@
<ReturnType>Gtk.TextLineSegmentClass</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextLineSegmentClass'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<returns>Do not use: an object of type 'Gtk.TextLineSegmentClass'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="CharCount">
@ -96,8 +96,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="ByteCount">
@ -109,8 +109,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="Chars">
@ -122,9 +122,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -11,7 +11,7 @@
<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>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks>Do not use</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.TextLineSegmentClass'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="raw">Do not use: an object of type 'IntPtr'</param>
<returns>Do not use: an object of type 'Gtk.TextLineSegmentClass'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="Name">
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="LeftGravity">
@ -69,9 +69,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -11,7 +11,7 @@
<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>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks>Do not use</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -40,4 +40,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -11,7 +11,7 @@
<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>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks>Do not use</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.TextTagInfo'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="raw">Do not use: an object of type 'IntPtr'</param>
<returns>Do not use: an object of type 'Gtk.TextTagInfo'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="tag">
@ -56,10 +56,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.TextTag'</param>
<returns>To be added: an object of type 'Gtk.TextTag'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="value">Do not use: an object of type 'Gtk.TextTag'</param>
<returns>Do not use: an object of type 'Gtk.TextTag'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="ToggleCount">
@ -71,9 +71,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -11,7 +11,7 @@
<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>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks>Do not use</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.TextToggleBody'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<param name="raw">Do not use: an object of type 'IntPtr'</param>
<returns>Do not use: an object of type 'Gtk.TextToggleBody'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="info">
@ -54,9 +54,9 @@
<ReturnType>Gtk.TextTagInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextTagInfo'</returns>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<returns>Do not use: an object of type 'Gtk.TextTagInfo'</returns>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="InNodeCounts">
@ -68,9 +68,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -1354,9 +1354,9 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether Tab will result in a tab character being entered.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>Defaults to true.</remarks>
</Docs>
</Member>
<Member MemberName="Overwrite">
@ -1367,10 +1367,10 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether entered text overwrites existing contents.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>Defaults to false.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>