ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

GDA documentation contributed by Nestor Salceda <wizito@gentelibre.org>

Browse source 
svn path=/trunk/gtk-sharp/; revision=33581
This commit is contained in:
Fawad Halim 2004-09-08 14:56:46 +00:00
parent 59ee2ce62a
commit 9e9ba80d18
13 changed files with 612 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
doc/en/Gda/Command.xml
View file

@ -10,8 +10,16 @@
</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>
<summary>
<para>
The Gda.Command structure holds data needed to issue a command to the providers.
</para>
</summary>
<remarks>
<para>
One interesting thing about Gda.Command's is that they can be reused over and over. That is, applications don't need to create a command every time they want to run something on the connected database. Moreover, the ability to create command strings with placeholders allows the use of parameters to specify the values for those placeholders.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,7 +35,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Frees the resources allocated by Gda.Command's constructor.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -39,7 +51,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the <see cref="T:Gda.CommandType" /> of command.
</para>
<para>
Sets the <see cref="T:Gda.CommandType" /> of command.
</para>
</summary>
<returns>a <see cref="T:Gda.CommandType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -52,7 +71,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the <see cref="T:Gda.CommandOptions" /> of cmd.
</para>
<para>
Sets the <see cref="T:Gda.CommandOptions" /> of cmd.
</para>
</summary>
<returns>a <see cref="T:Gda.CommandOptions" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -65,7 +91,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the command text.
</para>
<para>
Sets the command text.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -78,7 +111,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the <see cref="T:Gda.Transaction" /> associated with the Command.
</para>
<para>
Sets the <see cref="T:Gda.Transaction" /> associated with the Command.
</para>
</summary>
<returns>a <see cref="T:Gda.Transaction" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -107,7 +147,11 @@
<Parameter Name="options" Type="Gda.CommandOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Command from the parameters.
</para>
</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="type">a <see cref="T:System.Int32" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>

174
doc/en/Gda/DataModel.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Basic data model class.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -46,7 +50,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Converts the given model into a comma-separated series of rows.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -61,7 +69,11 @@
<Parameter Name="col" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Returns the title for the given column in a data model object.
</para>
</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
@ -77,7 +89,11 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Emits the 'row_inserted' and 'changed' signals on model.
</para>
</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
@ -103,7 +119,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Disables notifications of changes on the given data model. To re-enable notifications again, you should call the <see cref="M:Gda.DataModel.Thaw" /> method.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -128,7 +148,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Notifies listeners of the given data model object of changes in the underlying data. Listeners usually will connect themselves to the "changed" signal in the <see cref="T:Gda.DataModel" /> class, thus being notified of any new data being appended or removed from the data model.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -142,9 +166,13 @@
<Parameter Name="title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the position of a column on the data model, based on the column's title.
</para>
</summary>
<param name="title">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<returns>a <see cref="T:System.Int32" /> the position of the column in the data model, or -1 if the column could not be found.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -158,7 +186,11 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Emits the 'row_removed' and 'changed' signal on model.
</para>
</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
@ -186,7 +218,11 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Retrieves a given row from a data model.
</para>
</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
@ -203,7 +239,11 @@
<Parameter Name="title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Sets the title of the given col in data model object.
</para>
</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>
@ -219,9 +259,9 @@
<Parameter Name="col" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Queries the underlying data model implementation for a description of a given column. That description is returned in the form of a <see cref="T:Gda.FieldAttributes" /> structure, which contains all the information about the given column in the data model.</summary>
<param name="col">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.FieldAttributes" /></returns>
<returns>a <see cref="T:Gda.FieldAttributes" /> which contains all information about the given column in the data model.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -235,7 +275,11 @@
<Parameter Name="values" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Appends a row to the given data model.
</para>
</summary>
<param name="values">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
@ -251,10 +295,18 @@
<Parameter Name="row" Type="Gda.Row" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Updates a row data model.
</para>
</summary>
<param name="row">a <see cref="T:Gda.Row" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" /> true if successful, false otherwise.</returns>
<remarks>
<para>
This results in the underlying database row's values being changed.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveRow">
@ -267,10 +319,18 @@
<Parameter Name="row" Type="Gda.Row" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Removes a row from the data model.
</para>
</summary>
<param name="row">a <see cref="T:Gda.Row" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" /> true if successfu, false otherwise.</returns>
<remarks>
<para>
This results in the underlying database row being removed in the database.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ToXml">
@ -283,7 +343,11 @@
<Parameter Name="standalone" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Converts the given model into a XML representation.
</para>
</summary>
<param name="standalone">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
@ -299,7 +363,11 @@
<Parameter Name="func" Type="Gda.DataModelForeachFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Calls the specified callback function for each row in the data model. This will just traverse all rows, and call the given callback function for each of them.
</para>
</summary>
<param name="func">a <see cref="T:Gda.DataModelForeachFunc" /></param>
<remarks>To be added</remarks>
</Docs>
@ -312,7 +380,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Re-enables notifications of changes on the given data model.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -326,7 +398,11 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Emits the 'row_updated' and 'changed' signals on model.
</para>
</summary>
<param name="row">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
@ -339,7 +415,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Converts the given model into a tab-separated series of rows.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -355,11 +435,19 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Retrieves the data stored in the given position (identified by the col and row parameters) on a data model.
</para>
</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>
<returns>a <see cref="T:Gda.Value" /> containing the value stored in the given position, or null on error.</returns>
<remarks>
<para>
This is the main function for accessing data in a model.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -384,7 +472,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Returns the number of rows in the given data model.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -397,7 +489,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the type of command that generated this data model.
</para>
<para>
Sets the type of command that generated this data model.
</para>
</summary>
<returns>a <see cref="T:Gda.CommandType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -410,7 +509,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the text of command that generated this data model.
</para>
<para>
Sets the command text of the given model.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -423,7 +529,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Returns the number of columns in the given data model.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>

26
doc/en/Gda/DataModelArray.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
An implementation of <see cref="T:Gda.DataModel" /> based on an array.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -46,7 +50,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Frees all the rows inserted in model.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -72,7 +80,11 @@
<Parameter Name="cols" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new DataModelArray with a specified number of columns for rows in this data model.
</para>
</summary>
<param name="cols">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.DataModelArray" /></returns>
<remarks>To be added</remarks>
@ -85,8 +97,12 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<summary>
<para>
Sets the number of columns for rows inserted in this model.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /> must be greater than or equal to 0.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>

64
doc/en/Gda/DataModelHash.xml
View file

@ -10,8 +10,16 @@
</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>
<summary>
<para>
An implementation of <see cref="T:Gda.DataModel" /> based on a hash table.
</para>
</summary>
<remarks>
<para>
Unlike <see cref="T:Gda.DataModelArray" />, this data model implementation stores the <see cref="T:Gda.Row" /> in a hash table. So it only retrieves from the database backend exactly the requested rows (while in <see cref="T:Gda.DataModelArray" /> you have to retrieve all the rows until the one requested).
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gda.DataModel</BaseTypeName>
@ -38,7 +46,11 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Retrieves the value at a specified column and row.
</para>
</summary>
<param name="model">a <see cref="T:Gda.DataModel" /></param>
<param name="col">a <see cref="T:System.Int32" /></param>
<param name="row">a <see cref="T:System.Int32" /></param>
@ -57,10 +69,14 @@
<Parameter Name="row" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Retrieves a row from the underlying hash table.
</para>
</summary>
<param name="model">a <see cref="T:Gda.DataModel" /></param>
<param name="row">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gda.Row" /></returns>
<returns>a <see cref="T:Gda.Row" /> or null if the requested row is not in the hash table.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -84,7 +100,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Frees all the rows inserted in the model.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -99,9 +119,13 @@
<Parameter Name="row" Type="Gda.Row" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="rownum">a <see cref="T:System.Int32" /></param>
<param name="row">a <see cref="T:Gda.Row" /></param>
<summary>
<para>
Inserts a row in the model.
</para>
</summary>
<param name="rownum">a <see cref="T:System.Int32" /> the number of the row.</param>
<param name="row">a <see cref="T:Gda.Row" /> to insert.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -127,8 +151,12 @@
<Parameter Name="cols" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cols">a <see cref="T:System.Int32" /></param>
<summary>
<para>
Creates a new DataModelHash with cols columns.
</para>
</summary>
<param name="cols">a <see cref="T:System.Int32" /> number of columns for rows in this data model.</param>
<returns>a <see cref="T:Gda.DataModelHash" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -140,9 +168,17 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>
<para>
Sets the number of columns for rows inserted in this model.
</para>
</summary>
<returns>a <see cref="T:System.Int32" /> must be greater than or equal to 0</returns>
<remarks>
<para>
This property calls <see cref="M:Gda.DataModelHash.Clear" /> to free the existing rows if any.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">

26
doc/en/Gda/DataModelList.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
An implementation of <see cref="T:Gda.DataModel" />
based on a list.</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -48,8 +52,12 @@
<Parameter Name="value" Type="Gda.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:Gda.Value" /></param>
<summary>
<para>
Inserts a row in the model, using a <see cref="T:Gda.Value" />.
</para>
</summary>
<param name="value">a <see cref="T:Gda.Value" /> which will be used to fill the row.</param>
<returns>a <see cref="T:Gda.Row" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -74,7 +82,11 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Default constructor.
</para>
</summary>
<returns>a <see cref="T:Gda.DataModelList" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -87,7 +99,11 @@
<Parameter Name="list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Constructor which returns a newly allocated <see cref="T:Gda.DataModel" /> which contains a set of <see cref="T:Gda.Value" />, according to the given list.
</para>
</summary>
<param name="list">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:Gda.DataModelList" /></returns>
<remarks>To be added</remarks>

62
doc/en/Gda/Error.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Management of errors.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -36,7 +40,11 @@
<Parameter Name="errors" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Frees all error objects in the list and the list itself. After this function has been called, the errors parameter doesn't point to valid storage any more.
</para>
</summary>
<param name="errors">a <see cref="T:GLib.List" /></param>
<remarks>To be added</remarks>
</Docs>
@ -51,7 +59,11 @@
<Parameter Name="errors" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new list which contains the same errors as errors and adds a reference for each error in the list.
</para>
</summary>
<param name="errors">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
@ -77,7 +89,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Frees the memory allocated by the error object.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -101,7 +117,7 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor.</summary>
<returns>a <see cref="T:Gda.Error" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -114,7 +130,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets error's SQL state.
</para>
<para>
Sets error's SQL state.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -127,7 +150,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets error's source.
</para>
<para>
Sets error's source.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -140,7 +170,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets error's number.
</para>
<para>
Sets error's number.
</para>
</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -153,7 +190,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets error's description.
</para>
<para>
Sets error's description
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>

6
doc/en/Gda/Field.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Management of database fields.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

30
doc/en/Gda/Log.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Object to log.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -42,7 +46,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Enables GDA logs.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +62,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Disables GDA Logs.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -81,7 +93,11 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Default constructor.
</para>
</summary>
<returns>a <see cref="T:Gda.Log" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -94,7 +110,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets if Gda Logs are enabled.
</para>
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>

55
doc/en/Gda/Parameter.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Management of parameters. Parameters are the way clients have to send an unlimited number of arguments to the providers.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -39,7 +43,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the name of the Gda.Parameter.
</para>
<para>
Sets the name of the Gda.Parameter.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -52,7 +63,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the value in the Gda.Parameter.
</para>
<para>
Stores the given value in the Gda.Parameter.
</para>
</summary>
<returns>a <see cref="T:Gda.Value" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -80,7 +98,11 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Parameter froma a <see cref="T:System.Boolean" /> value.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
@ -96,7 +118,11 @@
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:System.Double" /> value.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
@ -112,8 +138,12 @@
<Parameter Name="value" Type="Gda.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<summary>
<para>
Creates a new Gda.Parameter object, which is usually used with <see cref="T:Gda.ParameterList" />.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /> which is the name for the parameter being created.</param>
<param name="value">a <see cref="T:Gda.Value" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
@ -128,7 +158,10 @@
<Parameter Name="value" Type="GLib.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:GLib.Object" /></para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Object" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
@ -144,7 +177,11 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:System.String" />.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>

62
doc/en/Gda/ParameterList.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
A list of <see cref="T:Gda.Parameter" />.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -33,9 +37,17 @@
<Parameter Name="param" Type="Gda.Parameter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Adds a new <see cref="T:Gda.Parameter" />.
</para>
</summary>
<param name="param">a <see cref="T:Gda.Parameter" /></param>
<remarks>To be added</remarks>
<remarks>
<para>
Note that param is, when calling this function, is owned by the GdaParameterList, so the caller should just forget about it and not try to free the parameter once it's been added to the GdaParameterList.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
@ -46,8 +58,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
<para>
Clears the parameter list.
</para>
</summary>
<remarks>
<para>
This means removing all <see cref="T:Gda.Parameter" />'s currently being stored in the parameter list. After calling this method, the parameter list is empty.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Find">
@ -60,9 +80,13 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets a <see cref="T:Gda.Parameter" /> from the parameter list given its name.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<returns>a <see cref="T:Gda.Parameter" /> identified by name, if found; or null if not found.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -74,7 +98,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Releases all memory occupied by the object.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -98,7 +126,11 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Default constructor.
</para>
</summary>
<returns>a <see cref="T:Gda.ParameterList" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -111,7 +143,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the names of all parameters in the parameter list.
</para>
</summary>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -124,7 +160,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Gets the number of parameters stored in the parameter list.
</para>
</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>

62
doc/en/Gda/QuarkList.xml
View file

@ -10,8 +10,16 @@
</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>
<summary>
<para>
Quark list (lists of KEY == VALUES's).
</para>
</summary>
<remarks>
<para>
Parameter lists are used primary in the parsing and creation of connection strings.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -34,10 +42,18 @@
<Parameter Name="cleanup" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Adds new key-&gt;value pairs from the given string.
</para>
</summary>
<param name="str1ng">a <see cref="T:System.String" /></param>
<param name="cleanup">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks>
<para>
If cleanup is set to true, the previous contents will be discarded before adding the new pairs.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Find">
@ -50,9 +66,13 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Searches for the value identified by name in the Gda.QuarkList.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns>
<returns>a <see cref="T:System.String" />, the value associated with the given key if found, or null if not found.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -66,7 +86,11 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Removes an entry from the QuarkList, given its name.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
</Docs>
@ -79,7 +103,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Releases all memory occupied by the Gda.QuarkList.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -103,9 +131,17 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Default constructor.
</para>
</summary>
<returns>a <see cref="T:Gda.QuarkList" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
Creates a new GdaQuarkList, which is a set of key-&gt;value pairs, very similar to GLib's GHashTable, but with the only purpose to make easier the parsing and creation of data source connection strings.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -116,7 +152,11 @@
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new GdaQuarkList given a connection string.
</para>
</summary>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gda.QuarkList" /></returns>
<remarks>To be added</remarks>

72
doc/en/Gda/Row.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
A object which represents a row.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -31,7 +35,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Deallocates all memory associated to the Gda.Row.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -45,8 +53,12 @@
<Parameter Name="num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="num">a <see cref="T:System.Int32" /></param>
<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>
@ -74,9 +86,13 @@
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="model">a <see cref="T:Gda.DataModel" /></param>
<param name="count">a <see cref="T:System.Int32" /></param>
<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>
@ -90,7 +106,11 @@
<Parameter Name="values" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<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>
@ -105,7 +125,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<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>
@ -118,7 +142,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<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>
@ -131,7 +162,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<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>
@ -144,9 +179,20 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<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>To be added</remarks>
<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>

44
doc/en/Gda/Select.xml
View file

@ -10,7 +10,11 @@
</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>
<summary>
<para>
Filtering data from <see cref="T:Gda.DataModel" />.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -49,10 +53,18 @@
<Parameter Name="source" Type="Gda.DataModel" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<para>
Adds a data model as a source of data for the Gda.Select object.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="source">a <see cref="T:Gda.DataModel" /></param>
<remarks>To be added</remarks>
<remarks>
<para>
When the select object is run via <see cref="M:Gda.Select.Run" />, it will parse the SQL and get the required data from the source data models.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Run">
@ -63,9 +75,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Runs the query and fills in the Gda.Select object with the rows that matched the SQL command (which can be set with <see cref="M:Gda.Select.Sql" />) associated with this Gda.Select object.
</para>
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
After calling this function, if everything is successful, the Gda.Select object will contain the matched rows, which can then be accessed like a normal <see cref="T:Gda.DataModel" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -88,9 +108,17 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<para>
Creates a new Gda.Select object, which allows programs to filter <see cref="T:Gda.DataModel" />'s based on a given SQL SELECT command.
</para>
</summary>
<returns>a <see cref="T:Gda.Select" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
A GdaSelect is just another GdaDataModel-based class, so it can be used in the same way any other data model class is.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Sql">
@ -100,7 +128,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Sets the SQL command to be used on the given Gda.Select object for filtering rows from the source data model.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>