Ryujinx-GtkSharp/doc/en/Gda/Row.xml
Fawad Halim 9e9ba80d18 GDA documentation contributed by Nestor Salceda <wizito@gentelibre.org>
svn path=/trunk/gtk-sharp/; revision=33581
2004-09-08 14:56:46 +00:00

199 lines
6.5 KiB
XML

<Type Name="Row" FullName="Gda.Row">
<TypeSignature Language="C#" Value="public class Row : GLib.Opaque, IWrapper" 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>
<para>
A object which represents a row.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Deallocates all memory associated to the Gda.Row.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetValue">
<MemberSignature Language="C#" Value="public Gda.Value GetValue (int num);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gda.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>
Returns a <see cref="T:Gda.Value" /> stored in the Gda.Row.
</para>
</summary>
<param name="num">a <see cref="T:System.Int32" /> the field index.</param>
<returns>a <see cref="T:Gda.Value" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Row (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.Row" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Row (Gda.DataModel model, int count);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="model" Type="Gda.DataModel" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Row, which can hold count <see cref="T:Gda.Value" />.
</para>
</summary>
<param name="model">a <see cref="T:Gda.DataModel" /> this row belongs to.</param>
<param name="count">a <see cref="T:System.Int32" /> of <see cref="T:Gda.Value" /> in the new Gda.Row.</param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Row (Gda.DataModel model, GLib.List values);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="model" Type="Gda.DataModel" />
<Parameter Name="values" Type="GLib.List" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Row from a list of <see cref="T:Gda.Value" />
's</para>
</summary>
<param name="model">a <see cref="T:Gda.DataModel" /></param>
<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="Model">
<MemberSignature Language="C#" Value="public Gda.DataModel Model { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gda.DataModel</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the <see cref="T:Gda.DataModel" /> which Gda.Row belongs to.
</para>
</summary>
<returns>a <see cref="T:Gda.DataModel" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Number">
<MemberSignature Language="C#" Value="public int Number { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the number of the Gda.Row, that is, its position in its containing data model.
</para>
<para>
Sets the row number for the Gda.Row.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public int Length { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the number of columns that Gda.Row has.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the unique identifier for this row.
</para>
<para>
Sets the identifier for this row. Usually, this is called by providers.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>
<para>
This identifier is assigned by the different providers, to uniquely identify rows returned to clients. If there is no ID, this means that the row has not been created by a provider, or that it the provider cannot identify it (ie, modifications to it won't take place into the database).
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>