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

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

Browse source 
* en/Gtk/TreeViewColumn.xml
	* en/Gtk/TreeStore.xml
	* en/Gtk/TreeView.xml
	* en/Gtk/TreeRowReference.xml
	* en/Gtk/TreeModelFilter.xml: Add docs

svn path=/trunk/gtk-sharp/; revision=38183
This commit is contained in:
Shane Landrum 2004-12-30 14:54:08 +00:00
parent 2d2eb71ed0
commit 24f5605366
6 changed files with 64 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/ChangeLog
View file

@ -1,3 +1,11 @@
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/TreeViewColumn.xml
* en/Gtk/TreeStore.xml
* en/Gtk/TreeView.xml
* en/Gtk/TreeRowReference.xml
* en/Gtk/TreeModelFilter.xml: Add docs
2004-12-29 John Luke <john.luke@gmail.com> 2004-12-29 John Luke <john.luke@gmail.com>
* gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor * gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor

2
doc/en/Gtk/TreeModelFilter.xml
View file

@ -969,7 +969,7 @@ in a <see cref="T:Gtk.TreeModel" /> for display.</summary>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks /> <remarks />
</Docs> </Docs>

38
doc/en/Gtk/TreeRowReference.xml
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> <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>Internal struct. Do not use.</summary> <summary>Internal struct. Do not use.</summary>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -34,10 +34,10 @@
<Parameter Name="path" Type="Gtk.TreePath" /> <Parameter Name="path" Type="Gtk.TreePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="proxy">an object of type <see cref="T:GLib.Object" /></param> <param name="proxy">an object of type <see cref="T:GLib.Object" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param> <param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Deleted"> <Member MemberName="Deleted">
@ -51,10 +51,10 @@
<Parameter Name="path" Type="Gtk.TreePath" /> <Parameter Name="path" Type="Gtk.TreePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="proxy">an object of type <see cref="T:GLib.Object" /></param> <param name="proxy">an object of type <see cref="T:GLib.Object" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param> <param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Valid"> <Member MemberName="Valid">
@ -65,9 +65,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<returns>an object of type <see cref="T:System.boolean" /></returns> <returns>an object of type <see cref="T:System.boolean" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Free"> <Member MemberName="Free">
@ -78,8 +78,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -107,11 +107,11 @@
<Parameter Name="path" Type="Gtk.TreePath" /> <Parameter Name="path" Type="Gtk.TreePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="model">an object of type <see cref="T:Gtk.TreeModel" /></param> <param name="model">an object of type <see cref="T:Gtk.TreeModel" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param> <param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:Gtk.TreeRowReference" /></returns> <returns>an object of type <see cref="T:Gtk.TreeRowReference" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -124,12 +124,12 @@
<Parameter Name="path" Type="Gtk.TreePath" /> <Parameter Name="path" Type="Gtk.TreePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="proxy">an object of type <see cref="T:GLib.Object" /></param> <param name="proxy">an object of type <see cref="T:GLib.Object" /></param>
<param name="model">an object of type <see cref="T:Gtk.TreeModel" /></param> <param name="model">an object of type <see cref="T:Gtk.TreeModel" /></param>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param> <param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:Gtk.TreeRowReference" /></returns> <returns>an object of type <see cref="T:Gtk.TreeRowReference" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Path"> <Member MemberName="Path">
@ -139,9 +139,9 @@
<ReturnType>Gtk.TreePath</ReturnType> <ReturnType>Gtk.TreePath</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns> <returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -152,9 +152,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<returns>a <see cref="T:Gtk.TreeRowReference" /></returns> <returns>a <see cref="T:Gtk.TreeRowReference" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -182,12 +182,12 @@
<Parameter Name="iter" Type="Gtk.TreeIter" /> <Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<param name="proxy">a <see cref="T:GLib.Object" /></param> <param name="proxy">a <see cref="T:GLib.Object" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param> <param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param> <param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

4
doc/en/Gtk/TreeStore.xml
View file

@ -1578,9 +1578,9 @@ store = new TreeStore (typeof (int), typeof (string));
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.TreeStore" /></returns> <returns>a <see cref="T:Gtk.TreeStore" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

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

@ -1763,9 +1763,9 @@ tree_view.AppendColumn ("title", text, "text", 0);
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether or not to assume all rows are the same height.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>This is an optimization; set to <see langword="true"/> for fastest performance.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsertColumnWithDataFunc"> <Member MemberName="InsertColumnWithDataFunc">
@ -1783,15 +1783,21 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="dnotify" Type="System.IntPtr" /> <Parameter Name="dnotify" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Convenience function that inserts a new column into the tree view
<param name="position">a <see cref="T:System.Int32" /></param> with the given cell renderer and a <see cref="T:Gtk.TreeCellDataFunc" /> to set cell renderer
<param name="title">a <see cref="T:System.String" /></param> attributes (normally using data from the model). </summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="position">a <see cref="T:System.Int32" />, the position of the new column (-1 to append, positive numbers to insert)</param>
<param name="func">a <see cref="T:Gtk.TreeCellDataFunc" /></param> <param name="title">a <see cref="T:System.String" />, the column title</param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" />, the renderer object</param>
<param name="dnotify">a <see cref="T:System.IntPtr" /></param> <param name="func">a <see cref="T:Gtk.TreeCellDataFunc" />, a function for presenting the data</param>
<param name="data">a <see cref="T:System.IntPtr" />, pointer to the data for <paramref name="func"/></param>
<param name="dnotify">a <see cref="T:System.IntPtr" />, a destroy notifier for <paramref name="data"/></param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>
See also <see cref="M:Gtk.TreeViewColumn.SetCellDataFunc"/>, <see cref="M:Gtk.TreeViewColumn.PackStart"/>.
If the tree view has <see cref="P:Gtk.TreeViewColumn.FixedHeightMode"/> enabled, then <paramref name="column"/> must have its
<see cref="P:Gtk.TreeViewColumn.Sizing"/> property set to be <see cref="P:Gtk.TreeViewColumnSizing.Fixed"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

21
doc/en/Gtk/TreeViewColumn.xml
View file

@ -93,7 +93,7 @@
<param name="func">an object of type <see cref="T:Gtk.TreeCellDataFunc" /></param> <param name="func">an object of type <see cref="T:Gtk.TreeCellDataFunc" /></param>
<param name="func_data">an object of type <see cref="T:System.IntPtr" /></param> <param name="func_data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param> <param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the <see cref="T:Gtk.TreeViewColumn" /><paramref name="cell_renderer" /> as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.</remarks> <remarks>This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the <see cref="T:Gtk.TreeViewColumn" /> <paramref name="cell_renderer" /> as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -576,9 +576,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether this column gets share of extra width allocated to the widget.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Reorder"> <Member MemberName="Reorder">
@ -592,10 +592,10 @@
<Parameter Name="position" Type="System.Int32" /> <Parameter Name="position" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Re-inserts <paramref name="cell"/> at <paramref name="position"/>.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param> <param name="position">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks>The given cell must already be packed into the layout for this method to work properly.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PackEnd"> <Member MemberName="PackEnd">
@ -693,12 +693,19 @@
<Parameter Name="destroy" Type="System.IntPtr" /> <Parameter Name="destroy" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets the <see cref="T:Gtk.CellLayoutDataFunc"/> to use for the column.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param> <param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param> <param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param> <param name="destroy">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks> <remarks>
This function is used instead of the standard attributes mapping for
setting the column value, and should set the value of this tree view column's
cell renderer as appropriate. <paramref name="func"/> may be
<see langword="null"/> to remove an older one.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetCellDataFunc"> <Member MemberName="SetCellDataFunc">