diff --git a/doc/en/Gda/Command.xml b/doc/en/Gda/Command.xml index 09c1ddf5a..48ac5803e 100644 --- a/doc/en/Gda/Command.xml +++ b/doc/en/Gda/Command.xml @@ -10,8 +10,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + + The Gda.Command structure holds data needed to issue a command to the providers. + + + + +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. + + System.ValueType @@ -27,7 +35,11 @@ - To be added + + +Frees the resources allocated by Gda.Command's constructor. + + To be added @@ -39,7 +51,14 @@ - To be added + + +Gets the of command. + + +Sets the of command. + + a To be added @@ -52,7 +71,14 @@ - To be added + + +Gets the of cmd. + + +Sets the of cmd. + + a To be added @@ -65,7 +91,14 @@ - To be added + + +Gets the command text. + + +Sets the command text. + + a To be added @@ -78,7 +111,14 @@ - To be added + + +Gets the associated with the Command. + + +Sets the associated with the Command. + + a To be added @@ -107,7 +147,11 @@ - To be added + + +Creates a new Gda.Command from the parameters. + + a a a diff --git a/doc/en/Gda/DataModel.xml b/doc/en/Gda/DataModel.xml index 0451056e3..d4618ad0f 100644 --- a/doc/en/Gda/DataModel.xml +++ b/doc/en/Gda/DataModel.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Basic data model class. + + To be added @@ -46,7 +50,11 @@ - To be added + + +Converts the given model into a comma-separated series of rows. + + a To be added @@ -61,7 +69,11 @@ - To be added + + +Returns the title for the given column in a data model object. + + a a To be added @@ -77,7 +89,11 @@ - To be added + + +Emits the 'row_inserted' and 'changed' signals on model. + + a To be added @@ -103,7 +119,11 @@ - To be added + + +Disables notifications of changes on the given data model. To re-enable notifications again, you should call the method. + + To be added @@ -128,7 +148,11 @@ - To be added + + +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 class, thus being notified of any new data being appended or removed from the data model. + + To be added @@ -142,9 +166,13 @@ - To be added + + +Gets the position of a column on the data model, based on the column's title. + + a - a + a the position of the column in the data model, or -1 if the column could not be found. To be added @@ -158,7 +186,11 @@ - To be added + + +Emits the 'row_removed' and 'changed' signal on model. + + a To be added @@ -186,7 +218,11 @@ - To be added + + +Retrieves a given row from a data model. + + a a To be added @@ -203,7 +239,11 @@ - To be added + + +Sets the title of the given col in data model object. + + a a To be added @@ -219,9 +259,9 @@ - To be added + Queries the underlying data model implementation for a description of a given column. That description is returned in the form of a structure, which contains all the information about the given column in the data model. a - a + a which contains all information about the given column in the data model. To be added @@ -235,7 +275,11 @@ - To be added + + +Appends a row to the given data model. + + a a To be added @@ -251,10 +295,18 @@ - To be added + + +Updates a row data model. + + a - a - To be added + a true if successful, false otherwise. + + + This results in the underlying database row's values being changed. + + @@ -267,10 +319,18 @@ - To be added + + +Removes a row from the data model. + + a - a - To be added + a true if successfu, false otherwise. + + +This results in the underlying database row being removed in the database. + + @@ -283,7 +343,11 @@ - To be added + + +Converts the given model into a XML representation. + + a a To be added @@ -299,7 +363,11 @@ - To be added + + +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. + + a To be added @@ -312,7 +380,11 @@ - To be added + + +Re-enables notifications of changes on the given data model. + + To be added @@ -326,7 +398,11 @@ - To be added + + +Emits the 'row_updated' and 'changed' signals on model. + + a To be added @@ -339,7 +415,11 @@ - To be added + + +Converts the given model into a tab-separated series of rows. + + a To be added @@ -355,11 +435,19 @@ - To be added + + +Retrieves the data stored in the given position (identified by the col and row parameters) on a data model. + + a a - a - To be added + a containing the value stored in the given position, or null on error. + + +This is the main function for accessing data in a model. + + @@ -384,7 +472,11 @@ - To be added + + +Returns the number of rows in the given data model. + + a To be added @@ -397,7 +489,14 @@ - To be added + + +Gets the type of command that generated this data model. + + +Sets the type of command that generated this data model. + + a To be added @@ -410,7 +509,14 @@ - To be added + + +Gets the text of command that generated this data model. + + +Sets the command text of the given model. + + a To be added @@ -423,7 +529,11 @@ - To be added + + +Returns the number of columns in the given data model. + + a To be added diff --git a/doc/en/Gda/DataModelArray.xml b/doc/en/Gda/DataModelArray.xml index 0e62764cb..821ed12f5 100644 --- a/doc/en/Gda/DataModelArray.xml +++ b/doc/en/Gda/DataModelArray.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +An implementation of based on an array. + + To be added @@ -46,7 +50,11 @@ - To be added + + +Frees all the rows inserted in model. + + To be added @@ -72,7 +80,11 @@ - To be added + + +Creates a new DataModelArray with a specified number of columns for rows in this data model. + + a a To be added @@ -85,8 +97,12 @@ System.Int32 - To be added - a + + +Sets the number of columns for rows inserted in this model. + + + a must be greater than or equal to 0. To be added diff --git a/doc/en/Gda/DataModelHash.xml b/doc/en/Gda/DataModelHash.xml index 6f78be3aa..13938093b 100644 --- a/doc/en/Gda/DataModelHash.xml +++ b/doc/en/Gda/DataModelHash.xml @@ -10,8 +10,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + +An implementation of based on a hash table. + + + + +Unlike , this data model implementation stores the in a hash table. So it only retrieves from the database backend exactly the requested rows (while in you have to retrieve all the rows until the one requested). + + Gda.DataModel @@ -38,7 +46,11 @@ - To be added + + +Retrieves the value at a specified column and row. + + a a a @@ -57,10 +69,14 @@ - To be added + + +Retrieves a row from the underlying hash table. + + a a - a + a or null if the requested row is not in the hash table. To be added @@ -84,7 +100,11 @@ - To be added + + +Frees all the rows inserted in the model. + + To be added @@ -99,9 +119,13 @@ - To be added - a - a + + +Inserts a row in the model. + + + a the number of the row. + a to insert. To be added @@ -127,8 +151,12 @@ - To be added - a + + +Creates a new DataModelHash with cols columns. + + + a number of columns for rows in this data model. a To be added @@ -140,9 +168,17 @@ System.Int32 - To be added - a - To be added + + +Sets the number of columns for rows inserted in this model. + + + a must be greater than or equal to 0 + + +This property calls to free the existing rows if any. + + diff --git a/doc/en/Gda/DataModelList.xml b/doc/en/Gda/DataModelList.xml index 7397c069e..6bf942c0d 100644 --- a/doc/en/Gda/DataModelList.xml +++ b/doc/en/Gda/DataModelList.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +An implementation of +based on a list. + To be added @@ -48,8 +52,12 @@ - To be added - a + + +Inserts a row in the model, using a . + + + a which will be used to fill the row. a To be added @@ -74,7 +82,11 @@ - To be added + + +Default constructor. + + a To be added @@ -87,7 +99,11 @@ - To be added + + +Constructor which returns a newly allocated which contains a set of , according to the given list. + + a a To be added diff --git a/doc/en/Gda/Error.xml b/doc/en/Gda/Error.xml index a83b53a65..52bdc2a52 100644 --- a/doc/en/Gda/Error.xml +++ b/doc/en/Gda/Error.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Management of errors. + + To be added @@ -36,7 +40,11 @@ - To be added + + +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. + + a To be added @@ -51,7 +59,11 @@ - To be added + + +Creates a new list which contains the same errors as errors and adds a reference for each error in the list. + + a a To be added @@ -77,7 +89,11 @@ - To be added + + +Frees the memory allocated by the error object. + + To be added @@ -101,7 +117,7 @@ - To be added + Default constructor. a To be added @@ -114,7 +130,14 @@ - To be added + + +Gets error's SQL state. + + +Sets error's SQL state. + + a To be added @@ -127,7 +150,14 @@ - To be added + + +Gets error's source. + + +Sets error's source. + + a To be added @@ -140,7 +170,14 @@ - To be added + + +Gets error's number. + + +Sets error's number. + + a To be added @@ -153,7 +190,14 @@ - To be added + + +Gets error's description. + + +Sets error's description + + a To be added diff --git a/doc/en/Gda/Field.xml b/doc/en/Gda/Field.xml index c128bbe54..08fc398b0 100644 --- a/doc/en/Gda/Field.xml +++ b/doc/en/Gda/Field.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Management of database fields. + + To be added diff --git a/doc/en/Gda/Log.xml b/doc/en/Gda/Log.xml index 45e897571..a9d634235 100644 --- a/doc/en/Gda/Log.xml +++ b/doc/en/Gda/Log.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Object to log. + + To be added @@ -42,7 +46,11 @@ - To be added + + +Enables GDA logs. + + To be added @@ -54,7 +62,11 @@ - To be added + + +Disables GDA Logs. + + To be added @@ -81,7 +93,11 @@ - To be added + + +Default constructor. + + a To be added @@ -94,7 +110,11 @@ - To be added + + +Gets if Gda Logs are enabled. + + a To be added diff --git a/doc/en/Gda/Parameter.xml b/doc/en/Gda/Parameter.xml index 5b28b3009..7ead59071 100644 --- a/doc/en/Gda/Parameter.xml +++ b/doc/en/Gda/Parameter.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Management of parameters. Parameters are the way clients have to send an unlimited number of arguments to the providers. + + To be added @@ -39,7 +43,14 @@ - To be added + + +Gets the name of the Gda.Parameter. + + +Sets the name of the Gda.Parameter. + + a To be added @@ -52,7 +63,14 @@ - To be added + + +Gets the value in the Gda.Parameter. + + +Stores the given value in the Gda.Parameter. + + a To be added @@ -80,7 +98,11 @@ - To be added + + +Creates a new Gda.Parameter froma a value. + + a a a @@ -96,7 +118,11 @@ - To be added + + +Creates a new Gda.Parameter from a value. + + a a a @@ -112,8 +138,12 @@ - To be added - a + + +Creates a new Gda.Parameter object, which is usually used with . + + + a which is the name for the parameter being created. a a To be added @@ -128,7 +158,10 @@ - To be added + + +Creates a new Gda.Parameter from a + a a a @@ -144,7 +177,11 @@ - To be added + + +Creates a new Gda.Parameter from a . + + a a a diff --git a/doc/en/Gda/ParameterList.xml b/doc/en/Gda/ParameterList.xml index 32618224d..8556c8bb7 100644 --- a/doc/en/Gda/ParameterList.xml +++ b/doc/en/Gda/ParameterList.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +A list of . + + To be added @@ -33,9 +37,17 @@ - To be added + + +Adds a new . + + a - To be added + + +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. + + @@ -46,8 +58,16 @@ - To be added - To be added + + +Clears the parameter list. + + + + +This means removing all 's currently being stored in the parameter list. After calling this method, the parameter list is empty. + + @@ -60,9 +80,13 @@ - To be added + + +Gets a from the parameter list given its name. + + a - a + a identified by name, if found; or null if not found. To be added @@ -74,7 +98,11 @@ - To be added + + +Releases all memory occupied by the object. + + To be added @@ -98,7 +126,11 @@ - To be added + + +Default constructor. + + a To be added @@ -111,7 +143,11 @@ - To be added + + +Gets the names of all parameters in the parameter list. + + a To be added @@ -124,7 +160,11 @@ - To be added + + +Gets the number of parameters stored in the parameter list. + + a To be added diff --git a/doc/en/Gda/QuarkList.xml b/doc/en/Gda/QuarkList.xml index 2e33e45f6..8547ea04b 100644 --- a/doc/en/Gda/QuarkList.xml +++ b/doc/en/Gda/QuarkList.xml @@ -10,8 +10,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + +Quark list (lists of KEY == VALUES's). + + + + + Parameter lists are used primary in the parsing and creation of connection strings. + + GLib.Opaque @@ -34,10 +42,18 @@ - To be added + + +Adds new key->value pairs from the given string. + + a a - To be added + + +If cleanup is set to true, the previous contents will be discarded before adding the new pairs. + + @@ -50,9 +66,13 @@ - To be added + + +Searches for the value identified by name in the Gda.QuarkList. + + a - a + a , the value associated with the given key if found, or null if not found. To be added @@ -66,7 +86,11 @@ - To be added + + +Removes an entry from the QuarkList, given its name. + + a To be added @@ -79,7 +103,11 @@ - To be added + + +Releases all memory occupied by the Gda.QuarkList. + + To be added @@ -103,9 +131,17 @@ - To be added + + +Default constructor. + + a - To be added + + +Creates a new GdaQuarkList, which is a set of key->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. + + @@ -116,7 +152,11 @@ - To be added + + +Creates a new GdaQuarkList given a connection string. + + a a To be added diff --git a/doc/en/Gda/Row.xml b/doc/en/Gda/Row.xml index 28eeb5ccc..f2eea784a 100644 --- a/doc/en/Gda/Row.xml +++ b/doc/en/Gda/Row.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +A object which represents a row. + + To be added @@ -31,7 +35,11 @@ - To be added + + +Deallocates all memory associated to the Gda.Row. + + To be added @@ -45,8 +53,12 @@ - To be added - a + + +Returns a stored in the Gda.Row. + + + a the field index. a To be added @@ -74,9 +86,13 @@ - To be added - a - a + + +Creates a new Gda.Row, which can hold count . + + + a this row belongs to. + a of in the new Gda.Row. a To be added @@ -90,7 +106,11 @@ - To be added + + +Creates a new Gda.Row from a list of +'s + a a a @@ -105,7 +125,11 @@ - To be added + + +Gets the which Gda.Row belongs to. + + a To be added @@ -118,7 +142,14 @@ - To be added + + +Gets the number of the Gda.Row, that is, its position in its containing data model. + + +Sets the row number for the Gda.Row. + + a To be added @@ -131,7 +162,11 @@ - To be added + + +Gets the number of columns that Gda.Row has. + + a To be added @@ -144,9 +179,20 @@ - To be added + + +Gets the unique identifier for this row. + + +Sets the identifier for this row. Usually, this is called by providers. + + a - To be added + + +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). + + diff --git a/doc/en/Gda/Select.xml b/doc/en/Gda/Select.xml index 79d97444a..88b3759b7 100644 --- a/doc/en/Gda/Select.xml +++ b/doc/en/Gda/Select.xml @@ -10,7 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + +Filtering data from . + + To be added @@ -49,10 +53,18 @@ - To be added + + +Adds a data model as a source of data for the Gda.Select object. + + a a - To be added + + +When the select object is run via , it will parse the SQL and get the required data from the source data models. + + @@ -63,9 +75,17 @@ - To be added + + +Runs the query and fills in the Gda.Select object with the rows that matched the SQL command (which can be set with ) associated with this Gda.Select object. + + a - To be added + + +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 . + + @@ -88,9 +108,17 @@ - To be added + + +Creates a new Gda.Select object, which allows programs to filter 's based on a given SQL SELECT command. + + a - To be added + + +A GdaSelect is just another GdaDataModel-based class, so it can be used in the same way any other data model class is. + + @@ -100,7 +128,7 @@ System.String - To be added + Sets the SQL command to be used on the given Gda.Select object for filtering rows from the source data model. a To be added