Bring AddActionTrigger() doc string up to date with the interface

[wxWidgets.git] / include / wx / msw / apptbase.h

diff --git a/include/wx/msw/apptbase.h b/include/wx/msw/apptbase.h
index d6843d738df7a7c0f840f7dc1af6e277347b47c1..45251e74a339b02387bcd078feb4d507feb1beb2 100644 (file)
--- a/include/wx/msw/apptbase.h
+++ b/include/wx/msw/apptbase.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     22.06.2003
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     22.06.2003
 // RCS-ID:      $Id$

-// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -26,9 +26,6 @@ public:
     // some opaque data which will be passed later to AfterChildWaitLoop()
     virtual void *BeforeChildWaitLoop() = 0;
 
     // some opaque data which will be passed later to AfterChildWaitLoop()
     virtual void *BeforeChildWaitLoop() = 0;
 

-    // process pending Windows messages, even in console app
-    virtual void AlwaysYield() = 0;
-

     // called after starting to wait for the child termination, the parameter
     // is the return value of BeforeChildWaitLoop()
     virtual void AfterChildWaitLoop(void *data) = 0;
     // called after starting to wait for the child termination, the parameter
     // is the return value of BeforeChildWaitLoop()
     virtual void AfterChildWaitLoop(void *data) = 0;


@@ -41,13 +38,31 @@ public:
     // false if and only if we have to exit the application
     virtual bool DoMessageFromThreadWait() = 0;
 
     // false if and only if we have to exit the application
     virtual bool DoMessageFromThreadWait() = 0;
 

-    // other miscellaneous helpers
-    // ---------------------------
+    // wait for the handle to be signaled, return WAIT_OBJECT_0 if it is or, in
+    // the GUI code, WAIT_OBJECT_0 + 1 if a Windows message arrived
+    virtual WXDWORD WaitForThread(WXHANDLE hThread) = 0;
+
+
+#ifndef __WXWINCE__
+    // console helpers
+    // ---------------
+
+    // this method can be overridden by a derived class to always return true
+    // or false to force [not] using the console for output to stderr
+    //
+    // by default console applications always return true from here while the
+    // GUI ones only return true if they're being run from console and there is
+    // no other activity happening in this console
+    virtual bool CanUseStderr() = 0;
+
+    // write text to the console, return true if ok or false on error
+    virtual bool WriteToStderr(const wxString& text) = 0;
+#endif // !__WXWINCE__

 
 

-    // under MSW this function returns same version for both console and GUI
-    // applications so we can implement it directly in the base class and only
-    // override it wxGUIAppTraits to fill in toolkit information
-    virtual wxToolkitInfo& GetToolkitInfo();
+protected:
+    // implementation of WaitForThread() for the console applications which is
+    // also used by the GUI code if it doesn't [yet|already} dispatch events
+    WXDWORD DoSimpleWaitForThread(WXHANDLE hThread);

 };
 
 #endif // _WX_MSW_APPTBASE_H_
 };
 
 #endif // _WX_MSW_APPTBASE_H_