GtkSharp/doc/en/Gtk/TreeViewColumn.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* 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
2003-03-07 01:30:00 +00:00

567 lines
No EOL
22 KiB
XML

<Type Name="TreeViewColumn" FullName="Gtk.TreeViewColumn">
<TypeSignature Language="C#" Value="public class TreeViewColumn : Gtk.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>Gtk.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="SizingGetType" Deprecated="true">
<MemberSignature Language="C#" Value="public static uint SizingGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CellIsVisible">
<MemberSignature Language="C#" Value="public bool CellIsVisible ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PackEnd">
<MemberSignature Language="C#" Value="public void PackEnd (Gtk.CellRenderer cell, bool expand);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell">To be added: an object of type 'Gtk.CellRenderer'</param>
<param name="expand">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CellGetSize">
<MemberSignature Language="C#" Value="public void CellGetSize (Gdk.Rectangle cell_area, int x_offset, int y_offset, int width, int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_area" Type="Gdk.Rectangle" />
<Parameter Name="x_offset" Type="System.Int32" />
<Parameter Name="y_offset" Type="System.Int32" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell_area">To be added: an object of type 'Gdk.Rectangle'</param>
<param name="x_offset">To be added: an object of type 'int'</param>
<param name="y_offset">To be added: an object of type 'int'</param>
<param name="width">To be added: an object of type 'int'</param>
<param name="height">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CellSetCellData">
<MemberSignature Language="C#" Value="public void CellSetCellData (Gtk.TreeModel tree_model, Gtk.TreeIter iter, bool is_expander, bool is_expanded);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tree_model" Type="Gtk.TreeModel" />
<Parameter Name="iter" Type="Gtk.TreeIter" />
<Parameter Name="is_expander" Type="System.Boolean" />
<Parameter Name="is_expanded" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tree_model">To be added: an object of type 'Gtk.TreeModel'</param>
<param name="iter">To be added: an object of type 'Gtk.TreeIter'</param>
<param name="is_expander">To be added: an object of type 'bool'</param>
<param name="is_expanded">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<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="PackStart">
<MemberSignature Language="C#" Value="public void PackStart (Gtk.CellRenderer cell, bool expand);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell">To be added: an object of type 'Gtk.CellRenderer'</param>
<param name="expand">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Click">
<MemberSignature Language="C#" Value="public void Click ();" />
<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="SetCellDataFunc">
<MemberSignature Language="C#" Value="public void SetCellDataFunc (Gtk.CellRenderer cell_renderer, Gtk.TreeCellDataFunc func, IntPtr func_data, Gtk.DestroyNotify destroy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
<Parameter Name="func" Type="Gtk.TreeCellDataFunc" />
<Parameter Name="func_data" Type="System.IntPtr" />
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell_renderer">To be added: an object of type 'Gtk.CellRenderer'</param>
<param name="func">To be added: an object of type 'Gtk.TreeCellDataFunc'</param>
<param name="func_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="AddAttribute">
<MemberSignature Language="C#" Value="public void AddAttribute (Gtk.CellRenderer cell_renderer, string attribute, int column);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
<Parameter Name="attribute" Type="System.String" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell_renderer">To be added: an object of type 'Gtk.CellRenderer'</param>
<param name="attribute">To be added: an object of type 'string'</param>
<param name="column">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
<MemberSignature Language="C#" Value="public void ClearAttributes (Gtk.CellRenderer cell_renderer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cell_renderer">To be added: an object of type 'Gtk.CellRenderer'</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 TreeViewColumn (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 TreeViewColumn, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.TreeViewColumn" /> 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 TreeViewColumn (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 TreeViewColumn, 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="public TreeViewColumn ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeViewColumn'</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.TreeViewColumn</summary>
<returns>The GLib Type for the Gtk.TreeViewColumn class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SortColumnId">
<MemberSignature Language="C#" Value="public int SortColumnId { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Spacing">
<MemberSignature Language="C#" Value="public int Spacing { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CellRenderers">
<MemberSignature Language="C#" Value="public GLib.List CellRenderers { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.List'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Visible">
<MemberSignature Language="C#" Value="public bool Visible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Reorderable">
<MemberSignature Language="C#" Value="public bool Reorderable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MaxWidth">
<MemberSignature Language="C#" Value="public int MaxWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SortIndicator">
<MemberSignature Language="C#" Value="public bool SortIndicator { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Sizing">
<MemberSignature Language="C#" Value="public Gtk.TreeViewColumnSizing Sizing { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeViewColumnSizing</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.TreeViewColumnSizing" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.TreeViewColumnSizing'</param>
<returns>To be added: an object of type 'Gtk.TreeViewColumnSizing'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SortOrder">
<MemberSignature Language="C#" Value="public Gtk.SortType SortOrder { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.SortType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.SortType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.SortType'</param>
<returns>To be added: an object of type 'Gtk.SortType'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MinWidth">
<MemberSignature Language="C#" Value="public int MinWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public float Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'float'</param>
<returns>To be added: an object of type 'float'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Widget">
<MemberSignature Language="C#" Value="public Gtk.Widget Widget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clickable">
<MemberSignature Language="C#" Value="public bool Clickable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FixedWidth">
<MemberSignature Language="C#" Value="public int FixedWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Resizable">
<MemberSignature Language="C#" Value="public bool Resizable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clicked">
<MemberSignature Language="C#" Value="public event EventHandler Clicked;" />
<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 TreeViewColumn (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 TreeViewColumn, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.TreeViewColumn" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>