GtkSharp/doc/en/Gtk/TreeViewColumn.xml

821 lines
33 KiB
XML
Raw Normal View History

<Type Name="TreeViewColumn" FullName="Gtk.TreeViewColumn">
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class TreeViewColumn : Gtk.Object, Gtk.CellLayout" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.12.0.0</AssemblyVersion>
</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>A visible column in a <see cref="T:Gtk.TreeView" /> widget.</summary>
<remarks>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.CellLayout</InterfaceName>
</Interface>
</Interfaces>
<Members>
<Member MemberName="CellIsVisible">
<MemberSignature Language="C#" Value="public bool CellIsVisible ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether to display the column.</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>
</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>Sets the cell renderer based on the <paramref name="tree_model" /> and <paramref name="iter" />.</summary>
<param name="tree_model">an object of type <see cref="T:Gtk.TreeModel" /></param>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<param name="is_expander">an object of type <see cref="T:System.Boolean" /></param>
<param name="is_expanded">an object of type <see cref="T:System.Boolean" /></param>
<remarks>That is, for every attribute mapping in <see cref="T:Gtk.TreeViewColumn" />, it will get a value from the set column on the <paramref name="iter" />, and use that value to set the attribute on the cell renderer. This is used primarily by the <see cref="T:Gtk.TreeView" />.</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>Emit the clicked event on the column.</summary>
<remarks>
</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>Sets the <see cref="T:Gtk.TreeViewColumnFunc" /> to use for the column.</summary>
<param name="cell_renderer">an object of type <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">an object of type <see cref="T:Gtk.TreeCellDataFunc" /></param>
<param name="func_data">an object of type <see cref="T:System.IntPtr" /></param>
<param name="destroy">an object of type <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the <see cref="T:Gtk.TreeViewColumn" /><paramref name="cell_renderer" /> as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.</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>
<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>Creates a new <see cref="T:Gtk.TreeViewColumn" /> object.</summary>
<remarks>
</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>
</Parameters>
<Docs>
<summary>The column that the model sorts on when this column is selected for sorting.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</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>
</Parameters>
<Docs>
<summary>The number of pixels to place between <see cref="T:Gtk.CellRenderer" />s packed into the column.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("spacing")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Visible">
<MemberSignature Language="C#" Value="public bool Visible { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The visibility of the <see cref="T:Gtk.TreeViewColumn" />.</summary>
<value>an object of type <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("visible")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Reorderable">
<MemberSignature Language="C#" Value="public bool Reorderable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the column can be reordered by the end user dragging the header.</summary>
<value>an object of type <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("reorderable")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="MaxWidth">
<MemberSignature Language="C#" Value="public int MaxWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Maximum allowed width of the column.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("max-width")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Current width of the column.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("width")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="SortIndicator">
<MemberSignature Language="C#" Value="public bool SortIndicator { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether to show a sort indicator.</summary>
<value>an object of type <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("sort-indicator")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Sizing">
<MemberSignature Language="C#" Value="public Gtk.TreeViewColumnSizing Sizing { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeViewColumnSizing</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Resize mode of the column.</summary>
<value>an object of type <see cref="T:Gtk.TreeViewColumnSizing" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("sizing")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="SortOrder">
<MemberSignature Language="C#" Value="public Gtk.SortType SortOrder { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.SortType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sort direction the sort indicator should indicate.</summary>
<value>an object of type <see cref="T:Gtk.SortType" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("sort-order")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="MinWidth">
<MemberSignature Language="C#" Value="public int MinWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Minimum allowed width of the column.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("min-width")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public float Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>X Alignment of the column header text or widget.</summary>
<value>an object of type <see cref="T:System.Float" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("alignment")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Title to appear in column header.</summary>
<value>an object of type <see cref="T:System.String" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("title")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Widget">
<MemberSignature Language="C#" Value="public Gtk.Widget Widget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Widget to put in column header button instead of column title.</summary>
<value>an object of type <see cref="T:Gtk.Widget" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("widget")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Clickable">
<MemberSignature Language="C#" Value="public bool Clickable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the header can be clicked.</summary>
<value>an object of type <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("clickable")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="FixedWidth">
<MemberSignature Language="C#" Value="public int FixedWidth { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Current fixed width of the column.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("fixed-width")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Resizable">
<MemberSignature Language="C#" Value="public bool Resizable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether column is user-resizable.</summary>
<value>an object of type <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("resizable")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Clicked">
<MemberSignature Language="C#" Value="public event EventHandler Clicked;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when the column is clicked.</summary>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal("clicked")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="SetCellDataFunc">
<MemberSignature Language="C#" Value="public void SetCellDataFunc (Gtk.CellRenderer cell, Gtk.CellLayoutDataFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="func" Type="Gtk.CellLayoutDataFunc" />
</Parameters>
<Docs>
<summary>Sets the <see cref="T:Gtk.CellLayoutDataFunc" /> to use for a renderer.</summary>
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
<remarks>This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the <see cref="T:Gtk.TreeViewColumn" /><paramref name="cell" /> as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="FocusCell">
<MemberSignature Language="C#" Value="public void FocusCell (Gtk.CellRenderer cell);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
<summary>Sets the current keyboard focus to be at <paramref name="cell" />, if the column contains 2 or more editable and activatable cells.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TreeViewColumn (string title, Gtk.CellRenderer cell, Array attrs);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="title" Type="System.String" />
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="attrs" Type="System.Array" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.TreeViewColumn" /></summary>
<param name="title">a <see cref="T:System.String" /></param>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attrs">a <see cref="T:System.Array" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TreeViewColumn (string title, Gtk.CellRenderer cell, object[] attrs);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="title" Type="System.String" />
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="attrs" Type="System.Object[]">
<Attributes>
<Attribute>
<AttributeName>System.ParamArray</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.TreeViewColumn" /></summary>
<param name="title">a <see cref="T:System.String" /></param>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attrs">a <see cref="T:System.Object[]" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="CellGetPosition">
<MemberSignature Language="C#" Value="public bool CellGetPosition (Gtk.CellRenderer cell_renderer, out int start_pos, out int width);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
<Parameter Name="start_pos" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Obtains the horizontal position and size of a cell in a column.</summary>
<param name="cell_renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="start_pos">a <see cref="T:System.Int32&amp;" /></param>
<param name="width">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>If the cell is not found in the column, <paramref name="start_pos" /> and <paramref name="width" /> are not changed and <see langword="false" /> is returned.</remarks>
</Docs>
</Member>
<Member MemberName="CellGetSize">
<MemberSignature Language="C#" Value="public void CellGetSize (Gdk.Rectangle cell_area, out int x_offset, out int y_offset, out int width, out 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&amp;" RefType="out" />
<Parameter Name="y_offset" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Obtains the width and height needed to render the column.</summary>
<param name="cell_area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="x_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="y_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="width">a <see cref="T:System.Int32&amp;" /></param>
<param name="height">a <see cref="T:System.Int32&amp;" /></param>
<remarks>This is used primarily by the <see cref="T:Gtk.TreeView" />.</remarks>
</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>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.TreeViewColumn" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnClicked">
<MemberSignature Language="C#" Value="protected virtual void OnClicked ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.TreeViewColumn.Clicked" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.TreeViewColumn.Clicked" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TreeViewColumn (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="CellRenderers">
<MemberSignature Language="C#" Value="public Gtk.CellRenderer[] CellRenderers { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellRenderer[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
2004-03-05 Hector Gomez M <hectorgm@ciencias.unam.mx> * en/* : Created TODO files for every namespace (except *Sharp namespaces). 2004-02-29 Hector Gomez M <hectorgm@ciencias.unam.mx> * Changelog: Corrected bogus year dates. * en/Gtk/TODO: updated TODO list. * en/Atk/EditableText.xml * en/Atk/Free.xml * en/Atk/NoOpObject.xml * en/Atk/Object.xml * en/Atk/StateSet.xml * en/Gnome/CanvasProxy.xml * en/Gnome/CanvasRichText.xml * en/Gnome/Config.xml * en/Gnome/DateEdit.xml * en/Gnome/Entry.xml * en/Gnome/FileEntry.xml * en/Gnome/Font.xml * en/Gnome/FontFamily.xml * en/Gnome/GlyphList.xml * en/Gnome/IconList.xml * en/Gnome/IconTheme.xml * en/Gnome/Pgl.xml * en/Gtk/Combo.xml * en/Gtk/ListStore.xml * en/Gtk/RadioMenuItem.xml * en/Gtk/StockItem.xml * en/Gtk/StockManager.xml * en/Gtk/TextBuffer.xml * en/Gtk/TextIter.xml * en/Gtk/TextView.xml * en/Gtk/TooltipsData.xml * en/Gtk/TreeModelSort.xml * en/Gtk/TreeStore.xml * en/Gtk/TreeView.xml * en/Gtk/Widget.xml * en/Gtk/Window.xml: Restored and/or removed various nodes. * en/Gtk/Accel.xml: Removed deprecated GroupsFromObject Method. * en/Gtk/Application: Removed deprecated CurrentEvent Property. * en/Gtk/Container.xml: FocusChain and Children update. * en/Gtk/DeleteEventArgs.xml: Removed deprecated Event Property. * en/Gtk/DestroyEventArgs.xml: Removed deprecated Event Property. * en/Gtk/MenuItem.xml: ToggleSizeRequest update. * en/Gtk/IMContext.xml: Removed deprecated GetPreeditString Method. * en/Gtk/IMContextSimple.xml: Removed deprecated AddTable Method. * en/Gtk/Init.xml: Removed deprecated AbiCheck Method * en/Gtk/MapEventArgs.xml: Removed deprecated Event Property. * en/Gtk/MenuItem.xml: Removed deprecated ToggleSizeRequest Method. * en/Gtk/NoExposeEventArgs.xml: Removed deprecated Event Property. * en/Gtk/SelectionData.xml: Removed deprecated Set Method. * en/Gtk/TextChildAnchor.xml: Widget update. * en/Gtk/TreeIter.xml: Stamp update. * en/Gtk/TreeModel.xml: EmitRowsReordered update. * en/Gtk/TreeRowReference.xml: Removed deprecated Reordered Method. * en/Gtk/TreeSelection.xml: Removed deprecated GetSelectedRows Method. * en/Gtk/TreeViewColumn.xml: Removed deprecated CellRenders Property. * en/Gtk/UnmapEventArgs.xml: Removed deprecated Event Property. svn path=/trunk/gtk-sharp/; revision=23736
2004-03-05 13:40:13 +00:00
<summary>Returns a list of all the <see cref="T:Gtk.CellRenderer" />s in the column, in no particular order.</summary>
<value>An array of <see cref="T:Gtk.CellRenderer[]" />s.</value>
2004-03-05 Hector Gomez M <hectorgm@ciencias.unam.mx> * en/* : Created TODO files for every namespace (except *Sharp namespaces). 2004-02-29 Hector Gomez M <hectorgm@ciencias.unam.mx> * Changelog: Corrected bogus year dates. * en/Gtk/TODO: updated TODO list. * en/Atk/EditableText.xml * en/Atk/Free.xml * en/Atk/NoOpObject.xml * en/Atk/Object.xml * en/Atk/StateSet.xml * en/Gnome/CanvasProxy.xml * en/Gnome/CanvasRichText.xml * en/Gnome/Config.xml * en/Gnome/DateEdit.xml * en/Gnome/Entry.xml * en/Gnome/FileEntry.xml * en/Gnome/Font.xml * en/Gnome/FontFamily.xml * en/Gnome/GlyphList.xml * en/Gnome/IconList.xml * en/Gnome/IconTheme.xml * en/Gnome/Pgl.xml * en/Gtk/Combo.xml * en/Gtk/ListStore.xml * en/Gtk/RadioMenuItem.xml * en/Gtk/StockItem.xml * en/Gtk/StockManager.xml * en/Gtk/TextBuffer.xml * en/Gtk/TextIter.xml * en/Gtk/TextView.xml * en/Gtk/TooltipsData.xml * en/Gtk/TreeModelSort.xml * en/Gtk/TreeStore.xml * en/Gtk/TreeView.xml * en/Gtk/Widget.xml * en/Gtk/Window.xml: Restored and/or removed various nodes. * en/Gtk/Accel.xml: Removed deprecated GroupsFromObject Method. * en/Gtk/Application: Removed deprecated CurrentEvent Property. * en/Gtk/Container.xml: FocusChain and Children update. * en/Gtk/DeleteEventArgs.xml: Removed deprecated Event Property. * en/Gtk/DestroyEventArgs.xml: Removed deprecated Event Property. * en/Gtk/MenuItem.xml: ToggleSizeRequest update. * en/Gtk/IMContext.xml: Removed deprecated GetPreeditString Method. * en/Gtk/IMContextSimple.xml: Removed deprecated AddTable Method. * en/Gtk/Init.xml: Removed deprecated AbiCheck Method * en/Gtk/MapEventArgs.xml: Removed deprecated Event Property. * en/Gtk/MenuItem.xml: Removed deprecated ToggleSizeRequest Method. * en/Gtk/NoExposeEventArgs.xml: Removed deprecated Event Property. * en/Gtk/SelectionData.xml: Removed deprecated Set Method. * en/Gtk/TextChildAnchor.xml: Widget update. * en/Gtk/TreeIter.xml: Stamp update. * en/Gtk/TreeModel.xml: EmitRowsReordered update. * en/Gtk/TreeRowReference.xml: Removed deprecated Reordered Method. * en/Gtk/TreeSelection.xml: Removed deprecated GetSelectedRows Method. * en/Gtk/TreeViewColumn.xml: Removed deprecated CellRenders Property. * en/Gtk/UnmapEventArgs.xml: Removed deprecated Event Property. svn path=/trunk/gtk-sharp/; revision=23736
2004-03-05 13:40:13 +00:00
<remarks />
</Docs>
</Member>
<Member MemberName="Expand">
<MemberSignature Language="C#" Value="public bool Expand { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Whether this column gets share of extra width allocated to the widget.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("expand")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Reorder">
<MemberSignature Language="C#" Value="public void Reorder (Gtk.CellRenderer cell, int position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Re-inserts <paramref name="cell" /> at <paramref name="position" />.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<remarks>The given cell must already be packed into the layout for this method to work properly.</remarks>
<since version="Gtk# 2.4" />
</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>Adds the <paramref name="cell" /> to end of the column.</summary>
<param name="cell">an object of type <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">an object of type <see cref="T:System.Boolean" /></param>
<remarks>If expand is <see langword="false" />, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is <see langword="true" />.</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>Packs the cell into the beginning of the column.</summary>
<param name="cell">an object of type <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">an object of type <see cref="T:System.Boolean" /></param>
<remarks>If expand is <see langword="false" />, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is <see langword="true" />.</remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
<MemberSignature Language="C#" Value="public void AddAttribute (Gtk.CellRenderer cell, string attribute, int column);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="attribute" Type="System.String" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Adds an <paramref name="attribute" /> mapping to the list in <see cref="T:Gtk.TreeViewColumn" />.</summary>
<param name="cell">an object of type <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">an object of type <see cref="T:System.String" /></param>
<param name="column">an object of type <see cref="T:System.Int32" /></param>
<remarks>The <paramref name="column" /> is the column of the model to get a value from, and the <paramref name="attribute" /> is the parameter on <paramref name="cell_renderer" /> to be set from the value. So for example if column 2 of the model contains strings, you could have the "text" attribute of a <see cref="T:Gtk.CellRendererText" /> get its values from column 2.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="ClearAttributes">
<MemberSignature Language="C#" Value="public void ClearAttributes (Gtk.CellRenderer cell);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
<summary>Clears all existing attributes.</summary>
<param name="cell">an object of type <see cref="T:Gtk.CellRenderer" /></param>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Unsets all the mappings on all renderers on the <see cref="T:Gtk.TreeViewColumn" />.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">
<MemberSignature Language="C#" Value="public void SetCellDataFunc (Gtk.CellRenderer cell_renderer, Gtk.NodeCellDataFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
<Parameter Name="func" Type="Gtk.NodeCellDataFunc" />
</Parameters>
<Docs>
<summary>Set the data func used to set cell renderer attributes.</summary>
<param name="cell_renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.NodeCellDataFunc" /></param>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="SetAttributes">
<MemberSignature Language="C#" Value="public void SetAttributes (Gtk.CellRenderer cell, object[] attrs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="attrs" Type="System.Object[]">
<Attributes>
<Attribute>
<AttributeName>System.ParamArray</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<summary>Sets the attribute to model column bindings for a renderer.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attrs">a <see cref="T:System.Object" /></param>
<remarks>The <paramref name="attrs" /> array should consist of pairs of attribute name and column index.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">
<MemberSignature Language="C#" Value="public void SetCellDataFunc (Gtk.CellRenderer cell_renderer, Gtk.TreeCellDataFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell_renderer" Type="Gtk.CellRenderer" />
<Parameter Name="func" Type="Gtk.TreeCellDataFunc" />
</Parameters>
<Docs>
<summary>Sets the <see cref="T:Gtk.CellLayoutDataFunc" /> to use for a renderer.</summary>
<param name="cell_renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.TreeCellDataFunc" /></param>
<remarks>This function is used instead of the standard attributes mapping for setting the column value, and should set the value of the <see cref="T:Gtk.TreeViewColumn" /><paramref name="cell_renderer" /> as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.</remarks>
</Docs>
</Member>
<Member MemberName="QueueResize">
<MemberSignature Language="C#" Value="public void QueueResize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Flags the column and its cell renderers for size renegotiation.</summary>
<remarks />
<since version="Gtk# 2.8" />
</Docs>
</Member>
</Members>
</Type>