update for bakefile 0.2.6

[wxWidgets.git] / interface / wx / process.h

diff --git a/interface/wx/process.h b/interface/wx/process.h
index f64eb96774ce221492d390418b39f93375ab2dcd..4a5585f81a2594a1f5777c88d643ae883107fb2a 100644 (file)
--- a/interface/wx/process.h
+++ b/interface/wx/process.h
@@ -51,11 +51,14 @@ enum wxKillError
     notified about the process termination and also retrieve its exit status which is
     unavailable from ::wxExecute() in the case of asynchronous execution.
 
-    @note If the process termination notification is processed by the
-    parent, it is responsible for deleting the wxProcess object which sent it.
-    However, if it is not processed, the object will delete itself and so the
-    library users should only delete those objects whose notifications have been
-    processed (and call wxProcess::Detach for others).
+    @note 
+        If the @c wxEVT_END_PROCESS event sent after termination is processed by the
+        parent, then it is responsible for deleting the wxProcess object which sent it.
+        However, if it is not processed, the object will <b>delete itself</b> and so the
+        library users should only delete those objects whose notifications have been
+        processed (and call wxProcess::Detach for others).
+        This also means that unless you're going to process the @c wxEVT_END_PROCESS event,
+        you <b>must</b> allocate the wxProcess class on the heap.
 
     wxProcess also supports IO redirection of the child process. For this, you have
     to call its Redirect() method before passing it to ::wxExecute().
@@ -63,10 +66,16 @@ enum wxKillError
     and GetErrorStream() can then be used to retrieve the streams corresponding to the
     child process standard output, input and error output respectively.
 
+    @beginEventEmissionTable{wxProcessEvent}
+    @event{EVT_END_PROCESS(id, func)}
+        Process a @c wxEVT_END_PROCESS event, sent by wxProcess::OnTerminate upon
+        the external process termination.
+    @endEventTable
+
     @library{wxbase}
     @category{appmanagement}
 
-    @see wxExecute(), @ref page_samples_exec "exec sample"
+    @see wxExecute(), @ref page_samples_exec
 */
 class wxProcess : public wxEvtHandler
 {
@@ -113,15 +122,20 @@ public:
     void CloseOutput();
 
     /**
+        Detaches this event handler from the parent specified in the constructor
+        (see wxEvtHandler::Unlink() for a similar but not identic function).
+    
         Normally, a wxProcess object is deleted by its parent when it receives the
-        notification about the process termination. However, it might happen that the
-        parent object is destroyed before the external process is terminated (e.g. a
-        window from which this external process was launched is closed by the user)
-        and in this case it @b should not delete the wxProcess object, but
-        @b should call Detach() instead. After the wxProcess object is detached
-        from its parent, no notification events will be sent to the parent and the
-        object will delete itself upon reception of the process termination
-        notification.
+        notification about the process termination. 
+        
+        However, it might happen that the parent object is destroyed before the external 
+        process is terminated (e.g. a window from which this external process was launched 
+        is closed by the user) and in this case it @b should not delete the wxProcess 
+        object, but @b should call Detach() instead. 
+        
+        After the wxProcess object is detached from its parent, no notification events 
+        will be sent to the parent and the object will delete itself upon reception of 
+        the process termination notification.
     */
     void Detach();
 
@@ -155,7 +169,8 @@ public:
     wxOutputStream* GetOutputStream() const;
 
     /**
-        Returns the process ID of the process launched by Open().
+        Returns the process ID of the process launched by Open() or set by
+        wxExecute() (if you passed this wxProcess as argument).
     */
     long GetPid() const;
 
@@ -208,6 +223,8 @@ public:
     /**
         It is called when the process with the pid @a pid finishes.
         It raises a wxWidgets event when it isn't overridden.
+        
+        Note that this function won't be called if you Kill() the process.
 
         @param pid
             The pid of the process which has just terminated.
@@ -258,19 +275,20 @@ public:
 /**
     @class wxProcessEvent
 
-    A process event is sent when a process is terminated.
+    A process event is sent to the wxEvtHandler specified to wxProcess
+    when a process is terminated.
 
     @beginEventTable{wxProcessEvent}
     @event{EVT_END_PROCESS(id, func)}
-           Process a @c wxEVT_END_PROCESS event. @a id is the identifier of the process
-           object (the id passed to the wxProcess constructor) or a window to receive
-           the event.
+        Process a @c wxEVT_END_PROCESS event. @a id is the identifier of the process
+        object (the id passed to the wxProcess constructor) or a window to receive
+        the event.
     @endEventTable
 
     @library{wxbase}
     @category{events}
 
-    @see wxProcess, @ref overview_eventhandling
+    @see wxProcess, @ref overview_events
 */
 class wxProcessEvent : public wxEvent
 {