[Kst] kdeextragear-2/kst/devel-docs

[George Staikos]

CVS commit by staikos: 

updates


  M +24 -0     updates.txt   1.8


--- kdeextragear-2/kst/devel-docs/updates.txt  #1.7:1.8
@@ -55,2 +55,26 @@
 - 'Pause' only pauses data sources.
 
+
+
+The Flow
+--------
+
+update(counter) {
+        bool force = dirty();
+        setDirty(false);
+
+        if (KstObject::checkUpdateCounter(counter) && !force) {
+                return lastUpdateResult();
+        }
+
+        bool updated = false;
+        // check dependency objects/scalars/vectors with counter and set updated
+        // to true if any of those had updatedd
+
+        if (updated || force) {
+                // do your update
+                return setLastUpdateResult(UPDATE);
+        }
+        return setLastUpdateResult(NO_CHANGE);
+}
+