explain viewer stop_flag

git-svn-id: http://ltt.polymtl.ca/svn@553 04897980-b3bd-0310-b5e0-8ef037075253

diff --git a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/viewer.h b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/viewer.h
index f3aceb5949850d14461cf2ca050cfff58bfab1a6..dbcc175208c1ef92c3459a5f7396f8e0025a9a1d 100644 (file)
--- a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/viewer.h
+++ b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/viewer.h
@@ -110,16 +110,26 @@ main middle hooks.
 
 EventsRequest consists in 
 - a start timestamp or position
+- a stop_flag, ending the read process when set to TRUE
 - a end timestamp and/or position and/or number of events to read
 - hook lists to call for traceset/trace/tracefile begin and end, and for each
   event (middle).
-
+  
 The main window will deliver events for every EventRequests it has pending
 through an algorithm that guarantee that all events requested, and only them,
 will be delivered to the viewer between the call of the tracefile_begin hooks
 and the call of the tracefile_end hooks.
 
+If a viewer wants to stop the event request at a certain point inside the event
+hooks, it has to set the stop_flag to TRUE and return TRUE from the hook
+function. Then return value will stop the process traceset. Then, the main
+window will look for the stop_flag and remove the EventRequests from its lists,
+calling the process_traceset_end for this request (it removes hooks from the
+context and calls the after hooks).
 
+It no stop_flag is rose, the end timestamp, end position or number of events to
+read has to be reached to determine the end of the request. Otherwise,
+the end of traceset does determine it.
 
 
 GTK Events