2004-08-26 Shane Landrum <epicene@pobox.com>

* en/Gtk/TreeModelSort.xml
	* en/Gtk/TreeView.xml: XML fixes.
	* en/Gtk/TextWindow.xml: Added docs.
	* en/Gtk/TextIter.xml: Elaborated existing docs.
	* en/Gtk/TextCharPredicate: Delegate for TextIter; docs.
	* en/Gtk/TextTagTableForeach.xml: Added docs.
	* en/Gtk/InsertTextArgs.xml: Event arguments.
	* en/Gtk/TextTag.xml: Added docs.
	* en/Gtk/TextCounter.xml: Internal class. Do not use.
	* en/Gtk/TextToggleBody.xml: Internal class. Do not use.
	* en/Gtk/TextTagInfo.xml: Internal class. Do not use.

svn path=/trunk/gtk-sharp/; revision=32891
This commit is contained in:
Shane Landrum 2004-08-26 16:23:18 +00:00
parent 400ae6afb3
commit efb53c5ec7
12 changed files with 57 additions and 41 deletions

View File

@ -1,3 +1,18 @@
2004-08-26 Shane Landrum <epicene@pobox.com>
* en/Gtk/TreeModelSort.xml
* en/Gtk/TreeView.xml: XML fixes.
* en/Gtk/TextWindow.xml: Added docs.
* en/Gtk/TextIter.xml: Elaborated existing docs.
* en/Gtk/TextCharPredicate: Delegate for TextIter; docs.
* en/Gtk/TextTagTableForeach.xml: Added docs.
* en/Gtk/InsertTextArgs.xml: Event arguments.
* en/Gtk/TextTag.xml: Added docs.
* en/Gtk/TextCounter.xml: Internal class. Do not use.
* en/Gtk/TextToggleBody.xml: Internal class. Do not use.
* en/Gtk/TextTagInfo.xml: Internal class. Do not use.
2004-08-24 Shane Landrum <epicene@pobox.com>
* en/Gtk/TreeView.xml:

View File

@ -39,9 +39,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>The length of the inserted text.</summary>
<returns>A <see cref="T:System.Int32"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Text">
@ -51,9 +51,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The text that was inserted.</summary>
<returns>A <see cref="T:System.String"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Pos">
@ -63,10 +63,10 @@
<ReturnType>Gtk.TextIter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextIter'</returns>
<remarks>To be added</remarks>
<summary>The location where the text was inserted.</summary>
<returns>A <see cref="T:Gtk.TextIter"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -7,8 +7,8 @@
</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>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A delegate to be run over each character of a text buffer.</summary>
<remarks>Used by <see cref="Gtk.TextIter.ForwardFindChar"/> and <see cref="Gtk.TextIter.BackwardFindChar"/>. Generally, it's a search function of some sort.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

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

View File

@ -207,9 +207,9 @@
<Parameter Name="limit" Type="Gtk.TextIter" />
</Parameters>
<Docs>
<summary>Advances iter, calling pred on each character.</summary>
<param name="pred"> a function to be called on each character</param>
<param name="user_data"> user data for pred</param>
<summary>Advances the iterator, calling <paramref name="pred"/> on each character.</summary>
<param name="pred">A <see cref="M:Gtk.TextCharPredicate"/> to call on each character.</param>
<param name="user_data"> user data for <paramref name="pred"/></param>
<param name="limit"> search limit, or <see langword="null" /> for none</param>
<returns> whether a match was found</returns>
<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>
@ -349,8 +349,8 @@ You do not want to use this function to decide whether text can be inserted at i
</Parameters>
<Docs>
<summary>Same as <see cref="M:Gtk.TextIter.ForwardFindChar()" />, but goes backward from iter.</summary>
<param name="pred"> function to be called on each character</param>
<param name="user_data"> user data for pred</param>
<param name="pred">A <see cref="M:Gtk.TextCharPredicate"/> to call on each character.</param>
<param name="user_data"> user data for <paramref name="pred"/></param>
<param name="limit"> search limit, or <see langword="null" /> for none</param>
<returns> whether a match was found</returns>
<remarks />
@ -1167,4 +1167,4 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -46,12 +46,12 @@ Tags should be in the <see cref="T:Gtk.TextTagTable" /> for a given <see cref="T
<Parameter Name="iter" Type="Gtk.TextIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="event_object">To be added: an object of type 'GLib.Object'</param>
<param name="evnt">To be added: an object of type 'Gdk.Event'</param>
<param name="iter">To be added: an object of type 'Gtk.TextIter'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Fires a <paramref name="evnt"/> signal on this Gtk.TextTag.</summary>
<param name="event_object">a <see cref="T:GLib.Object"/>, the object that received the event.</param>
<param name="evnt">a <see cref="Gdk.Event"/>, the event to fire</param>
<param name="iter">a <see cref="Gtk.TextIter"/>, the location where the event was received</param>
<returns>A <see cref="T:System.Boolean"/>, true if the event was handled.</returns>
<remarks>TODO: show an example.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -319,7 +319,7 @@ Tags should be in the <see cref="T:Gtk.TextTagTable" /> for a given <see cref="T
<summary>Pixels of blank space below paragraphs.</summary>
<param name="value">pixels of blank space</param>
<returns>Pixels of blank space below paragraphs.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="BackgroundStipple">
@ -743,4 +743,4 @@ Default value: 400
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,7 +10,7 @@
</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>
<Docs>
<summary>To be added</summary>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -76,4 +76,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -7,8 +7,8 @@
</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>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A delegate function to be run on every <see cref="T:Gtk.TextTag"/> in a <see cref="T:Gtk.TextTagTable"/>.</summary>
<remarks>Callable by <see cref="M:Gtk.TextTagTable.Foreach"/></remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -10,7 +10,7 @@
</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>
<Docs>
<summary>To be added</summary>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -73,4 +73,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,8 @@
</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>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A basic window type that contains text.</summary>
<remarks>FIXME: this class may be for internal use only.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -40,4 +40,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -631,6 +631,7 @@ node is always the parent.</remarks>
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
<Parameter Name="child" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>Sets <paramref name="iter" /> to be the parent of <paramref name="child" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="child">an object of type <see cref="T:Gtk.TreeIter" /></param>

View File

@ -1070,7 +1070,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>Fired when the cursor toggles a row.</summary>
<remarks>(FIXME: explain in more detail.)
<remarks>(FIXME: explain in more detail.)</remarks>
</Docs>
</Member>
<Member MemberName="StartInteractiveSearch">
@ -1366,7 +1366,7 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Docs>
<summary>Return the type of view mode being used for this TreeView.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>FIXME: needs clarification.</remark>
<remarks>FIXME: needs clarification.</remarks>
</Docs>
</Member>
<Member MemberName="OnCursorChanged">