GtkSharp/doc/en/Atk/Table.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

584 lines
26 KiB
XML

<Type Name="Table" FullName="Atk.Table">
<TypeSignature Language="C#" Maintainer="auto" Value="public interface Table : GLib.IWrapper" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract Table implements class GLib.IWrapper" />
<AssemblyInfo>
<AssemblyName>atk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>The interface implemented for UI components which contain tabular or row/column information.</summary>
<remarks>
<para>
<see cref="T:Atk.Table" /> should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an <see cref="T:Atk.Table" /> are typically referred to as "cells", and these cells are exposed by <see cref="T:Atk.Table" /> as child <see cref="T:Atk.Object" />s of the <see cref="T:Atk.Table" />. Both row/column and child-index-based access to these children is provided.
</para>
<para>
Children of <see cref="T:Atk.Table" /> are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient.
</para>
<para>
Since tables are often very complex, <see cref="T:Atk.Table" /> includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are <see cref="T:Atk.Object" />s which may implement other interfaces (<see cref="T:Atk.Text" />, <see cref="T:Atk.Image" />, etc.) as appropriate. <see cref="T:Atk.Table" /> summaries may themselves be (simplified) <see cref="T:Atk.Table" />s, etc.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="AddColumnSelection">
<MemberSignature Language="C#" Value="public bool AddColumnSelection (int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool AddColumnSelection(int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddRowSelection">
<MemberSignature Language="C#" Value="public bool AddRowSelection (int row);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool AddRowSelection(int32 row) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Caption">
<MemberSignature Language="C#" Value="public Atk.Object Caption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Atk.Object Caption" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'Atk.Object'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColumnDeleted">
<MemberSignature Language="C#" Value="public event Atk.ColumnDeletedHandler ColumnDeleted;" />
<MemberSignature Language="ILAsm" Value=".event class Atk.ColumnDeletedHandler ColumnDeleted" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Atk.ColumnDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColumnInserted">
<MemberSignature Language="C#" Value="public event Atk.ColumnInsertedHandler ColumnInserted;" />
<MemberSignature Language="ILAsm" Value=".event class Atk.ColumnInsertedHandler ColumnInserted" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Atk.ColumnInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColumnReordered">
<MemberSignature Language="C#" Value="public event EventHandler ColumnReordered;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler ColumnReordered" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnAtIndex">
<MemberSignature Language="C#" Value="public int GetColumnAtIndex (int index_);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetColumnAtIndex(int32 index_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index_">a <see cref="T:System.Int32" /></param>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnDescription">
<MemberSignature Language="C#" Value="public string GetColumnDescription (int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetColumnDescription(int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnExtentAt">
<MemberSignature Language="C#" Value="public int GetColumnExtentAt (int row, int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetColumnExtentAt(int32 row, int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnHeader">
<MemberSignature Language="C#" Value="public Atk.Object GetColumnHeader (int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Atk.Object GetColumnHeader(int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetIndexAt">
<MemberSignature Language="C#" Value="public int GetIndexAt (int row, int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetIndexAt(int32 row, int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRowAtIndex">
<MemberSignature Language="C#" Value="public int GetRowAtIndex (int index_);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetRowAtIndex(int32 index_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index_">a <see cref="T:System.Int32" /></param>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRowDescription">
<MemberSignature Language="C#" Value="public string GetRowDescription (int row);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetRowDescription(int32 row) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRowExtentAt">
<MemberSignature Language="C#" Value="public int GetRowExtentAt (int row, int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetRowExtentAt(int32 row, int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRowHeader">
<MemberSignature Language="C#" Value="public Atk.Object GetRowHeader (int row);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Atk.Object GetRowHeader(int32 row) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSelectedColumns">
<MemberSignature Language="C#" Value="public int GetSelectedColumns (out int selected);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetSelectedColumns(int32 selected) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="selected" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="selected">a <see cref="T:System.Int32&amp;" /></param>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSelectedRows">
<MemberSignature Language="C#" Value="public int GetSelectedRows (out int selected);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetSelectedRows(int32 selected) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="selected" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="selected">a <see cref="T:System.Int32&amp;" /></param>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsColumnSelected">
<MemberSignature Language="C#" Value="public bool IsColumnSelected (int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsColumnSelected(int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsRowSelected">
<MemberSignature Language="C#" Value="public bool IsRowSelected (int row);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsRowSelected(int32 row) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsSelected">
<MemberSignature Language="C#" Value="public bool IsSelected (int row, int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsSelected(int32 row, int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ModelChanged">
<MemberSignature Language="C#" Value="public event EventHandler ModelChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler ModelChanged" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NColumns">
<MemberSignature Language="C#" Value="public int NColumns { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 NColumns" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NRows">
<MemberSignature Language="C#" Value="public int NRows { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 NRows" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RefAt">
<MemberSignature Language="C#" Value="public Atk.Object RefAt (int row, int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Atk.Object RefAt(int32 row, int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemoveColumnSelection">
<MemberSignature Language="C#" Value="public bool RemoveColumnSelection (int column);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool RemoveColumnSelection(int32 column) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemoveRowSelection">
<MemberSignature Language="C#" Value="public bool RemoveRowSelection (int row);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool RemoveRowSelection(int32 row) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowDeleted">
<MemberSignature Language="C#" Value="public event Atk.RowDeletedHandler RowDeleted;" />
<MemberSignature Language="ILAsm" Value=".event class Atk.RowDeletedHandler RowDeleted" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Atk.RowDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowInserted">
<MemberSignature Language="C#" Value="public event Atk.RowInsertedHandler RowInserted;" />
<MemberSignature Language="ILAsm" Value=".event class Atk.RowInsertedHandler RowInserted" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Atk.RowInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowReordered">
<MemberSignature Language="C#" Value="public event EventHandler RowReordered;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler RowReordered" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetColumnDescription">
<MemberSignature Language="C#" Value="public void SetColumnDescription (int column, string description);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetColumnDescription(int32 column, string description) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<param name="description">To be added: an object of type 'string'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetColumnHeader">
<MemberSignature Language="C#" Value="public void SetColumnHeader (int column, Atk.Object header);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetColumnHeader(int32 column, class Atk.Object header) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="column" Type="System.Int32" />
<Parameter Name="header" Type="Atk.Object" />
</Parameters>
<Docs>
<param name="column">To be added: an object of type 'int'</param>
<param name="header">To be added: an object of type 'Atk.Object'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetRowDescription">
<MemberSignature Language="C#" Value="public void SetRowDescription (int row, string description);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetRowDescription(int32 row, string description) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="description">To be added: an object of type 'string'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetRowHeader">
<MemberSignature Language="C#" Value="public void SetRowHeader (int row, Atk.Object header);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetRowHeader(int32 row, class Atk.Object header) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
<Parameter Name="header" Type="Atk.Object" />
</Parameters>
<Docs>
<param name="row">To be added: an object of type 'int'</param>
<param name="header">To be added: an object of type 'Atk.Object'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Summary">
<MemberSignature Language="C#" Value="public Atk.Object Summary { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Atk.Object Summary" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'Atk.Object'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>