docs for TreeModelFilter updates.

svn path=/trunk/gtk-sharp/; revision=42472
This commit is contained in:
Mike Kestner 2005-04-01 17:52:35 +00:00
parent 75509454d5
commit 8a88e202e1
2 changed files with 49 additions and 36 deletions

View file

@ -1,5 +1,5 @@
<Type Name="DestroyNotify" FullName="Gtk.DestroyNotify"> <Type Name="DestroyNotify" FullName="Gtk.DestroyNotify">
<TypeSignature Language="C#" Value="public sealed delegate void DestroyNotify ();" Maintainer="auto" /> <TypeSignature Language="C#" Maintainer="auto" Value="public sealed delegate void DestroyNotify ();" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>

View file

@ -104,13 +104,14 @@ in a <see cref="T:Gtk.TreeModel" /> for display.</summary>
<Parameter Name="destroy" Type="Gtk.DestroyNotify" /> <Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary> <summary>Sets the visible function used when filtering to be <paramref name="func" />.</summary>
Sets the visible function used when filtering to be <paramref name="func" />.
</summary>
<param name="func">a <see cref="T:Gtk.TreeModelFilterVisibleFunc" /></param> <param name="func">a <see cref="T:Gtk.TreeModelFilterVisibleFunc" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks> <remarks>
Note: this overload of the function is obsolete and requires you to manage the persistence
of func manually so it isn't garbage collected. The method has been replaced by a single parameter
overload which manages delegate persistence internally.
The function should return TRUE if the given row should be visible and The function should return TRUE if the given row should be visible and
FALSE otherwise. FALSE otherwise.
</remarks> </remarks>
@ -152,37 +153,6 @@ in a <see cref="T:Gtk.TreeModel" /> for display.</summary>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetModifyFunc">
<MemberSignature Language="C#" Value="public void SetModifyFunc (int n_columns, GLib.GType types, Gtk.TreeModelFilterModifyFunc func, IntPtr data, Gtk.DestroyNotify destroy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="n_columns" Type="System.Int32" />
<Parameter Name="types" Type="GLib.GType" />
<Parameter Name="func" Type="Gtk.TreeModelFilterModifyFunc" />
<Parameter Name="data" Type="System.IntPtr" />
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>Sets a function to modify the display of the model.</summary>
<param name="n_columns">a <see cref="T:System.Int32" /></param>
<param name="types">a <see cref="T:GLib.GType" /></param>
<param name="func">a <see cref="T:Gtk.TreeModelFilterModifyFunc" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>
With the <paramref name="n_columns" /> and <paramref name="types" /> parameters, you give an array of column
types for this model (which will be exposed to the parent model/view).
The <paramref name="func" />, <paramref name="data" /> and <paramref name="destroy" /> parameters are for specifying the modify
function. The modify function will get called for each
data access; the goal of the modify function is to return the data which
should be displayed at the location specified using the parameters of the
modify function.
</remarks>
</Docs>
</Member>
<Member MemberName="ConvertPathToChildPath"> <Member MemberName="ConvertPathToChildPath">
<MemberSignature Language="C#" Value="public Gtk.TreePath ConvertPathToChildPath (Gtk.TreePath filter_path);" /> <MemberSignature Language="C#" Value="public Gtk.TreePath ConvertPathToChildPath (Gtk.TreePath filter_path);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -1111,5 +1081,48 @@ in a <see cref="T:Gtk.TreeModel" /> for display.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetVisibleFunc">
<MemberSignature Language="C#" Value="public void SetVisibleFunc (Gtk.TreeModelFilterVisibleFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="func" Type="Gtk.TreeModelFilterVisibleFunc" />
</Parameters>
<Docs>
<summary>Sets the visible function used when filtering to be <paramref name="func" />.</summary>
<param name="func">a <see cref="T:Gtk.TreeModelFilterVisibleFunc" /></param>
<remarks>
The function should return <see langword="true"/> if the given row should be visible.
</remarks>
</Docs>
</Member>
<Member MemberName="SetModifyFunc">
<MemberSignature Language="C#" Value="public void SetModifyFunc (int n_columns, GLib.GType[] types, Gtk.TreeModelFilterModifyFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="n_columns" Type="System.Int32" />
<Parameter Name="types" Type="GLib.GType[]" />
<Parameter Name="func" Type="Gtk.TreeModelFilterModifyFunc" />
</Parameters>
<Docs>
<summary>Sets a function to modify the display of the model.</summary>
<param name="n_columns">a <see cref="T:System.Int32" /></param>
<param name="types">an array of <see cref="T:GLib.GType" /></param>
<param name="func">a <see cref="T:Gtk.TreeModelFilterModifyFunc" /></param>
<remarks>
With the <paramref name="n_columns" /> and <paramref name="types" /> parameters, you give an array of column
types for this model (which will be exposed to the parent model/view).
The modify function, <paramref name="func" />, will get called for each
data access; the goal of the modify function is to return the data which
should be displayed at the location specified using the parameters of the
modify function.
</remarks>
</Docs>
</Member>
</Members> </Members>
</Type> </Type>