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 f7071168680ebf16f5dec193b67cc6781e87f0d3..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
 // Purpose:     wxProcess class
 // Author:      Guilhem Lavaux
 // Modified by: Vadim Zeitlin to check error codes, added Detach() method


@@ -55,13 +55,16 @@ public:
 
 
     // ctors
 
 
     // ctors

-    wxProcess(wxEvtHandler *parent = (wxEvtHandler *) NULL, int nId = wxID_ANY)
+    wxProcess(wxEvtHandler *parent = NULL, int nId = wxID_ANY)

         { Init(parent, nId, wxPROCESS_DEFAULT); }
 
     wxProcess(int flags) { Init(NULL, wxID_ANY, flags); }
 
     virtual ~wxProcess();
 
         { Init(parent, nId, wxPROCESS_DEFAULT); }
 
     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);
 
     // may be overridden to be notified about process termination
     virtual void OnTerminate(int pid, int status);
 


@@ -101,10 +104,28 @@ public:
                         wxInputStream *errStream);
 #endif // wxUSE_STREAMS
 
                         wxInputStream *errStream);
 #endif // wxUSE_STREAMS
 

+    // 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;
 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
 
 #if wxUSE_STREAMS
     // these streams are connected to stdout, stderr and stdin of the child


@@ -118,16 +139,16 @@ protected:
     bool m_redirect;
 
     DECLARE_DYNAMIC_CLASS(wxProcess)
     bool m_redirect;
 
     DECLARE_DYNAMIC_CLASS(wxProcess)

-    DECLARE_NO_COPY_CLASS(wxProcess)
+    wxDECLARE_NO_COPY_CLASS(wxProcess);

 };
 
 // ----------------------------------------------------------------------------
 // wxProcess events
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // 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
 {
 
 class WXDLLIMPEXP_BASE wxProcessEvent : public wxEvent
 {


@@ -159,7 +180,7 @@ public:
 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 
 #define wxProcessEventHandler(func) \
 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 
 #define wxProcessEventHandler(func) \

-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxProcessEventFunction, &func)
+    wxEVENT_HANDLER_CAST(wxProcessEventFunction, func)

 
 #define EVT_END_PROCESS(id, func) \
    wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))
 
 #define EVT_END_PROCESS(id, func) \
    wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))