added operators for comparing wxString to wxCStrData

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

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index 07ba0008e02cd166906a183fd0093c17e9dfe544..ff0ee61d3fb8456b88c90f39c447d18ba7f4a240 100644 (file)
--- a/include/wx/evtloop.h
+++ b/include/wx/evtloop.h
@@ -12,19 +12,15 @@
 #ifndef _WX_EVTLOOP_H_
 #define _WX_EVTLOOP_H_
 
 #ifndef _WX_EVTLOOP_H_
 #define _WX_EVTLOOP_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "evtloop.h"
-#endif
-

 #include "wx/utils.h"
 
 class WXDLLEXPORT wxEventLoop;
 
 // ----------------------------------------------------------------------------
 #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


@@ -33,6 +29,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;
 


@@ -45,15 +45,22 @@ public:
     // dispatch a single event, return false if we should exit from the loop
     virtual bool Dispatch() = 0;
 
     // dispatch a single event, return false if we should exit from the loop
     virtual bool Dispatch() = 0;
 

-    // is the event loop running now?
-    virtual bool IsRunning() const = 0;
-

     // return currently active (running) event loop, may be NULL
     static wxEventLoop *GetActive() { return ms_activeLoop; }
 
     // set currently active (running) event loop
     static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; }
 
     // return currently active (running) event loop, may be NULL
     static wxEventLoop *GetActive() { return ms_activeLoop; }
 
     // set currently active (running) event loop
     static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; }
 

+    // is this event loop running now?
+    //
+    // notice that even if this event loop hasn't terminated yet but has just
+    // 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


@@ -67,40 +74,95 @@ protected:
     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
 // integration with MFC) but currently this is done for MSW only, other ports
 // should follow a.s.a.p.
 // 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
 // integration with MFC) but currently this is done for MSW only, other ports
 // should follow a.s.a.p.

-#if defined(__PALMOS__)
+#if defined(__WXPALMOS__)

     #include "wx/palmos/evtloop.h"
 #elif defined(__WXMSW__)
     #include "wx/msw/evtloop.h"
     #include "wx/palmos/evtloop.h"
 #elif defined(__WXMSW__)
     #include "wx/msw/evtloop.h"

-#else
+#elif defined(__WXMAC__)
+    #include "wx/mac/evtloop.h"
+#elif defined(__WXDFB__)
+    #include "wx/dfb/evtloop.h"
+#else // other platform

 
 class WXDLLEXPORT wxEventLoopImpl;
 
 
 class WXDLLEXPORT 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 bool IsRunning() const { return GetActive() == this; }
+    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
+
+// also include the header defining wxConsoleEventLoop for Unix systems
+#if defined(__UNIX__)
+    #include "wx/unix/evtloop.h"
+#endif
+
+// cannot use typedef because wxEventLoop is forward-declared in many places
+#if wxUSE_GUI
+class wxEventLoop : public wxGUIEventLoop { };
+#elif defined(__WXMSW__) || defined(__UNIX__)
+class wxEventLoop : public wxConsoleEventLoop { };
+#else // we still must define it somehow for the code below...
+class wxEventLoop : public wxEventLoopBase { };
+#endif

 
 

-#endif // __WXMSW__/!__WXMSW__
+inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }

 
 

+#if wxUSE_GUI

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


@@ -109,7 +171,7 @@ protected:
 // 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)


@@ -123,11 +185,39 @@ 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
+// ----------------------------------------------------------------------------
+
+// this object sets the wxEventLoop given to the ctor as the currently active
+// one and unsets it in its dtor, this is especially useful in presence of
+// exceptions but is more tidy even when we don't use them
+class wxEventLoopActivator
+{
+public:
+    wxEventLoopActivator(wxEventLoopBase *evtLoop)
+    {
+        m_evtLoopOld = wxEventLoopBase::GetActive();
+        wxEventLoopBase::SetActive(wx_static_cast(wxEventLoop *, evtLoop));
+    }
+
+    ~wxEventLoopActivator()
+    {
+        // restore the previously active event loop
+        wxEventLoopBase::SetActive(m_evtLoopOld);
+    }
+
+private:
+    wxEventLoop *m_evtLoopOld;
+};
+

 #endif // _WX_EVTLOOP_H_
 #endif // _WX_EVTLOOP_H_