ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2025-01-11 15:35:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse source 
* en/Gtk/TreeCellDataFunc.xml
	* en/Gtk/TreeDataList.xml
	* en/Gtk/TreeDestroyCountFunc.xml
	* en/Gtk/TreeIter.xml
	* en/Gtk/TreeIterCompareFunc.xml
	* en/Gtk/TreeModel.xml
	* en/Gtk/TreeModelForeachFunc.xml
	* en/Gtk/TreeSelectionFunc.xml
	* en/Gtk/TreeSortable.xml
	* en/Gtk/TreeView.xml: Various updates to tree object docs.

svn path=/trunk/gtk-sharp/; revision=32313
This commit is contained in:
Shane Landrum 2004-08-13 16:36:59 +00:00
parent ac9699f465
commit 658a41d410
11 changed files with 75 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/ChangeLog
View file

@ -1,3 +1,16 @@
2004-08-13 Shane Landrum <epicene@pobox.com>
* en/Gtk/TreeCellDataFunc.xml
* en/Gtk/TreeDataList.xml
* en/Gtk/TreeDestroyCountFunc.xml
* en/Gtk/TreeIter.xml
* en/Gtk/TreeIterCompareFunc.xml
* en/Gtk/TreeModel.xml
* en/Gtk/TreeModelForeachFunc.xml
* en/Gtk/TreeSelectionFunc.xml
* en/Gtk/TreeSortable.xml
* en/Gtk/TreeView.xml: Various updates to tree object docs.
2004-08-13 Shane Landrum <epicene@pobox.com>
* en/Gtk/*Args.xml: Documented many handler arguments classes.

4
doc/en/Gtk/TreeCellDataFunc.xml
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 for methods that handle tree cell data.</summary>
<remarks>Methods with this shape are used to specify how to fill in tree data; see for example <see cref="M:Gtk.TreeViewColumn.SetCellDataFunc()" /> for one place where this class is used as a parameter.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Gtk/TreeDataList.xml
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 class for handling the underlying data of a tree like a list.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>

4
doc/en/Gtk/TreeDestroyCountFunc.xml
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>Delegate class for use by <see cref="C:Gtk.TreeView.SetDestroyCountFunc" />. Almost never used; see that method's docs to find out why you might want to use it.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

16
doc/en/Gtk/TreeIter.xml
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>The <see cref="T:Gtk.TreeIter" /> is the primary structure for accessing a structure.</summary>
<summary>The <see cref="T:Gtk.TreeIter" /> is the primary structure for accessing a tree row.</summary>
<remarks>Models are expected to put a unique integer in the <see cref="F:Gtk.TreeIter.stamp" /> field, and put model-specific data in the three <see cref="F:Gtk.TreeIter.user_data" /> fields.</remarks>
</Docs>
<Base>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Makes a new TreeIter with empty/default values.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.TreeIter" /> object.</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<param name="raw">an object of type <see cref="T:System.IntPtr" />, a pointer to the underlying C object.</param>
<returns>an object of type <see cref="T:Gtk.TreeIter" /></returns>
<remarks>This is usually called indirectly by other methods.</remarks>
<remarks>This is usually called indirectly by other methods. Not for use by application developers.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
@ -55,8 +55,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Disposes of memory used by this TreeIter object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Copy">
@ -67,7 +67,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>copy the TreeIter by value.</summary>
<summary>Copy the TreeIter by value.</summary>
<returns>the copy of the <see cref="T:Gtk.TreeIter" /></returns>
<remarks />
</Docs>

4
doc/en/Gtk/TreeIterCompareFunc.xml
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>Delegate function to specify the shape of comparison functions for tree iterators.</summary>
<remarks>Functions with this call syntax are usually used for comparison between two tree iterators as part of a sort. (FIXME: provide better examples.)</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

41
doc/en/Gtk/TreeModel.xml
View file

@ -254,10 +254,10 @@
<Parameter Name="var_args" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the values of child properties for the row pointed to by <paramref name="iter" />.</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="var_args">an object of type <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<param name="var_args">a <see cref="T:System.IntPtr" />, pointer to the va_list data structure of arguments (FIXME: clarify what va_lists look like)</param>
<remarks />
</Docs>
</Member>
<Member MemberName="UnrefNode">
@ -504,11 +504,11 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is a boolean.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -523,11 +523,11 @@
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is a <see cref="T:System.Double" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -542,11 +542,11 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is an <see cref="T:System.Int32" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -561,11 +561,11 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is an <see cref="T:System.String" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -580,11 +580,11 @@
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is an <see cref="T:System.Single" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Single" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SetValue">
@ -599,11 +599,10 @@
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is an <see cref="T:System.UInt32" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetValue">
@ -618,11 +617,11 @@
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the value of column <paramref name="column" /> in the row pointed to by <paramref name="iter" /> to <paramref name="value" /> if the value is an <see cref="T:System.Object" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Object" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetValue">
@ -636,11 +635,11 @@
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the value stored in column <paramref name="column" /> of the row pointed to by <paramref name="iter" />.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetColumnType">
@ -689,11 +688,11 @@
<Parameter Name="value" Type="GLib.Value&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the value stored in column <paramref name="column" /> of the row pointed to by <paramref name="iter" /> and stores it in <paramref name="value" /></summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="IterNext">

5
doc/en/Gtk/TreeModelForeachFunc.xml
View file

@ -7,8 +7,9 @@
</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 class for functions that can be run on every row of a <see cref="F:TreeModel" />.</summary>
<remarks>This class specifies the standard interface for functions used
as parameters to <see cref="M:Gtk.TreeModel.Foreach()" />.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Gtk/TreeSelectionFunc.xml
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 for specifying the shape of functions passed as parameters to <see cref="F:Gtk.TreeSelection.SetSelectFunction()" />.</summary>
<remarks>This function will get called on select and unselect of widget text. It should return <see langword='true' /> if the state of the tree node may be toggled and <see langword="false" /> if the state of the node should not be changed.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Gtk/TreeSortable.xml
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>An interface for specifying a tree model that is sortable.</summary>
<remarks />
</Docs>
<Base />
<Interfaces>

22
doc/en/Gtk/TreeView.xml
View file

@ -456,7 +456,7 @@ public class TreeViewDemo {
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>This function should almost never be used.</summary>
<summary>This function should almost never be used. It is meant for private use by ATK for determining the number of visible children that are removed when the user collapses a row, or a row is deleted.</summary>
<param name="func">an object of type <see cref="T:Gtk.TreeDestroyCountFunc" /></param>
<param name="data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
@ -932,7 +932,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SelectCursorRow">
@ -944,7 +944,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="RowCollapsed">
@ -968,7 +968,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ExpandCollapseCursorRow">
@ -980,7 +980,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="RowActivated">
@ -992,7 +992,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="TestCollapseRow">
@ -1004,7 +1004,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="CursorChanged">
@ -1016,7 +1016,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetPathAtPos">
@ -1070,7 +1070,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="StartInteractiveSearch">
@ -1082,7 +1082,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="SelectAll">
@ -1366,7 +1366,7 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="OnCursorChanged">