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

Contributions from wizito@gentelibre.org

Browse source 
svn path=/trunk/gtk-sharp/; revision=38813
This commit is contained in:
Miguel de Icaza 2005-01-12 19:37:30 +00:00
parent 3156f18c10
commit efc722a12d
3 changed files with 159 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

114
doc/en/Gda/Config.xml
View file

@ -10,7 +10,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>
<para>
The functions in this section allow applications an easy access to the libgda configuration, thus making them able to access the list of data sources configured in the system, for instance.
</para>
</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -29,7 +33,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets a string representing the type of the value of the given key.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -76,7 +84,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Returns a GList containing the names of all the sections available under the given root directory.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:GLib.List" /></returns> <returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -108,7 +120,11 @@
<Parameter Name="new_value" Type="System.Int32" /> <Parameter Name="new_value" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Sets the given configuration entry to contain an integer.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<param name="new_value">a <see cref="T:System.Int32" /></param> <param name="new_value">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -140,9 +156,17 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Removes the given entry from the configuration database.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>
<para>
If the section is empty, also remove the section.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveSection"> <Member MemberName="RemoveSection">
@ -155,7 +179,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Removes the given section from the configuration database.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
@ -171,7 +199,11 @@
<Parameter Name="new_value" Type="System.Boolean" /> <Parameter Name="new_value" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Sets the given configuration entry to contain a boolean.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<param name="new_value">a <see cref="T:System.Boolean" /></param> <param name="new_value">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -227,7 +259,11 @@
<Parameter Name="id" Type="System.UInt32" /> <Parameter Name="id" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Removes a configuration listener previously installed, given its ID.
</para>
</summary>
<param name="id">a <see cref="T:System.UInt32" /></param> <param name="id">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
@ -242,7 +278,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Returns a list of all keys that exist under the given path.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:GLib.List" /></returns> <returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -258,7 +298,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets the value of the specified configuration entry as a float.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -274,7 +318,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets the value of the specified configuration entry as a float.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Double" /></returns> <returns>a <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -305,7 +353,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Checks whether the given section exists in the configuration system.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -353,7 +405,11 @@
<Parameter Name="func" Type="Gda.ConfigListenerFunc" /> <Parameter Name="func" Type="Gda.ConfigListenerFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Installs a configuration listener, which is a callback function which will be called every time a change occurs on a given configuration entry.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<param name="func">a <see cref="T:Gda.ConfigListenerFunc" /></param> <param name="func">a <see cref="T:Gda.ConfigListenerFunc" /></param>
<returns>a <see cref="T:System.UInt32" /></returns> <returns>a <see cref="T:System.UInt32" /></returns>
@ -371,7 +427,11 @@
<Parameter Name="new_value" Type="System.Double" /> <Parameter Name="new_value" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Sets the given configuration entry to contain a float.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<param name="new_value">a <see cref="T:System.Double" /></param> <param name="new_value">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -387,7 +447,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets the value of the specified configuration entry as an integer.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -403,7 +467,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Checks whether the given key exists in the configuration system.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -435,7 +503,11 @@
<Parameter Name="new_value" Type="System.String" /> <Parameter Name="new_value" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Sets the given configuration entry to contain a string.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<param name="new_value">a <see cref="T:System.String" /></param> <param name="new_value">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -466,7 +538,11 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets the value of the specified configuration entry as a string.
</para>
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>

41
doc/en/Gda/Table.xml
View file

@ -10,7 +10,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>
<para>
An in-memory representation of a database table.
</para>
</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -48,7 +52,11 @@
<Parameter Name="model" Type="Gda.DataModel" /> <Parameter Name="model" Type="Gda.DataModel" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Adds data in the table from the given model.
</para>
</summary>
<param name="model">a <see cref="T:Gda.DataModel" /></param> <param name="model">a <see cref="T:Gda.DataModel" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
@ -63,7 +71,11 @@
<Parameter Name="fa" Type="Gda.FieldAttributes" /> <Parameter Name="fa" Type="Gda.FieldAttributes" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Adds a field to the Table.
</para>
</summary>
<param name="fa">a <see cref="T:Gda.FieldAttributes" /></param> <param name="fa">a <see cref="T:Gda.FieldAttributes" /></param>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
@ -91,9 +103,13 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" /> Name for your new table.</param>
<returns>a <see cref="T:Gda.Table" /></returns> <returns>a <see cref="T:Gda.Table" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
It is mainly used by the GdaXmlDatabase class, but you can also use it in your applications for whatever you may need it.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -111,7 +127,14 @@
<param name="model">a <see cref="T:Gda.DataModel" /></param> <param name="model">a <see cref="T:Gda.DataModel" /></param>
<param name="add_data">a <see cref="T:System.Boolean" /></param> <param name="add_data">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gda.Table" /></returns> <returns>a <see cref="T:Gda.Table" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
This is very useful to maintain an in-memory copy of a given recordset obtained from a database.
</para>
<para>
This is also used when exporting data to a GdaXmlDatabase object.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Name"> <Member MemberName="Name">
@ -122,7 +145,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets / Sets the name of the given Table.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>

36
doc/en/Gda/Transaction.xml
View file

@ -10,7 +10,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>
<para>
Management of transactions.
</para>
</summary>
<remarks>To be added</remarks> <remarks>To be added</remarks>
</Docs> </Docs>
<Base> <Base>
@ -60,7 +64,11 @@
<Parameter Name="name" Type="System.String" /> <Parameter Name="name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Construct this object, which allows a fine-tune and full control of transactions to be used with providers.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gda.Transaction" /></returns> <returns>a <see cref="T:Gda.Transaction" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -74,9 +82,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets / Sets the name of the given transaction.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
This is very useful when using providers that support named transactions.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsolationLevel"> <Member MemberName="IsolationLevel">
@ -87,9 +103,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>
Gets / Sets the isolation level for the given transaction.
</para>
</summary>
<returns>a <see cref="T:Gda.TransactionIsolation" /></returns> <returns>a <see cref="T:Gda.TransactionIsolation" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
This specifies the locking behavior for the database connection during the given transaction.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">