*** empty log message ***

[bbtk.git] / kernel / src / bbtkBlackBox.h

diff --git a/kernel/src/bbtkBlackBox.h b/kernel/src/bbtkBlackBox.h
index 2082d77676c6e57a072f13e5f717d59ced7da307..729365a315d23775c3d2ffd31369a0c05ffad69f 100644 (file)
--- a/kernel/src/bbtkBlackBox.h
+++ b/kernel/src/bbtkBlackBox.h
@@ -2,8 +2,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/12/03 09:34:37 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2008/12/03 13:35:22 $
+  Version:   $Revision: 1.16 $
 =========================================================================*/
 
 /* ---------------------------------------------------------------------
@@ -105,26 +105,36 @@ namespace bbtk
 
     ///  Signals that the BlackBox has been modified through the input connector c
     /// and propagates it downward
+    /// ** NOT USER INTENDED **
     virtual void bbSetModifiedStatus(BlackBoxInputConnector* c = 0);
+
     /// Signals that the BlackBox outputs have been modified 
-    /// without marking the box as MODIFIED because its output state is ok. 
+    /// (without marking the box as MODIFIED because its output state is ok : don't care if you understand : use it !).
     /// This method should be used by widgets in response 
     /// to user interaction when **ALL** outputs have been modified
-    /// (after the outputs has been updated !)
+    /// (after the outputs has been updated !).
+    /// DO NOT PASS reaction = false OR WILL NOT WORK PROPERLY
+    /// ** USER INTENDED **
     virtual void bbSignalOutputModification(bool reaction = true);
-    ///  Signals that the BlackBox output "output_name" have been modified 
-    /// without marking the box as MODIFIED because its output state is ok. 
+    /// Signals that the BlackBox output "output_name" has been modified 
+    /// (without marking the box as MODIFIED because its output state is ok : don't care if you understand : use it !). 
     /// This method should be used by widgets in response to user interaction 
     /// only when **ONE** output has been modified
     /// (after the output has been updated !)
+    /// DO NOT PASS reaction = false OR WILL NOT WORK PROPERLY
+    /// ** USER INTENDED **
     virtual void bbSignalOutputModification( const std::string& output_name,
 bool reaction = true);
-    ///  Signals that the BlackBox vector of outputs "output_name" 
-    ///  have been modified 
-    /// without marking the box as MODIFIED because its output state is ok. 
+    /// Signals that the BlackBox vector of outputs "output_name" 
+    /// have been modified.
+    /// Should be used when more than ONE output is modified but not ALL 
+    /// (optimization issue).
+    /// (without marking the box as MODIFIED because its output state is ok). 
     /// This method should be used by widgets in response to user interaction 
     /// When more than one output has been changed but not all
     /// (after the outputs have been updated of course!)
+    /// DO NOT PASS reaction = false OR WILL NOT WORK PROPERLY
+    /// ** USER INTENDED **
     virtual void bbSignalOutputModification( const std::vector<std::string>& output_name,
 bool reaction = true);