Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/process.h b/include/wx/process.h
index 2089c497ac19f075f65144ec41a024bda29fb787..5a893a7ed5d486cffe42dd1ab9de3652f824ad34 100644 (file)
--- a/include/wx/process.h
+++ b/include/wx/process.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        process.h
+// Name:        wx/process.h
 // Purpose:     wxProcess class
 // Author:      Guilhem Lavaux
 // Modified by: Vadim Zeitlin to check error codes, added Detach() method
@@ -12,10 +12,6 @@
 #ifndef _WX_PROCESSH__
 #define _WX_PROCESSH__
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "process.h"
-#endif
-
 #include "wx/event.h"
 
 #if wxUSE_STREAMS
@@ -43,7 +39,7 @@ class WXDLLIMPEXP_BASE wxProcess : public wxEvtHandler
 {
 public:
     // kill the process with the given PID
-    static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM);
+    static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM, int flags = wxKILL_NOCHILDREN);
 
     // test if the given process exists
     static bool Exists(int pid);
@@ -59,20 +55,23 @@ public:
 
 
     // ctors
-    wxProcess(wxEvtHandler *parent = (wxEvtHandler *) NULL, int id = -1)
-        { Init(parent, id, wxPROCESS_DEFAULT); }
+    wxProcess(wxEvtHandler *parent = NULL, int nId = wxID_ANY)
+        { Init(parent, nId, wxPROCESS_DEFAULT); }
 
-    wxProcess(int flags) { Init(NULL, -1, flags); }
+    wxProcess(int flags) { Init(NULL, wxID_ANY, flags); }
 
     virtual ~wxProcess();
 
+    // get the process ID of the process executed by Open()
+    long GetPid() const { return m_pid; }
+
     // may be overridden to be notified about process termination
     virtual void OnTerminate(int pid, int status);
 
     // call this before passing the object to wxExecute() to redirect the
     // launched process stdin/stdout, then use GetInputStream() and
     // GetOutputStream() to get access to them
-    void Redirect() { m_redirect = TRUE; }
+    void Redirect() { m_redirect = true; }
     bool IsRedirected() const { return m_redirect; }
 
     // detach from the parent - should be called by the parent if it's deleted
@@ -88,10 +87,10 @@ public:
     // close the output stream indicating that nothing more will be written
     void CloseOutput() { delete m_outputStream; m_outputStream = NULL; }
 
-    // return TRUE if the child process stdout is not closed
+    // return true if the child process stdout is not closed
     bool IsInputOpened() const;
 
-    // return TRUE if any input is available on the child process stdout/err
+    // return true if any input is available on the child process stdout/err
     bool IsInputAvailable() const;
     bool IsErrorAvailable() const;
 
@@ -105,16 +104,28 @@ public:
                         wxInputStream *errStream);
 #endif // wxUSE_STREAMS
 
-    // for backwards compatibility only, don't use
-#if WXWIN_COMPATIBILITY_2_2
-    wxProcess(wxEvtHandler *parent, bool redirect)
-        { Init(parent, -1, redirect ? wxPROCESS_REDIRECT : wxPROCESS_DEFAULT); }
-#endif // WXWIN_COMPATIBILITY_2_2
+    // priority
+        // Sets the priority to the given value: see wxPRIORITY_XXX constants.
+        //
+        // NB: the priority can only be set before the process is created
+    void SetPriority(unsigned priority);
+
+        // Get the current priority.
+    unsigned GetPriority() const { return m_priority; }
+
+    // implementation only - don't use!
+    // --------------------------------
+
+    // needs to be public since it needs to be used from wxExecute() global func
+    void SetPid(long pid) { m_pid = pid; }
 
 protected:
     void Init(wxEvtHandler *parent, int id, int flags);
 
     int m_id;
+    long m_pid;
+
+    unsigned m_priority;
 
 #if wxUSE_STREAMS
     // these streams are connected to stdout, stderr and stdin of the child
@@ -128,21 +139,21 @@ protected:
     bool m_redirect;
 
     DECLARE_DYNAMIC_CLASS(wxProcess)
-    DECLARE_NO_COPY_CLASS(wxProcess)
+    wxDECLARE_NO_COPY_CLASS(wxProcess);
 };
 
 // ----------------------------------------------------------------------------
 // wxProcess events
 // ----------------------------------------------------------------------------
 
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, 440)
-END_DECLARE_EVENT_TYPES()
+class WXDLLIMPEXP_FWD_BASE wxProcessEvent;
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, wxProcessEvent );
 
 class WXDLLIMPEXP_BASE wxProcessEvent : public wxEvent
 {
 public:
-    wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0) : wxEvent(id)
+    wxProcessEvent(int nId = 0, int pid = 0, int exitcode = 0) : wxEvent(nId)
     {
         m_eventType = wxEVT_END_PROCESS;
         m_pid = pid;
@@ -168,10 +179,10 @@ public:
 
 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 
+#define wxProcessEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxProcessEventFunction, func)
+
 #define EVT_END_PROCESS(id, func) \
-   DECLARE_EVENT_TABLE_ENTRY( \
-           wxEVT_END_PROCESS, id, -1, \
-           (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxProcessEventFunction, & func ), NULL),
+   wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))
 
-#endif
-    // _WX_PROCESSH__
+#endif // _WX_PROCESSH__