efa9acf122
* en/*/*.xml: Updated all the docs to match the new API. All the nodes that no longer have a corresponding member in the type are now marked as deprecated. We'll have to wait for Miguel to implement this in the browser to stop displaying them. All gtype constructors have been regenerated, because of the 'uint' to 'GLib.Type' change. However, this patch will preserve (well, it was regenerated) the customized text for those GType constructors. A lot of the 'Finalized' methods are also now marked as deprecated, because the classes implement 'Dispose' instead. This is a possible place for customized scripts to generate template documentation, similar to the GType property and GType constructors. svn path=/trunk/gtk-sharp/; revision=12270
345 lines
No EOL
13 KiB
XML
345 lines
No EOL
13 KiB
XML
<Type Name="TreeSelection" FullName="Gtk.TreeSelection">
|
|
<TypeSignature Language="C#" Value="public class TreeSelection : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<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>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="GetSelected">
|
|
<MemberSignature Language="C#" Value="public bool GetSelected (out Gtk.TreeModel model, ref Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="model" Type="Gtk.TreeModel&" />
|
|
<Parameter Name="iter" Type="Gtk.TreeIter&" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="model">To be added: an object of type 'Gtk.TreeModel&'</param>
|
|
<param name="iter">To be added: an object of type 'Gtk.TreeIter&'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectPath">
|
|
<MemberSignature Language="C#" Value="public void SelectPath (Gtk.TreePath path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="Gtk.TreePath" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PathIsSelected">
|
|
<MemberSignature Language="C#" Value="public bool PathIsSelected (Gtk.TreePath path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="Gtk.TreePath" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UnselectIter">
|
|
<MemberSignature Language="C#" Value="public void UnselectIter (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IterIsSelected">
|
|
<MemberSignature Language="C#" Value="public bool IterIsSelected (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectAll">
|
|
<MemberSignature Language="C#" Value="public void SelectAll ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UnselectPath">
|
|
<MemberSignature Language="C#" Value="public void UnselectPath (Gtk.TreePath path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="path" Type="Gtk.TreePath" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectRange">
|
|
<MemberSignature Language="C#" Value="public void SelectRange (Gtk.TreePath start_path, Gtk.TreePath end_path);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="start_path" Type="Gtk.TreePath" />
|
|
<Parameter Name="end_path" Type="Gtk.TreePath" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="start_path">To be added: an object of type 'Gtk.TreePath'</param>
|
|
<param name="end_path">To be added: an object of type 'Gtk.TreePath'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UnselectAll">
|
|
<MemberSignature Language="C#" Value="public void UnselectAll ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectedForeach">
|
|
<MemberSignature Language="C#" Value="public void SelectedForeach (Gtk.TreeSelectionForeachFunc func);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="func" Type="Gtk.TreeSelectionForeachFunc" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="func">To be added: an object of type 'Gtk.TreeSelectionForeachFunc'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetSelectFunction">
|
|
<MemberSignature Language="C#" Value="public void SetSelectFunction (Gtk.TreeSelectionFunc func, IntPtr data, Gtk.DestroyNotify destroy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="func" Type="Gtk.TreeSelectionFunc" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="func">To be added: an object of type 'Gtk.TreeSelectionFunc'</param>
|
|
<param name="data">To be added: an object of type 'IntPtr'</param>
|
|
<param name="destroy">To be added: an object of type 'Gtk.DestroyNotify'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectIter">
|
|
<MemberSignature Language="C#" Value="public void SelectIter (Gtk.TreeIter iter);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iter" Type="Gtk.TreeIter" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor" Deprecated="true">
|
|
<MemberSignature Language="C#" Value="protected TreeSelection (uint gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of TreeSelection, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.TreeSelection" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public TreeSelection (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<returns>An instance of TreeSelection, wrapping the C object.</returns>
|
|
<remarks>
|
|
<para>This is an internal constructor, and should not be used by user code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected TreeSelection ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Gtk.TreeSelection'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The GLib Type for Gtk.TreeSelection</summary>
|
|
<returns>The GLib Type for the Gtk.TreeSelection class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Mode">
|
|
<MemberSignature Language="C#" Value="public Gtk.SelectionMode Mode { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SelectionMode</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.SelectionMode" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.SelectionMode'</param>
|
|
<returns>To be added: an object of type 'Gtk.SelectionMode'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UserData">
|
|
<MemberSignature Language="C#" Value="public IntPtr UserData { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'IntPtr'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TreeView">
|
|
<MemberSignature Language="C#" Value="public Gtk.TreeView TreeView { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.TreeView</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Gtk.TreeView'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Changed">
|
|
<MemberSignature Language="C#" Value="public event EventHandler Changed;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected TreeSelection (GLib.Type gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of TreeSelection, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.TreeSelection" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |