added wxWeakRef<T> (slightly modified patch 1860953)

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

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index 4213af21cd0619fa880da9684218e600bc5a3572..f6d1b55313303ecced284f1c87218e41493769f3 100644 (file)
--- a/include/wx/evtloop.h
+++ b/include/wx/evtloop.h
@@ -14,13 +14,11 @@
 
 #include "wx/utils.h"
 
 
 #include "wx/utils.h"
 

-class WXDLLEXPORT wxEventLoop;
-

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxEventLoop: a GUI event loop
+// wxEventLoopBase: interface for wxEventLoop

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxEventLoopBase
+class WXDLLIMPEXP_BASE wxEventLoopBase

 {
 public:
     // trivial, but needed (because of wxEventLoopBase) ctor
 {
 public:
     // trivial, but needed (because of wxEventLoopBase) ctor


@@ -29,6 +27,10 @@ public:
     // dtor
     virtual ~wxEventLoopBase() { }
 
     // dtor
     virtual ~wxEventLoopBase() { }
 

+    // use this to check whether the event loop was successfully created before
+    // using it
+    virtual bool IsOk() const { return true; }
+

     // start the event loop, return the exit code when it is finished
     virtual int Run() = 0;
 
     // start the event loop, return the exit code when it is finished
     virtual int Run() = 0;
 


@@ -42,10 +44,10 @@ public:
     virtual bool Dispatch() = 0;
 
     // return currently active (running) event loop, may be NULL
     virtual bool Dispatch() = 0;
 
     // return currently active (running) event loop, may be NULL

-    static wxEventLoop *GetActive() { return ms_activeLoop; }
+    static wxEventLoopBase *GetActive() { return ms_activeLoop; }

 
     // set currently active (running) event loop
 
     // set currently active (running) event loop

-    static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; }
+    static void SetActive(wxEventLoopBase* loop) { ms_activeLoop = loop; }

 
     // is this event loop running now?
     //
 
     // is this event loop running now?
     //


@@ -53,6 +55,10 @@ public:
     // spawned a nested (e.g. modal) event loop, this would return false
     bool IsRunning() const;
 
     // spawned a nested (e.g. modal) event loop, this would return false
     bool IsRunning() const;
 

+    // implement this to wake up the loop: usually done by posting a dummy event
+    // to it (can be called from non main thread)
+    virtual void WakeUp() = 0;
+

 protected:
     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of
 protected:
     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of


@@ -61,11 +67,45 @@ protected:
 
 
     // the pointer to currently active loop
 
 
     // the pointer to currently active loop

-    static wxEventLoop *ms_activeLoop;
+    static wxEventLoopBase *ms_activeLoop;

 
     DECLARE_NO_COPY_CLASS(wxEventLoopBase)
 };
 
 
     DECLARE_NO_COPY_CLASS(wxEventLoopBase)
 };
 

+#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXDFB__) || defined(__UNIX__)
+
+// this class can be used to implement a standard event loop logic using
+// Pending() and Dispatch()
+//
+// it also handles idle processing automatically
+class WXDLLIMPEXP_BASE wxEventLoopManual : public wxEventLoopBase
+{
+public:
+    wxEventLoopManual();
+
+    // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
+    // terminating when Exit() is called
+    virtual int Run();
+
+    // sets the "should exit" flag and wakes up the loop so that it terminates
+    // soon
+    virtual void Exit(int rc = 0);
+
+protected:
+    // may be overridden to perform some action at the start of each new event
+    // loop iteration
+    virtual void OnNextIteration() { }
+
+
+    // the loop exit code
+    int m_exitcode;
+
+    // should we exit the loop?
+    bool m_shouldExit;
+};
+
+#endif // platforms using "manual" loop
+

 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for
 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for


@@ -77,32 +117,55 @@ protected:
     #include "wx/msw/evtloop.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/evtloop.h"
     #include "wx/msw/evtloop.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/evtloop.h"

+#elif defined(__WXDFB__)
+    #include "wx/dfb/evtloop.h"

 #else // other platform
 
 #else // other platform
 

-class WXDLLEXPORT wxEventLoopImpl;
+class WXDLLIMPEXP_FWD_CORE wxEventLoopImpl;

 
 

-class WXDLLEXPORT wxEventLoop : public wxEventLoopBase
+class WXDLLEXPORT wxGUIEventLoop : public wxEventLoopBase

 {
 public:
 {
 public:

-    wxEventLoop() { m_impl = NULL; }
-    virtual ~wxEventLoop();
+    wxGUIEventLoop() { m_impl = NULL; }
+    virtual ~wxGUIEventLoop();

 
     virtual int Run();
     virtual void Exit(int rc = 0);
     virtual bool Pending() const;
     virtual bool Dispatch();
 
     virtual int Run();
     virtual void Exit(int rc = 0);
     virtual bool Pending() const;
     virtual bool Dispatch();

+    virtual void WakeUp() { }

 
 protected:
     // the pointer to the port specific implementation class
     wxEventLoopImpl *m_impl;
 
 
 protected:
     // the pointer to the port specific implementation class
     wxEventLoopImpl *m_impl;
 

-    DECLARE_NO_COPY_CLASS(wxEventLoop)
+    DECLARE_NO_COPY_CLASS(wxGUIEventLoop)

 };
 
 #endif // platforms
 
 };
 
 #endif // platforms
 

+// also include the header defining wxConsoleEventLoop for Unix systems
+#if defined(__UNIX__)
+    #include "wx/unix/evtloop.h"
+#endif
+
+// we use a class rather than a typedef because wxEventLoop is forward-declared
+// in many places
+#if wxUSE_GUI
+    class wxEventLoop : public wxGUIEventLoop { };
+#else // !GUI
+    // we can't define wxEventLoop differently in GUI and base libraries so use
+    // a #define to still allow writing wxEventLoop in the user code
+    #if defined(__WXMSW__) || defined(__UNIX__)
+        #define wxEventLoop wxConsoleEventLoop
+    #else // we still must define it somehow for the code below...
+        #define wxEventLoop wxEventLoopBase
+    #endif
+#endif
+

 inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }
 
 inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }
 

+#if wxUSE_GUI

 // ----------------------------------------------------------------------------
 // wxModalEventLoop
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxModalEventLoop
 // ----------------------------------------------------------------------------


@@ -111,7 +174,7 @@ inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }
 // implement modality, we will surely need platform-specific implementations
 // too, this generic implementation is here only temporarily to see how it
 // works
 // implement modality, we will surely need platform-specific implementations
 // too, this generic implementation is here only temporarily to see how it
 // works

-class WXDLLEXPORT wxModalEventLoop : public wxEventLoop
+class WXDLLEXPORT wxModalEventLoop : public wxGUIEventLoop

 {
 public:
     wxModalEventLoop(wxWindow *winModal)
 {
 public:
     wxModalEventLoop(wxWindow *winModal)


@@ -125,13 +188,15 @@ protected:
         delete m_windowDisabler;
         m_windowDisabler = NULL;
 
         delete m_windowDisabler;
         m_windowDisabler = NULL;
 

-        wxEventLoop::OnExit();
+        wxGUIEventLoop::OnExit();

     }
 
 private:
     wxWindowDisabler *m_windowDisabler;
 };
 
     }
 
 private:
     wxWindowDisabler *m_windowDisabler;
 };
 

+#endif //wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // wxEventLoopActivator: helper class for wxEventLoop implementations
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxEventLoopActivator: helper class for wxEventLoop implementations
 // ----------------------------------------------------------------------------


@@ -142,20 +207,20 @@ private:
 class wxEventLoopActivator
 {
 public:
 class wxEventLoopActivator
 {
 public:

-    wxEventLoopActivator(wxEventLoop *evtLoop)
+    wxEventLoopActivator(wxEventLoopBase *evtLoop)

     {
     {

-        m_evtLoopOld = wxEventLoop::GetActive();
-        wxEventLoop::SetActive(evtLoop);
+        m_evtLoopOld = wxEventLoopBase::GetActive();
+        wxEventLoopBase::SetActive(evtLoop);

     }
 
     ~wxEventLoopActivator()
     {
         // restore the previously active event loop
     }
 
     ~wxEventLoopActivator()
     {
         // restore the previously active event loop

-        wxEventLoop::SetActive(m_evtLoopOld);
+        wxEventLoopBase::SetActive(m_evtLoopOld);

     }
 
 private:
     }
 
 private:

-    wxEventLoop *m_evtLoopOld;
+    wxEventLoopBase *m_evtLoopOld;

 };
 
 #endif // _WX_EVTLOOP_H_
 };
 
 #endif // _WX_EVTLOOP_H_