added wxApp::Yield()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12095 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/app.h

@@ -65,9 +65,6 @@ public:
 
     // the virtual functions which may/must be overridden in the derived class
     // -----------------------------------------------------------------------
-#ifdef __DARWIN__
-    virtual ~wxAppBase() { }
-#endif
 
         // called during the program initialization, returning FALSE from here
         // prevents the program from continuing - it's a good place to create
@@ -135,6 +132,17 @@ public:
         // process the first event in the event queue (blocks until an event
         // apperas if there are none currently)
     virtual void Dispatch() = 0;
+
+        // process all currently pending events right now
+        //
+        // it is an error to call Yield() recursively unless the value of
+        // onlyIfNeeded is TRUE
+        //
+        // WARNING: this function is dangerous as it can lead to unexpected
+        //          reentrancies (i.e. when called from an event handler it
+        //          may result in calling the same event handler again), use
+        //          with _extreme_ care or, better, don't use at all!
+    virtual bool Yield(bool onlyIfNeeded = FALSE) = 0;
 #endif // wxUSE_GUI
 
     // application info: name, description, vendor
@@ -285,6 +293,11 @@ public:
     static wxAppInitializerFunction GetInitializerFunction()
         { return m_appInitFn; }
 
+    // needed to avoid link errors
+#ifdef __DARWIN__
+    virtual ~wxAppBase() { }
+#endif
+
     // process all events in the wxPendingEvents list
     virtual void ProcessPendingEvents();
 

include/wx/gtk/app.h

@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        app.h
+// Name:        wx/gtk/app.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -46,6 +46,7 @@ public:
     virtual bool Initialized();
     virtual bool Pending();
     virtual void Dispatch();
+    virtual bool Yield(bool onlyIfNeeded = FALSE);
 
     virtual wxIcon GetStdIcon(int which) const;
 

include/wx/gtk1/app.h

@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        app.h
+// Name:        wx/gtk/app.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -46,6 +46,7 @@ public:
     virtual bool Initialized();
     virtual bool Pending();
     virtual void Dispatch();
+    virtual bool Yield(bool onlyIfNeeded = FALSE);
 
     virtual wxIcon GetStdIcon(int which) const;
 

include/wx/mac/app.h

@@ -51,6 +51,7 @@ class WXDLLEXPORT wxApp: public wxAppBase
   virtual bool Initialized();
   virtual bool Pending() ;
   virtual void Dispatch() ;
+  virtual bool Yield(bool onlyIfNeeded = FALSE);
 
   virtual wxIcon GetStdIcon(int which) const;
   virtual void SetPrintMode(int mode) { m_printMode = mode; }

include/wx/motif/app.h

@@ -53,6 +53,7 @@ public:
     virtual bool Initialized();
     virtual bool Pending();
     virtual void Dispatch();
+    virtual bool Yield(bool onlyIfNeeded = FALSE);
 
     virtual bool OnInitGui();
 

include/wx/msw/app.h

@@ -41,6 +41,7 @@ public:
     virtual bool Initialized();
     virtual bool Pending();
     virtual void Dispatch();
+    virtual bool Yield(bool onlyIfNeeded = FALSE);
 
     virtual wxIcon GetStdIcon(int which) const;
 

include/wx/os2/app.h

@@ -76,6 +76,7 @@ public:
     virtual bool Initialized(void);
     virtual bool Pending(void) ;
     virtual void Dispatch(void);
+    virtual bool Yield(bool onlyIfNeeded = FALSE);
 
     virtual wxIcon GetStdIcon(int which) const;
 

include/wx/utils.h

@@ -20,7 +20,6 @@
     #pragma interface "utils.h"
 #endif
 
-#include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/list.h"
 #include "wx/filefn.h"