ruby-****@sourc*****
ruby-****@sourc*****
2005年 3月 5日 (土) 06:18:45 JST
------------------------- REMOTE_ADDR = 82.239.64.142 REMOTE_HOST = REMOTE_USER = ruby-gnome2-hiki URL = http://ruby-gnome2.sourceforge.jp/cgi-bin/hiki/hiki.cgi?Gda%3A%3ADataModel ------------------------- @@ -8,6 +8,11 @@ * Gda::DataModel == Instance Methods +--- append_column(attributes) + Appends a column to the data model. + * attributes: a Gda::FieldAttributes object describing the column to add. + * Returns: true if successful, false otherwise. + --- append_row(*values) Their length must match model's column count. @@ -15,12 +20,17 @@ * values: a list of Gda::Value objects. * Returns: the added row, as a Gda::Row object, on success, nil on errors. ---- begin_edit +--- begin_update Starts update of this data model. This method should be the first called when modifying the data model. * Returns: true on success, false if there was an error. ---- cancel_edit +--- cancel_update Cancels update of this data model. This means that all changes will be discarded, and the old data put back in the model. * Returns: true on success, false if there was an error. @@ -65,17 +70,11 @@ Gda::Row object as parameter. * Returns: always nil. ---- editable? - This method returns true if the model can be updated, false otherwise. - * Returns: true if the model can be updated, false otherwise. - ---- editing? - Checks whether this data model is in updating mode or not. Updating - mode is set to true when Gda::DataModel#begin_edit has been - called successfully, and is not set back to false until either - Gda::DataModel#cancel_edit or Gda::DataModel#end_edit have been called. - * Returns: true if updating mode, false otherwise. - --- emit_changed Notifies listeners of the given data model object of changes in the underlying data. Listeners usually will connect themselves to the "changed" @@ -83,6 +77,15 @@ being appended or removed from the data model. * Returns: self. +--- emit_column_inserted(colnum) + Emits the 'column_inserted' and 'changed' signals on the model. + * colnum: a column number. + * Returns: self. + +--- emit_column_removed(colnum) + Emits the 'column_removed' and 'changed' signals on the model. + * colnum: a column number. + * Returns: self. + +--- emit_column_updated(colnum) + Emits the 'column_updated' and 'changed' signals on the model. + * colnum: a column number. + * Returns: self. + --- emit_row_inserted(rownum) Emits the 'row_inserted' and 'changed' signals on the model. * rownum: a row number. @@ -98,7 +107,16 @@ * rownum: a row number. * Returns: self. ---- end_edit +--- end_update Approves all modifications and send them to the underlying data source/store. * Returns: true on success, false if there was an error. @@ -123,6 +132,30 @@ * rownum: a row number. * Returns: the row, as a Gda::Row object, or nil if the given row number is invalid. +--- get_value_at(colnum, rownum) + Retrieves the data stored in the given position in the data model. + This is the main function for accessing data in a model. + ..). + * rownum: a row number. + * colnum: a column number. + * Returns: a Ruby object according to the type of the column is successful, nil otherwise (out-of-bound position, etc. + +--- has_changed? + Checks whether this data model is in updating mode or not. Updating + mode is set to true when Gda::DataModel#begin_update has been + called successfully, and is not set back to false until either + Gda::DataModel#cancel_update or Gda::DataModel#end_update have been called. + * Returns: true if updating mode, false otherwise. + --- n_columns This method returns the number of columns in the model. * Returns: the number of columns in the model. @@ -131,6 +155,35 @@ This method returns the number of rows in the data model. * Returns: the number of rows in the data model. +--- remove_column(column_id) + Removes an existing column in the data model. + * column_id: the number of the column to be updated. + * Returns: true if successful, false otherwise. + --- remove_row(row) Removes a row from the data model. This results in the underlying database row being removed in the database. @@ -166,6 +195,45 @@ --- to_xml(standalone=false) Converts the given model into a XML representation. * Returns: the string representation of the model. + +--- updatable? + This method returns true if the model can be updated, false otherwise. + * Returns: true if the model can be updated, false otherwise. + +--- update_column(column_id, attributes) + Updates an existing column in the data model. + * attributes: a Gda::FieldAttributes object describing the column to update. + * column_id: the number of the column to be updated. + * Returns: true if successful, false otherwise. --- update_row(row) Updates a row data model. This results in the underlying database row's
