GtkSharp/doc/en/Gda/DataModel.xml

673 lines
24 KiB
XML
Raw Normal View History

<Type Name="DataModel" FullName="Gda.DataModel">
<TypeSignature Language="C#" Value="public class DataModel : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gda-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToCommaSeparated">
<MemberSignature Language="C#" Value="public string ToCommaSeparated ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnTitle">
<MemberSignature Language="C#" Value="public string GetColumnTitle (int col);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="col" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowInserted">
<MemberSignature Language="C#" Value="public void RowInserted (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CancelEdit">
<MemberSignature Language="C#" Value="public bool CancelEdit ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Freeze">
<MemberSignature Language="C#" Value="public void Freeze ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EndEdit">
<MemberSignature Language="C#" Value="public bool EndEdit ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public void Changed ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetColumnPosition">
<MemberSignature Language="C#" Value="public int GetColumnPosition (string title);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="title">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowRemoved">
<MemberSignature Language="C#" Value="public void RowRemoved (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BeginEdit">
<MemberSignature Language="C#" Value="public bool BeginEdit ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRow">
<MemberSignature Language="C#" Value="public Gda.Row GetRow (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.Row</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetColumnTitle">
<MemberSignature Language="C#" Value="public void SetColumnTitle (int col, string title);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="col" Type="System.Int32" />
<Parameter Name="title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<param name="title">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DescribeColumn">
<MemberSignature Language="C#" Value="public Gda.FieldAttributes DescribeColumn (int col);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.FieldAttributes</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="col" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.FieldAttributes" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AppendRow">
<MemberSignature Language="C#" Value="public Gda.Row AppendRow (GLib.List values);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.Row</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="values" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="values">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UpdateRow">
<MemberSignature Language="C#" Value="public bool UpdateRow (Gda.Row row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="Gda.Row" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:Gda.Row" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemoveRow">
<MemberSignature Language="C#" Value="public bool RemoveRow (Gda.Row row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="Gda.Row" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:Gda.Row" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToXml">
<MemberSignature Language="C#" Value="public string ToXml (bool standalone);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="standalone" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="standalone">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Foreach">
<MemberSignature Language="C#" Value="public void Foreach (Gda.DataModelForeachFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="func" Type="Gda.DataModelForeachFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="func">a <see cref="T:Gda.DataModelForeachFunc" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Thaw">
<MemberSignature Language="C#" Value="public void Thaw ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowUpdated">
<MemberSignature Language="C#" Value="public void RowUpdated (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToTabSeparated">
<MemberSignature Language="C#" Value="public string ToTabSeparated ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetValueAt">
<MemberSignature Language="C#" Value="public Gda.Value GetValueAt (int col, int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="col" Type="System.Int32" />
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<param name="row">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.Value" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataModel (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NRows">
<MemberSignature Language="C#" Value="public int NRows { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CommandType">
<MemberSignature Language="C#" Value="public Gda.CommandType CommandType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gda.CommandType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gda.CommandType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CommandText">
<MemberSignature Language="C#" Value="public string CommandText { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NColumns">
<MemberSignature Language="C#" Value="public int NColumns { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DataChanged">
<MemberSignature Language="C#" Value="public event EventHandler DataChanged;" />
<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="RowInsertedEvent">
<MemberSignature Language="C#" Value="public event Gda.RowInsertedEventHandler RowInsertedEvent;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.RowInsertedEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowRemovedEvent">
<MemberSignature Language="C#" Value="public event Gda.RowRemovedEventHandler RowRemovedEvent;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.RowRemovedEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RowUpdatedEvent">
<MemberSignature Language="C#" Value="public event Gda.RowUpdatedEventHandler RowUpdatedEvent;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gda.RowUpdatedEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CancelEditing">
<MemberSignature Language="C#" Value="public event EventHandler CancelEditing;" />
<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="BeginEditing">
<MemberSignature Language="C#" Value="public event EventHandler BeginEditing;" />
<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="EndEditing">
<MemberSignature Language="C#" Value="public event EventHandler EndEditing;" />
<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="IsEditing">
<MemberSignature Language="C#" Value="public bool IsEditing { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsEditable">
<MemberSignature Language="C#" Value="public bool IsEditable { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</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>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gda.DataModel" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnDataChanged">
<MemberSignature Language="C#" Value="protected virtual void OnDataChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.DataChanged" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.DataChanged" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnRowInsertedEvent">
<MemberSignature Language="C#" Value="protected virtual void OnRowInsertedEvent (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.RowInsertedEvent" /> event.</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.RowInsertedEvent" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnRowRemovedEvent">
<MemberSignature Language="C#" Value="protected virtual void OnRowRemovedEvent (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.RowRemovedEvent" /> event.</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.RowRemovedEvent" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnRowUpdatedEvent">
<MemberSignature Language="C#" Value="protected virtual void OnRowUpdatedEvent (int row);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.RowUpdatedEvent" /> event.</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.RowUpdatedEvent" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnCancelEditing">
<MemberSignature Language="C#" Value="protected virtual void OnCancelEditing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.CancelEditing" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.CancelEditing" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginEditing">
<MemberSignature Language="C#" Value="protected virtual void OnBeginEditing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.BeginEditing" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.BeginEditing" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndEditing">
<MemberSignature Language="C#" Value="protected virtual void OnEndEditing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gda.DataModel.EndEditing" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gda.DataModel.EndEditing" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DataModel (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>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DataModel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>