GtkSharp/doc/en/Gtk/CellView.xml
Miguel de Icaza 9af713e759 Revert mistake
svn path=/trunk/gtk-sharp/; revision=49389
2005-09-03 04:11:38 +00:00

387 lines
17 KiB
XML

<Type Name="CellView" FullName="Gtk.CellView">
<TypeSignature Language="C#" Maintainer="auto" Value="public class CellView : Gtk.Widget, Gtk.CellLayout" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.6.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 widget displaying a single row of a <see cref="T:Gtk.TreeModel" /></summary>
<remarks>A <see cref="T:Gtk.CellView" /> displays a single row of a <see cref="T:Gtk.TreeModel" />, using cell renderers just like <see cref="T:Gtk.TreeView" />. <see cref="T:Gtk.CellView" /> does not support some of the more complex features of <see cref="T:Gtk.TreeView" />, like cell editing and drag and drop.</remarks>
<since version="Gtk# 2.4" />
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.CellLayout</InterfaceName>
</Interface>
</Interfaces>
<Members>
<Member MemberName="NewWithText">
<MemberSignature Language="C#" Value="public static Gtk.CellView NewWithText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="text" />.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSizeOfRow">
<MemberSignature Language="C#" Value="public bool GetSizeOfRow (Gtk.TreePath path, Gtk.Requisition requisition);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.TreePath" />
<Parameter Name="requisition" Type="Gtk.Requisition" />
</Parameters>
<Docs>
<summary>Sets <paramref name="requisition" /> to the size needed by the CellView to display the model row pointed to by <paramref name="path" />.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="requisition">a <see cref="T:Gtk.Requisition" />, return location for the size</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</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>
Note that <paramref name="cell" /> has already to be packed
into its view for this to function properly.
</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>Adds the <paramref name="cell" /> into the end of the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>
If <paramref name="expand" /> is <see langword="false" />, then the
<paramref name="cell" /> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="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 <paramref name="cell" /> into the beginning of the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>
If <paramref name="expand" /> is <see langword="false" />, then the
<paramref name="cell" /> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="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 attribute mapping to the list for this cell layout.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" />, parameter on <paramref name="cell" /> to be set from the value</param>
<param name="column">a <see cref="T:System.Int32" />, column of the model to get a value from.</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" /> 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.ComboBox" /> get its values from column 2.
</remarks>
</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>
<see cref="M:Gtk.CellView.SetAttributes" />
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks>
</remarks>
<summary>To be added.</summary>
</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 for this cell view.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CellView (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellView (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellView ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellView (Gdk.Pixbuf pixbuf);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererPixbuf" /> to it, and makes its show <paramref name="pixbuf" />.</summary>
<param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param>
<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.CellView" />.</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGdk">
<MemberSignature Language="C#" Value="public Gdk.Color BackgroundGdk { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The background color as a <see cref="T:Gdk.Color" /></summary>
<value>a <see cref="T:Gdk.Color" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="background_gdk")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Background">
<MemberSignature Language="C#" Value="public string Background { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Background color as a string.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="background")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Model">
<MemberSignature Language="C#" Value="public Gtk.TreeModel Model { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreeModel</ReturnType>
</ReturnValue>
<Docs>
<summary>Sets the model for the CellView.</summary>
<value>a <see cref="T:Gtk.TreeModel" /></value>
<remarks>If the CellView already has a model set, it will remove it before setting the new model. If <paramref name="model" /> is <see langword="null" />, then it will unset the old model.</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundColor">
<MemberSignature Language="C#" Value="public Gdk.Color BackgroundColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>The background color</summary>
<value>a <see cref="T:Gdk.Color" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="DisplayedRow">
<MemberSignature Language="C#" Value="public Gtk.TreePath DisplayedRow { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.TreePath</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The row of the model that is currently displayed</summary>
<value>a <see cref="T:Gtk.TreePath" />, or <see langword="null" /> to unset.</value>
<remarks>If the path is unset, then the contents of the cellview "stick" at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the <see cref="T:Gtk.CellView" /> becomes temporarily empty.</remarks>
</Docs>
</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>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="func" Type="Gtk.CellLayoutDataFunc" />
</Parameters>
<Docs>
<summary>Sets a data function to use for the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<remarks>
The data function
is used instead of the standard attributes mapping for setting the
column value, and should set the value of the cell renderer
as appropriate. <paramref name="func" /> may be <see langword="null" /> to remove an older one.
</remarks>
</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>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellView (string markup);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="markup" />.</summary>
<param name="markup">a <see cref="T:System.String" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="CellRenderers">
<MemberSignature Language="C#" Value="public GLib.List CellRenderers { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:GLib.List" /></value>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
</Members>
</Type>