715 lines
No EOL
37 KiB
XML
715 lines
No EOL
37 KiB
XML
<Type Name="TreeModel" FullName="Gtk.TreeModel">
|
|
<TypeSignature Language="C#" Value="public abstract interface TreeModel;" Maintainer="John Luke" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<AssemblyCulture>neutral</AssemblyCulture>
|
|
<Attributes />
|
|
</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 tree interface used by <see cref="T:Gtk.TreeView" /></summary>
|
|
<remarks>
|
|
<para>
|
|
The <see cref="T:Gtk.TreeModel" /> interface defines a generic tree interface for use by the <see cref="T:Gtk.TreeView" /> widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a <see cref="T:Gtk.TreeView" /> widget.
|
|
</para>
|
|
<para>
|
|
The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes. The implementation of each individual model decides how and if changes are made.
|
|
</para>
|
|
<para>
|
|
In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided - the <see cref="T:Gtk.TreeStore" /> and the <see cref="T:Gtk.ListStore" />. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient.
|
|
</para>
|
|
<para>
|
|
Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the <see cref="T:Gtk.TreePath" /> and the <see cref="T:Gtk.TreeIter" />. Most of the interface consists of operations on a <see cref="T:Gtk.TreeIter" />.
|
|
</para>
|
|
<para>
|
|
A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. The <see cref="T:Gtk.TreePath" /> struct can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.
|
|
</para>
|
|
<para>
|
|
By contrast, a <see cref="T:Gtk.TreeIter" /> is a reference to a specific node on a specific model. It is a generic struct with an integer and three generic pointers. These are filled in by the model in a model-specific way. One can convert a path to an iterator by calling <see cref="M:Gtk.TreeModel.GetIter(Gtk.TreeIter,Gtk.TreePath)" />. These iterators are the primary way of accessing a model and are similar to the iterators used by <see cref="T:Gtk.TextBuffer" />. The model interface defines a set of operations using them for navigating the model.
|
|
</para>
|
|
<para>
|
|
It is expected that models fill in the iterator with private data. For example, the <see cref="T:Gtk.ListStore" /> model, which is internally a simple linked list, stores a list node in one of the pointers. The <see cref="T:Gtk.TreeModelSort" /> stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid iterators with a model.
|
|
</para>
|
|
<para>
|
|
The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model is unchanged (and does not emit a signal). Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the <see cref="T:Gtk.TreeStore" /> and <see cref="T:Gtk.ListStore" />). Although generally uninteresting, as one always has to allow for the case where iterators do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the <see cref="F:Gtk.TreeModelFlags.ItersPersist" /> flag was added to indicate this behavior.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Base />
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="IterNChildren">
|
|
<MemberSignature Language="C#" Value="public virtual int IterNChildren ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Returns the number of children that the <see cref="T:Gtk.TreeIter" /> has.</summary>
|
|
<returns>an object of type <see cref="T:System.Int32" /></returns>
|
|
<remarks>As a special case, if iter is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterChildren">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterChildren (out Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the TreeIter object pointed to by the iter param to point to the first child of this tree. </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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EmitRowChanged">
|
|
<MemberSignature Language="C#" Value="public virtual void EmitRowChanged (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>
|
|
<summary>Emits the <see cref="E:Gtk.TreeModel.RowChanged" /> signal.</summary>
|
|
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Foreach">
|
|
<MemberSignature Language="C#" Value="public virtual void Foreach (Gtk.TreeModelForeachFunc func);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="func" Type="Gtk.TreeModelForeachFunc" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Calls <paramref name="func" /> on each node in model in a depth-first fashion.</summary>
|
|
<param name="func">an object of type <see cref="T:Gtk.TreeModelForeachFunc" /></param>
|
|
<remarks>If func returns <see langword="true" />, then the tree ceases to be walked, and this method returns.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetIterFirst">
|
|
<MemberSignature Language="C#" Value="public virtual bool GetIterFirst (out Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EmitRowHasChildToggled">
|
|
<MemberSignature Language="C#" Value="public virtual void EmitRowHasChildToggled (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>
|
|
<summary>Emits the <see cref="E:Gtk.TreeModelSort.RowHasChildToggled" /> event.</summary>
|
|
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
|
|
<remarks>This should be called by models after the child state of a node changes.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPath">
|
|
<MemberSignature Language="C#" Value="public virtual Gtk.TreePath GetPath (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.TreePath</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterHasChild">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterHasChild (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Returns <see langword="true" /> if iter has children, <see langword="false" /> otherwise.</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>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RefNode">
|
|
<MemberSignature Language="C#" Value="public virtual void RefNode (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterNChildren">
|
|
<MemberSignature Language="C#" Value="public virtual int IterNChildren (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EmitRowInserted">
|
|
<MemberSignature Language="C#" Value="public virtual void EmitRowInserted (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>
|
|
<summary>Emits the <see cref="E:Gtk.TreeModel.RowInserted" /> event.</summary>
|
|
<param name="path">an object of type <see cref="T:Gtk.TreePath" />, path of the inserted row.</param>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" />, points to the inserted row.</param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EmitRowDeleted">
|
|
<MemberSignature Language="C#" Value="public virtual void EmitRowDeleted (Gtk.TreePath path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="Gtk.TreePath" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Emits the <see cref="E:Gtk.TreeModel.RowDeleted" /> event.</summary>
|
|
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
|
|
<remarks>This should be called by models after a row has been removed. The location pointed to by <paramref name="path" /> should be the location that the row previously was at. It may not be a valid location anymore.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetValist">
|
|
<MemberSignature Language="C#" Value="public virtual void GetValist (Gtk.TreeIter iter, IntPtr var_args);" />
|
|
<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>
|
|
<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">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">
|
|
<MemberSignature Language="C#" Value="public virtual void UnrefNode (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Lets the tree unref the node.</summary>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
|
|
<remarks>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. For more information on what this means, see <see cref="M:Gtk.TreeModel.RefNode()" />. Please note that nodes that are deleted are not unreferenced.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="NColumns">
|
|
<MemberSignature Language="C#" Value="public virtual int NColumns { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Returns the number of columns supported by the <see cref="T:Gtk.TreeModel" />.</summary>
|
|
<returns>an object of type <see cref="T:System.Int32" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Flags">
|
|
<MemberSignature Language="C#" Value="public virtual Gtk.TreeModelFlags Flags { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.TreeModelFlags</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Returns a set of flags supported by this interface.</summary>
|
|
<returns>an object of type <see cref="T:Gtk.TreeModelFlags" /></returns>
|
|
<remarks>The flags are a bitwise combination of <see cref="T:Gtk.TreeModelFlags" />. The flags supported should not change during the lifecycle of the <see cref="T:Gtk.TreeModel" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RowHasChildToggled">
|
|
<MemberSignature Language="C#" Value="public virtual event Gtk.RowHasChildToggledHandler RowHasChildToggled;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RowHasChildToggledHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emitted when a child of a row is toggled.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RowInserted">
|
|
<MemberSignature Language="C#" Value="public virtual event Gtk.RowInsertedHandler RowInserted;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RowInsertedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emitted when a row has been inserted into the model.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RowDeleted">
|
|
<MemberSignature Language="C#" Value="public virtual event Gtk.RowDeletedHandler RowDeleted;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RowDeletedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emitted when a row is deleted.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RowChanged">
|
|
<MemberSignature Language="C#" Value="public virtual event Gtk.RowChangedHandler RowChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RowChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emitted when a row has changed.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RowsReordered">
|
|
<MemberSignature Language="C#" Value="public virtual event Gtk.RowsReorderedHandler RowsReordered;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RowsReorderedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Emitted when a row is re-ordered</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterNthChild">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterNthChild (out Gtk.TreeIter iter, int n);" />
|
|
<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>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterNthChild">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterNthChild (out Gtk.TreeIter iter, Gtk.TreeIter parent, int n);" />
|
|
<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>
|
|
<summary>Sets <paramref name="iter" /> to be the child of <paramref name="parent" />, using the given index.</summary>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
|
|
<param name="parent">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>The first index is 0. If <paramref name="n" /> is too big, or <paramref name="parent" /> has no children, <paramref name="iter" /> is set to an invalid iterator and <see langword="false" /> is returned. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetIterFromString">
|
|
<MemberSignature Language="C#" Value="public virtual bool GetIterFromString (out Gtk.TreeIter iter, string path_string);" />
|
|
<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>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterChildren">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterChildren (out Gtk.TreeIter iter, Gtk.TreeIter parent);" />
|
|
<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>
|
|
<summary>Sets <paramref name="iter" /> to point to the first child of <paramref name="parent" />.</summary>
|
|
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
|
|
<param name="parent">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="parent" /> has no children, <see langword="false" /> is returned and <paramref name="iter" /> is set to be invalid. <paramref name="parent" /> will remain a valid node after this function has been called.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetIter">
|
|
<MemberSignature Language="C#" Value="public virtual bool GetIter (out Gtk.TreeIter iter, Gtk.TreePath path);" />
|
|
<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>
|
|
<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>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterParent">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterParent (out Gtk.TreeIter iter, Gtk.TreeIter child);" />
|
|
<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>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetStringFromIter">
|
|
<MemberSignature Language="C#" Value="public virtual string GetStringFromIter (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Generates a string representation of the path of <paramref name="iter" />.</summary>
|
|
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
|
|
<returns>a <see cref="T:System.String" /></returns>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, bool value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, double value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, int value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, string value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, float value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, uint value);" />
|
|
<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>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void SetValue (Gtk.TreeIter iter, int column, object value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetValue">
|
|
<MemberSignature Language="C#" Value="public virtual object GetValue (Gtk.TreeIter iter, int column);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
<Parameter Name="column" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetColumnType">
|
|
<MemberSignature Language="C#" Value="public virtual GLib.GType GetColumnType (int index_);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>GLib.GType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="index_" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Returns the type of the column at the given index.</summary>
|
|
<param name="index_">a <see cref="T:System.Int32" />, the column number.</param>
|
|
<returns>a <see cref="T:GLib.GType" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EmitRowsReordered">
|
|
<MemberSignature Language="C#" Value="public virtual int EmitRowsReordered (Gtk.TreePath path, Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="Gtk.TreePath" />
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sends out a <see cref="E:Gtk.TreeModel.RowsReordered" /> event.</summary>
|
|
<param name="path">a <see cref="T:Gtk.TreePath" /> that points to the row whose children have been reordered.</param>
|
|
<param name="iter">a <see cref="T:Gtk.TreeIter" />that points to the row whose children have been reordered.</param>
|
|
<returns>a <see cref="T:System.Int32" />, pointer to an array of integers with the new indices of the children.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetValue">
|
|
<MemberSignature Language="C#" Value="public virtual void GetValue (Gtk.TreeIter iter, int column, ref GLib.Value value);" />
|
|
<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>
|
|
<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 />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterNext">
|
|
<MemberSignature Language="C#" Value="public virtual bool IterNext (ref Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter&" RefType="ref" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets <paramref name="iter" /> to point to the node following it at the current level.</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>If there is no next iter, <see langword="false" /> is returned and iter is set to be invalid.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |