<Type Name="Table" FullName="Atk.Table"> <TypeSignature Language="C#" Value="public abstract interface Table;" Maintainer="auto" /> <AssemblyInfo> <AssemblyName>atk-sharp</AssemblyName> <AssemblyPublicKey> </AssemblyPublicKey> <AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyCulture>neutral</AssemblyCulture> <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>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> <Base /> <Interfaces> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> </Interfaces> <Attributes /> <Members> <Member MemberName="SetColumnHeader"> <MemberSignature Language="C#" Value="public virtual void SetColumnHeader (int column, Atk.Object header);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> <Parameter Name="header" Type="Atk.Object" /> </Parameters> <Docs> <summary>To be added</summary> <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> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="RemoveColumnSelection"> <MemberSignature Language="C#" Value="public virtual bool RemoveColumnSelection (int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <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 virtual bool RemoveRowSelection (int row);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetRowExtentAt"> <MemberSignature Language="C#" Value="public virtual int GetRowExtentAt (int row, int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="column">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="IsRowSelected"> <MemberSignature Language="C#" Value="public virtual bool IsRowSelected (int row);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="SetRowDescription"> <MemberSignature Language="C#" Value="public virtual void SetRowDescription (int row, string description);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="description">To be added: an object of type 'string'</param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="IsColumnSelected"> <MemberSignature Language="C#" Value="public virtual bool IsColumnSelected (int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetRowHeader"> <MemberSignature Language="C#" Value="public virtual Atk.Object GetRowHeader (int row);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <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 virtual int GetIndexAt (int row, int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="column">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="SetColumnDescription"> <MemberSignature Language="C#" Value="public virtual void SetColumnDescription (int column, string description);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> <Parameter Name="description" Type="System.String" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <param name="description">To be added: an object of type 'string'</param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="RefAt"> <MemberSignature Language="C#" Value="public virtual Atk.Object RefAt (int row, int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'Atk.Object'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetRowDescription"> <MemberSignature Language="C#" Value="public virtual string GetRowDescription (int row);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'string'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="SetRowHeader"> <MemberSignature Language="C#" Value="public virtual void SetRowHeader (int row, Atk.Object header);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="header" Type="Atk.Object" /> </Parameters> <Docs> <summary>To be added</summary> <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> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="AddColumnSelection"> <MemberSignature Language="C#" Value="public virtual bool AddColumnSelection (int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetColumnDescription"> <MemberSignature Language="C#" Value="public virtual string GetColumnDescription (int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'string'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="IsSelected"> <MemberSignature Language="C#" Value="public virtual bool IsSelected (int row, int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetColumnHeader"> <MemberSignature Language="C#" Value="public virtual Atk.Object GetColumnHeader (int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="column">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'Atk.Object'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetColumnExtentAt"> <MemberSignature Language="C#" Value="public virtual int GetColumnExtentAt (int row, int column);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <param name="column">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="AddRowSelection"> <MemberSignature Language="C#" Value="public virtual bool AddRowSelection (int row);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="row" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="row">To be added: an object of type 'int'</param> <returns>To be added: an object of type 'bool'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="NColumns"> <MemberSignature Language="C#" Value="public virtual int NColumns { 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="Caption"> <MemberSignature Language="C#" Value="public virtual Atk.Object Caption { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>To be added</summary> <param name="value">To be added: an object of type 'Atk.Object'</param> <returns>To be added: an object of type 'Atk.Object'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="Summary"> <MemberSignature Language="C#" Value="public virtual Atk.Object Summary { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>To be added</summary> <param name="value">To be added: an object of type 'Atk.Object'</param> <returns>To be added: an object of type 'Atk.Object'</returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="NRows"> <MemberSignature Language="C#" Value="public virtual int NRows { 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="RowDeleted"> <MemberSignature Language="C#" Value="public virtual event 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 virtual event 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="ModelChanged"> <MemberSignature Language="C#" Value="public virtual event 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="ColumnInserted"> <MemberSignature Language="C#" Value="public virtual event 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="RowReordered"> <MemberSignature Language="C#" Value="public virtual event 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="ColumnDeleted"> <MemberSignature Language="C#" Value="public virtual event 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="ColumnReordered"> <MemberSignature Language="C#" Value="public virtual event 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="GetRowAtIndex"> <MemberSignature Language="C#" Value="public virtual int GetRowAtIndex (int index_);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="index_" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="index_">a <see cref="T:System.Int32" /></param> <returns>a <see cref="T:System.Int32" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetColumnAtIndex"> <MemberSignature Language="C#" Value="public virtual int GetColumnAtIndex (int index_);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="index_" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="index_">a <see cref="T:System.Int32" /></param> <returns>a <see cref="T:System.Int32" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetSelectedRows"> <MemberSignature Language="C#" Value="public virtual int GetSelectedRows (out int selected);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="selected" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <summary>To be added</summary> <param name="selected">a <see cref="T:System.Int32&" /></param> <returns>a <see cref="T:System.Int32" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetSelectedColumns"> <MemberSignature Language="C#" Value="public virtual int GetSelectedColumns (out int selected);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="selected" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <summary>To be added</summary> <param name="selected">a <see cref="T:System.Int32&" /></param> <returns>a <see cref="T:System.Int32" /></returns> <remarks>To be added</remarks> </Docs> </Member> </Members> </Type>