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 1401717d767a6e04ab8c220a86649f0d50ce0f79..4a5585f81a2594a1f5777c88d643ae883107fb2a 100644 (file)
--- a/interface/wx/process.h
+++ b/interface/wx/process.h
@@ -44,7 +44,6 @@ enum wxKillError
 
 /**
     @class wxProcess
 
 /**
     @class wxProcess

-    @wxheader{process.h}

 
     The objects of this class are used in conjunction with the ::wxExecute() function.
     When a wxProcess object is passed to ::wxExecute(), its OnTerminate() virtual method
 
     The objects of this class are used in conjunction with the ::wxExecute() function.
     When a wxProcess object is passed to ::wxExecute(), its OnTerminate() virtual method


@@ -52,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.
 
     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().
 
     wxProcess also supports IO redirection of the child process. For this, you have
     to call its Redirect() method before passing it to ::wxExecute().


@@ -64,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.
 
     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}
 
     @library{wxbase}
     @category{appmanagement}
 

-    @see wxExecute(), @ref page_samples_exec "exec sample"
+    @see wxExecute(), @ref page_samples_exec

 */
 class wxProcess : public wxEvtHandler
 {
 */
 class wxProcess : public wxEvtHandler
 {


@@ -101,7 +109,7 @@ public:
     /**
         Destroys the wxProcess object.
     */
     /**
         Destroys the wxProcess object.
     */

-    ~wxProcess();
+    virtual ~wxProcess();

 
     /**
         Closes the output stream (the one connected to the stdin of the child
 
     /**
         Closes the output stream (the one connected to the stdin of the child


@@ -114,15 +122,20 @@ public:
     void CloseOutput();
 
     /**
     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
         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();
 
     */
     void Detach();
 


@@ -156,7 +169,8 @@ public:
     wxOutputStream* GetOutputStream() const;
 
     /**
     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;
 
     */
     long GetPid() const;
 


@@ -203,19 +217,21 @@ public:
 
         @see Exists(), wxKill(), @ref page_samples_exec "Exec sample"
     */
 
         @see Exists(), wxKill(), @ref page_samples_exec "Exec sample"
     */

-    static wxKillError Kill(int pid, wxSignal signal = wxSIGNONE,
+    static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM,

                             int flags = wxKILL_NOCHILDREN);
 
     /**
         It is called when the process with the pid @a pid finishes.
         It raises a wxWidgets event when it isn't overridden.
                             int flags = wxKILL_NOCHILDREN);
 
     /**
         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.
         @param status
             The exit code of the process.
     */
 
         @param pid
             The pid of the process which has just terminated.
         @param status
             The exit code of the process.
     */

-    void OnTerminate(int pid, int status);
+    virtual void OnTerminate(int pid, int status);

 
     /**
         This static method replaces the standard @c popen() function: it launches
 
     /**
         This static method replaces the standard @c popen() function: it launches


@@ -258,21 +274,21 @@ public:
 
 /**
     @class wxProcessEvent
 
 /**
     @class wxProcessEvent

-    @wxheader{process.h}

 
 

-    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)}
 
     @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}
 
     @endEventTable
 
     @library{wxbase}
     @category{events}
 

-    @see wxProcess, @ref overview_eventhandling
+    @see wxProcess, @ref overview_events

 */
 class wxProcessEvent : public wxEvent
 {
 */
 class wxProcessEvent : public wxEvent
 {


@@ -292,6 +308,6 @@ public:
     /**
         Returns the process id.
     */
     /**
         Returns the process id.
     */

-    int GetPid() const;
+    int GetPid();

 };
 
 };