2004-11-05 22:25:40 +01:00
<Type Name= "TreeModelFilter" FullName= "Gtk.TreeModelFilter" >
2005-05-23 22:41:51 +02:00
<TypeSignature Language= "C#" Maintainer= "auto" Value= "public class TreeModelFilter : GLib.Object, Gtk.TreeDragSource, Gtk.TreeModel" />
2004-11-05 22:25:40 +01:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
<AssemblyPublicKey > [00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
2005-06-17 20:43:30 +02:00
<AssemblyVersion > 2.6.0.0</AssemblyVersion>
2004-11-05 22:25:40 +01:00
</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 >
2004-11-30 23:42:26 +01:00
<summary > An object designed to filter the contents of a column or columns
2004-12-08 03:37:02 +01:00
in a <see cref= "T:Gtk.TreeModel" /> for display.</summary>
<remarks />
2005-07-22 20:47:57 +02:00
<example >
2005-08-08 06:28:14 +02:00
<code lang= "C#" >
2005-07-20 05:15:51 +02:00
using System;
using Gtk;
public class MyWindow : Window
{
TreeView view;
TreeModelFilter filter;
Entry search;
static void Main ()
{
Application.Init ();
new MyWindow ();
Application.Run ();
}
public MyWindow () : base ("MyWindow")
{
this.SetDefaultSize (400, 300);
this.DeleteEvent += new DeleteEventHandler (OnMyWindowDelete);
view = new TreeView ();
view.AppendColumn ("test", new CellRendererText (), "text", 0);
TreeStore store = new TreeStore (typeof (string));
string[] names = new string[] {"bob", "joe", "joseph", "frank"};
foreach (string name in names)
store.AppendValues (name);
view.Model = store;
filter = new TreeModelFilter (store, null);
filter.VisibleFunc = SearchFilterFunc;
VBox vbox = new VBox (false, 6);
search = new Entry ();
search.Activated += OnSearch;
Label l = new Label ("Search:");
l.Xalign = 0.0f;
vbox.PackStart (l, false, true, 0);
vbox.PackStart (search, false, true, 0);
vbox.PackStart (view, true, true, 0);
this.Add (vbox);
this.ShowAll ();
}
bool SearchFilterFunc (TreeModel model, TreeIter iter)
{
// no search term, show all
if (search.Text.Trim ().Length < 1)
return true;
string t = (string) model.GetValue (iter, 0);
return t.StartsWith (search.Text.Trim ());
}
void OnSearch (object sender, EventArgs a)
{
view.Model = filter;
filter.Refilter ();
}
void OnMyWindowDelete (object sender, DeleteEventArgs a)
{
Application.Quit ();
a.RetVal = true;
}
}
</code>
2005-08-08 06:28:14 +02:00
</example>
2005-06-16 20:56:42 +02:00
<since version= "Gtk# 2.4" />
2004-11-05 22:25:40 +01:00
</Docs>
<Base >
<BaseTypeName > GLib.Object</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > Gtk.TreeDragSource</InterfaceName>
</Interface>
<Interface >
2005-05-23 22:41:51 +02:00
<InterfaceName > Gtk.TreeModel</InterfaceName>
2004-11-05 22:25:40 +01:00
</Interface>
</Interfaces>
<Members >
<Member MemberName= "ConvertChildIterToIter" >
2004-11-08 15:58:12 +01:00
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter ConvertChildIterToIter (Gtk.TreeIter child_iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
2004-11-08 15:58:12 +01:00
<ReturnType > Gtk.TreeIter</ReturnType>
2004-11-05 22:25:40 +01:00
</ReturnValue>
<Parameters >
<Parameter Name= "child_iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Sets the filter's iterator to point to the row that corresponds to <paramref name= "child_iter" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "child_iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-11-08 15:58:12 +01:00
<returns > a <see cref= "T:Gtk.TreeIter" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Refilter" >
<MemberSignature Language= "C#" Value= "public void Refilter ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits <see cref= "E:Gtk.TreeModelFilter.RowChanged" /> for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.</summary>
2004-11-30 23:42:26 +01:00
<remarks > Added in GTK 2.4.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "ConvertChildPathToPath" >
<MemberSignature Language= "C#" Value= "public Gtk.TreePath ConvertChildPathToPath (Gtk.TreePath child_path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "child_path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Converts <paramref name= "child_path" /> to a path relative to this filter.</summary>
2004-11-05 22:25:40 +01:00
<param name= "child_path" > a <see cref= "T:Gtk.TreePath" /> </param>
2004-12-08 03:37:02 +01:00
<returns > a <see cref= "T:Gtk.TreePath" /> or <see langword= "null" /> .</returns>
2004-11-30 23:42:26 +01:00
<remarks >
2004-12-08 03:37:02 +01:00
<paramref name= "child_path" /> points to a path in the child model. The returned path will point to the
same row in the filtered model. If <paramref name= "child_path" /> isn't a valid path on the
child model, then <see langword= "null" /> is returned.
2004-11-30 23:42:26 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "ConvertIterToChildIter" >
2004-11-08 15:58:12 +01:00
<MemberSignature Language= "C#" Value= "public Gtk.TreeIter ConvertIterToChildIter (Gtk.TreeIter filter_iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
2004-11-08 15:58:12 +01:00
<ReturnType > Gtk.TreeIter</ReturnType>
2004-11-05 22:25:40 +01:00
</ReturnValue>
<Parameters >
<Parameter Name= "filter_iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Returns a new iterator that points to the row pointed to
2004-12-08 03:37:02 +01:00
by <paramref name= "filter_iter" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "filter_iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-11-08 15:58:12 +01:00
<returns > a <see cref= "T:Gtk.TreeIter" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "ClearCache" >
<MemberSignature Language= "C#" Value= "public void ClearCache ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > This function should almost never be called.</summary>
2004-12-08 03:37:02 +01:00
<remarks >
<para > This function clears the filter of any cached iterators that haven't been reffed with
<see cref= "M:Gtk.TreeModel.RefNode" /> . This might be useful if the child model
2004-11-30 23:42:26 +01:00
being filtered is static (and doesn't change often) and there has been
a lot of unreffed access to nodes. As a side effect of this function,
all unreffed iterators will be invalid.</para>
2004-12-08 03:37:02 +01:00
<para > Added in GTK 2.4.</para>
2004-11-30 23:42:26 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "ConvertPathToChildPath" >
<MemberSignature Language= "C#" Value= "public Gtk.TreePath ConvertPathToChildPath (Gtk.TreePath filter_path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "filter_path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Converts <paramref name= "filter_path" /> to a path on the child model of this filter.</summary>
2004-11-05 22:25:40 +01:00
<param name= "filter_path" > a <see cref= "T:Gtk.TreePath" /> </param>
<returns > a <see cref= "T:Gtk.TreePath" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks >
<paramref name= "filter_path" /> points to a location in this
2004-11-30 23:42:26 +01:00
filter. The returned path will point to the same location in the
2004-12-08 03:37:02 +01:00
model not being filtered. If <paramref name= "filter_path" />
2004-11-30 23:42:26 +01:00
does not point to a location in the child model,
2004-12-08 03:37:02 +01:00
<see langword= "null" /> is returned.
2004-11-30 23:42:26 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "UnrefNode" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void UnrefNode (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Decrements the reference count for the node at <paramref name= "iter" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetColumnType" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public GLib.GType GetColumnType (int index_);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "index_" Type= "System.Int32" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Gets the data type stored in the column at <paramref name= "index_" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "index_" > a <see cref= "T:System.Int32" /> </param>
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetValist" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void GetValist (Gtk.TreeIter iter, IntPtr var_args);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "var_args" Type= "System.IntPtr" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the values of child properties for the row pointed to by <paramref name= "iter" /> </summary>
2004-11-05 22:25:40 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-12-08 03:37:02 +01:00
<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 />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterNext" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterNext (ref Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "ref" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the next row to be filtered.</summary>
2004-11-05 22:25:40 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetStringFromIter" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public string GetStringFromIter (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Generates a string representation of the path of <paramref name= "iter" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<returns > a <see cref= "T:System.String" /> </returns>
2004-11-30 23:42:26 +01:00
<remarks > This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterParent" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterParent (out Gtk.TreeIter iter, Gtk.TreeIter child);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "child" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
<remarks > If <paramref name= "child" /> is at the toplevel, and does not have a parent, then <paramref name= "iter" /> is set to an invalid iterator and <see langword= "false" /> is returned. <paramref name= "child" /> will remain a valid node after this function has been called.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "EmitRowDeleted" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void EmitRowDeleted (Gtk.TreePath path);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits an <see cref= "E:Gtk.TreeModelFilter.RowDeleted" /> event
for <paramref name= "path" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "EmitRowInserted" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void EmitRowInserted (Gtk.TreePath path, Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits an <see cref= "E:Gtk.TreeModelFilter.RowInserted" /> event
for <paramref name= "path" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
2004-11-30 23:42:26 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> , points to the inserted row.</param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetPath" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public Gtk.TreePath GetPath (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the <see cref= "T:Gtk.TreePath" /> of <paramref name= "iter" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<returns > an object of type <see cref= "T:Gtk.TreePath" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetIter" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool GetIter (out Gtk.TreeIter iter, Gtk.TreePath path);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Sets <paramref name= "iter" /> to a valid iterator pointing to <paramref name= "path" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "path" > an object of type <see cref= "T:Gtk.TreePath" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterChildren" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterChildren (out Gtk.TreeIter iter, Gtk.TreeIter parent);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "parent" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
2005-05-23 22:41:51 +02:00
<param name= "parent" > To be added.</param>
<summary > Sets the TreeIter object pointed to by <paramref name= "iter" /> to point to the first child of this tree. </summary>
2004-11-30 23:42:26 +01:00
<returns > an object of type <see cref= "T:System.Boolean" /> , true if the iter has been set to the first child.</returns>
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterNChildren" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public int IterNChildren (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Returns the number of children that <paramref name= "iter" /> has.</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<returns > an object of type <see cref= "T:System.Int32" /> </returns>
<remarks > As a special case, if <paramref name= "iter" /> is <see langword= "null" /> , then the number of toplevel nodes is returned.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "RefNode" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void RefNode (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Lets the tree ref the node.</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<remarks >
<para > This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons.</para>
<para > This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view.</para>
<para > A model should be expected to be able to get an iter independent of its referenced state.</para>
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetIterFromString" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool GetIterFromString (out Gtk.TreeIter iter, string path_string);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "path_string" Type= "System.String" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the <see cref= "T:Gtk.TreeIter" /> at <paramref name= "path_string" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "path_string" > an object of type <see cref= "T:System.String" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
<remarks > Otherwise, <paramref name= "iter" /> is left invalid and <see langword= "false" /> is returned.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterHasChild" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterHasChild (Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Returns <see langword= "true" /> if <paramref name= "iter" /> has children, <see langword= "false" /> otherwise.</summary>
2004-11-30 23:42:26 +01:00
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "EmitRowsReordered" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public int EmitRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits an <see cref= "E:Gtk.TreeModelFilter.RowsReordered" /> event
for <paramref name= "path" /> .</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<returns > a <see cref= "T:System.Int32" /> </returns>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterNthChild" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterNthChild (out Gtk.TreeIter iter, Gtk.TreeIter parent, int n);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "parent" Type= "Gtk.TreeIter" />
<Parameter Name= "n" Type= "System.Int32" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
2005-05-23 22:41:51 +02:00
<param name= "parent" > To be added.</param>
2004-11-30 23:42:26 +01:00
<param name= "n" > an object of type <see cref= "T:System.Int32" /> </param>
2005-05-23 22:41:51 +02:00
<summary > Sets <paramref name= "iter" /> to be the child of the root node, using the given index.</summary>
2004-11-30 23:42:26 +01:00
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
<remarks > In this case, the nth root node is set.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetIterFirst" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool GetIterFirst (out Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the first iterator in the tree (the one at the path "0") and returns <see langword= "true" /> .</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
<remarks > Returns <see langword= "false" /> if the tree is empty.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void GetValue (Gtk.TreeIter iter, int column, ref GLib.Value value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "GLib.Value&" RefType= "ref" />
</Parameters>
<Docs >
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "column" > a <see cref= "T:System.Int32" /> </param>
2005-05-23 22:41:51 +02:00
<param name= "value" > To be added.</param>
<summary > Gets the value stored in column <paramref name= "column" /> of the row pointed to by <paramref name= "iter" /> .</summary>
2004-11-30 23:42:26 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "EmitRowHasChildToggled" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void EmitRowHasChildToggled (Gtk.TreePath path, Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits an <see cref= "E:Gtk.TreeModelFilter.RowHasChildToggled" /> event
for <paramref name= "path" /> .</summary>
2004-11-30 23:42:26 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> , points to the changed row</param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> , points to the changed row</param>
<remarks > This should be called by models after the child state of
a node changes.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Foreach" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void Foreach (Gtk.TreeModelForeachFunc func);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "func" Type= "Gtk.TreeModelForeachFunc" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Calls a function on each row of a tree.</summary>
2004-11-05 22:25:40 +01:00
<param name= "func" > a <see cref= "T:Gtk.TreeModelForeachFunc" /> </param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "EmitRowChanged" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void EmitRowChanged (Gtk.TreePath path, Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits an <see cref= "E:Gtk.TreeModelFilter.RowChanged" /> event
for <paramref name= "path" /> .</summary>
2004-11-30 23:42:26 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> , points to the changed row</param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> , points to the changed row</param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "OnRowsReordered" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter, out int new_order);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "new_order" Type= "System.Int32&" RefType= "out" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Emits the "rows_reordered" signal for this tree model.
</summary>
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> pointing to the tree node whose children have been reordered</param>
2004-12-08 03:37:02 +01:00
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> pointing to the tree node whose children have been reordered</param>
2004-11-30 23:42:26 +01:00
<param name= "new_order" > a <see cref= "T:System.Int32" /> , an array of integers containing the new indices of the children, i.e. the former child n is now at position new_order[n]. </param>
<remarks > This should be called by models when their rows have been reordered.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "OnRowChanged" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowChanged (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Emits the "row_changed" signal for this model.</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-12-08 03:37:02 +01:00
<remarks > This should be called by models when their rows have been reordered.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "OnRowDeleted" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowDeleted (Gtk.TreePath path);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits the <see cref= "E:Gtk.TreeModelFilter.RowDeleted" /> signal for this model.</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
2004-12-08 03:37:02 +01:00
<remarks > This should be called by models when their rows have been reordered.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "OnRowInserted" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowInserted (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits the <see cref= "E:Gtk.TreeModelFilter.RowInserted" /> signal for this model.</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-12-08 03:37:02 +01:00
<remarks > This should be called by models when a row has been inserted.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "OnRowHasChildToggled" >
<MemberSignature Language= "C#" Value= "protected virtual void OnRowHasChildToggled (Gtk.TreePath path, Gtk.TreeIter iter);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Emits the <see cref= "E:Gtk.TreeModelFilter.RowHasChildToggled" /> signal for this model.</summary>
2004-11-05 22:25:40 +01:00
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> </param>
<param name= "iter" > a <see cref= "T:Gtk.TreeIter" /> </param>
2004-12-08 03:37:02 +01:00
<remarks > This should be called by models when a row's child has been toggled on or off.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "DragDataDelete" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool DragDataDelete (Gtk.TreePath path);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > This method asks the source row for the dragged data to delete itself, because that data has been moved elsewhere.</summary>
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> , the path of the row that was dragged</param>
2004-11-05 22:25:40 +01:00
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-11-30 23:42:26 +01:00
<remarks > This method returns FALSE if the deletion fails because path no longer exists, or for some other model-specific reason.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "RowDraggable" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool RowDraggable (Gtk.TreePath path);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Checks to see whether a given row can be used as a source for a drag-and-drop operation.</summary>
<param name= "path" > a <see cref= "T:Gtk.TreePath" /> , the row being checked</param>
<returns > a <see cref= "T:System.Boolean" /> , TRUE if the row is draggable.</returns>
<remarks > If the object does not implement this method, the row is assumed to be draggable.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "DragDataGet" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool DragDataGet (Gtk.TreePath path, Gtk.SelectionData selection_data);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "path" Type= "Gtk.TreePath" />
<Parameter Name= "selection_data" Type= "Gtk.SelectionData" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Asks the <see cref= "M:Gtk.TreeDragSource" /> to fill in <paramref name= "selection_data" /> with a representation of the row at <paramref name= "path" /> . Should robustly handle a path no longer found in the model.</summary>
<param name= "path" > a <see cref= "M:Gtk.TreePath" /> </param>
<param name= "selection_data" > a <see cref= "M:Gtk.SelectionData" /> object to fill with data</param>
2004-12-08 03:37:02 +01:00
<returns > A see cref="T:System.Boolean" /> ; true if data of the required type was provided.</returns>
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterChildren" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterChildren (out Gtk.TreeIter iter);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
</Parameters>
<Docs >
2004-12-08 03:37:02 +01:00
<summary > Sets the TreeIter object pointed to by <paramref name= "iter" /> to point to the first child of this tree. </summary>
2004-11-30 23:42:26 +01:00
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> , true if the iter has been set to the first child.</returns>
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterNChildren" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public int IterNChildren ();" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Returns the number of children that <paramref name= "iter" /> has.</summary>
<returns > an object of type <see cref= "T:System.Int32" /> </returns>
<remarks > As a special case, if <paramref name= "iter" /> is <see langword= "null" /> , then the number of toplevel nodes is returned.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "IterNthChild" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public bool IterNthChild (out Gtk.TreeIter iter, int n);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter&" RefType= "out" />
<Parameter Name= "n" Type= "System.Int32" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Sets <paramref name= "iter" /> to be the child of the root node, using the given index.</summary>
<param name= "iter" > an object of type <see cref= "T:Gtk.TreeIter" /> </param>
<param name= "n" > an object of type <see cref= "T:System.Int32" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
<remarks > In this case, the nth root node is set.</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, bool value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Boolean" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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>
2004-11-05 22:25:40 +01:00
<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>
2004-11-30 23:42:26 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, double value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Double" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, int value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Int32" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.Int32" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, string value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.String" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.String" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, float value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Single" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.Single" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, uint value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.UInt32" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.UInt32" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "SetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public void SetValue (Gtk.TreeIter iter, int column, object value);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
<Parameter Name= "value" Type= "System.Object" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.UInt32" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GetValue" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public object GetValue (Gtk.TreeIter iter, int column);" />
2004-11-05 22:25:40 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Object</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "iter" Type= "Gtk.TreeIter" />
<Parameter Name= "column" Type= "System.Int32" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<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.Object" /> .</summary>
2004-11-05 22:25:40 +01:00
<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>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected TreeModelFilter (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Basic constructor.</summary>
2004-11-05 22:25:40 +01:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreeModelFilter (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Constructor. For internal use.</summary>
<param name= "raw" > a <see cref= "T:System.IntPtr" /> , pointer to the underlying C object.</param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public TreeModelFilter (Gtk.TreeModel child_model, Gtk.TreePath root);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "child_model" Type= "Gtk.TreeModel" />
<Parameter Name= "root" Type= "Gtk.TreePath" />
</Parameters>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Constructor</summary>
<param name= "child_model" > a <see cref= "T:Gtk.TreeModel" /> , the model this object is to filter</param>
2005-08-08 06:28:14 +02:00
<param name= "root" > a <see cref= "T:Gtk.TreePath" /> , the node to use as the model's root node, pass null to use the entire child tree model.</param>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-30 15:54:08 +01:00
<summary > The <see cref= "T:GLib.GType" /> of this object.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:GLib.GType" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "VirtualRoot" >
<MemberSignature Language= "C#" Value= "public Gtk.TreePath VirtualRoot { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > The virtual root (relative to the child model) for this object.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:Gtk.TreePath" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Property(Name="virtual_root")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= "VisibleColumn" >
<MemberSignature Language= "C#" Value= "public int VisibleColumn { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
2004-11-30 23:42:26 +01:00
<summary > The column of the model where this filter should look for visibility information.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:System.Int32" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Model" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeModel Model { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeModel</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Gets the <see cref= "T:Gtk.TreeModel" /> this filter is being applied to.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:Gtk.TreeModel" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Flags" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public Gtk.TreeModelFlags Flags { get; };" />
2004-11-05 22:25:40 +01:00
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeModelFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Flag values for this tree model; see <see cref= "T:Gtk.TreeModelFlags" /> for possible values.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:Gtk.TreeModelFlags" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "NColumns" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public int NColumns { get; };" />
2004-11-05 22:25:40 +01:00
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > The number of columns in the model.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:System.Int32" /> </value>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "RowsReordered" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public event Gtk.RowsReorderedHandler RowsReordered;" />
2004-11-05 22:25:40 +01:00
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.RowsReorderedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Event that happens when rows in the model change order.</summary>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Signal(CName="rows_reordered")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= "RowChanged" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public event Gtk.RowChangedHandler RowChanged;" />
2004-11-05 22:25:40 +01:00
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.RowChangedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Event that happens when a row in the model is changed.</summary>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Signal(CName="row_changed")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= "RowDeleted" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public event Gtk.RowDeletedHandler RowDeleted;" />
2004-11-05 22:25:40 +01:00
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.RowDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Event that happens when a row is deleted.</summary>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Signal(CName="row_deleted")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= "RowInserted" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public event Gtk.RowInsertedHandler RowInserted;" />
2004-11-05 22:25:40 +01:00
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.RowInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Event that happens when a row is inserted.</summary>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Signal(CName="row_inserted")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-11-05 22:25:40 +01:00
<Member MemberName= "RowHasChildToggled" >
2005-05-23 22:41:51 +02:00
<MemberSignature Language= "C#" Value= "public event Gtk.RowHasChildToggledHandler RowHasChildToggled;" />
2004-11-05 22:25:40 +01:00
<MemberType > Event</MemberType>
<ReturnValue >
<ReturnType > Gtk.RowHasChildToggledHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-11-30 23:42:26 +01:00
<summary > Event that happens when a row's child visibility is turned on or off.</summary>
2004-12-08 03:37:02 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Signal(CName="row_has_child_toggled")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2004-12-20 19:01:55 +01:00
<Member MemberName= "ChildModel" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeModel ChildModel { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.TreeModel</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > Child tree data model.</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:Gtk.TreeModel" /> </value>
2004-12-20 19:01:55 +01:00
<remarks />
</Docs>
2005-06-16 20:56:42 +02:00
<Attributes >
2005-05-23 22:41:51 +02:00
<Attribute >
<AttributeName > GLib.Property(Name="child_model")</AttributeName>
</Attribute>
2005-06-16 20:56:42 +02:00
</Attributes>
</Member>
2005-05-04 13:47:25 +02:00
<Member MemberName= "VisibleFunc" >
<MemberSignature Language= "C#" Value= "public Gtk.TreeModelFilterVisibleFunc VisibleFunc { set; };" />
<MemberType > Property</MemberType>
2005-04-01 19:52:35 +02:00
<ReturnValue >
2005-05-04 13:47:25 +02:00
<ReturnType > Gtk.TreeModelFilterVisibleFunc</ReturnType>
2005-04-01 19:52:35 +02:00
</ReturnValue>
<Docs >
2005-05-04 13:47:25 +02:00
<summary > The function used to determine whether or not a row should be visible</summary>
2005-05-23 22:41:51 +02:00
<value > a <see cref= "T:Gtk.TreeModelFilterVisibleFunc" /> </value>
2005-05-04 13:47:25 +02:00
<remarks />
2005-04-01 19:52:35 +02:00
</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>
2004-11-05 22:25:40 +01:00
</Members>
2005-08-08 06:28:14 +02:00
</Type>