[libgda] Doc. improvements



commit 026bfc301f63b9df81bda873b6d89fb4d7338c68
Author: Vivien Malerba <malerba gnome-db org>
Date:   Wed Apr 18 15:04:31 2012 +0200

    Doc. improvements

 doc/C/data-model-writing.xml |   11 ++++++++++-
 libgda/gda-data-proxy.h      |    2 ++
 2 files changed, 12 insertions(+), 1 deletions(-)
---
diff --git a/doc/C/data-model-writing.xml b/doc/C/data-model-writing.xml
index f750448..1739b53 100644
--- a/doc/C/data-model-writing.xml
+++ b/doc/C/data-model-writing.xml
@@ -171,7 +171,16 @@
   <sect2 id="gda-data-model-writing-signalling">
     <title>Signalling changes</title>
     <para>
-      When the data model changes, it must signal those changes using one of the following methods:
+      When the data model changes, it needs to signal its changes. However, only the changes from
+      the initial state need to be notified, in situations such as:
+      <itemizedlist>
+        <listitem><para>a row which has already been accessed is modified or removed</para></listitem>
+        <listitem><para>the total number of rows changes, and that number has already been obtained and
+	was known (i.e. different than -1)</para></listitem>
+      </itemizedlist>
+    </para>
+    <para>
+      To signal changes, one of the following methods has to be used:
       <itemizedlist>
         <listitem><para><link linkend="gda-data-model-row-inserted">gda_data_model_row_inserted()</link>: to be called after a row has been inserted</para></listitem>
         <listitem><para><link linkend="gda-data-model-row-updated">gda_data_model_row_updated()</link>: to be called after a row has been updated</para></listitem>
diff --git a/libgda/gda-data-proxy.h b/libgda/gda-data-proxy.h
index eff0d2e..e7856a2 100644
--- a/libgda/gda-data-proxy.h
+++ b/libgda/gda-data-proxy.h
@@ -110,6 +110,8 @@ struct _GdaDataProxyClass
  *	  <listitem><para>if new rows have been added to the proxy</para></listitem>
  *	</itemizedlist>
  *    </para></listitem>
+ *    <listitem><para>Any #GdaDataModelIter iterator created will only make appear the colmuns as present in the proxied
+ *        data model, not any of the other columns</para></listitem>
  *  </itemizedlist>
  *  This situation is illustrated in the following schema, where there is a direct mapping between the proxy's
  *  rows and the proxied data model's rows:



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]