Use wxGetTranslation() instead of _() in the public headers.

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

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index 24ea711ece39e20af4719d81b7bde9d2e5dcb6c4..8dd5d6eb7b6f201f60cd49ddf5d55c615c69bee5 100644 (file)
--- a/include/wx/evtloop.h
+++ b/include/wx/evtloop.h
@@ -4,7 +4,6 @@
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01.06.01
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01.06.01

-// RCS-ID:      $Id$

 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -79,16 +78,19 @@ public:
 
 #if wxUSE_EVENTLOOP_SOURCE
     // create a new event loop source wrapping the given file descriptor and
 
 #if wxUSE_EVENTLOOP_SOURCE
     // create a new event loop source wrapping the given file descriptor and

-    // start monitoring it
-    virtual wxEventLoopSource *
-      AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags) = 0;
+    // monitor it for events occurring on this descriptor in all event loops
+    static wxEventLoopSource *
+      AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags);

 #endif // wxUSE_EVENTLOOP_SOURCE
 
     // dispatch&processing
     // -------------------
 
     // start the event loop, return the exit code when it is finished
 #endif // wxUSE_EVENTLOOP_SOURCE
 
     // dispatch&processing
     // -------------------
 
     // start the event loop, return the exit code when it is finished

-    virtual int Run() = 0;
+    //
+    // notice that wx ports should override DoRun(), this method is virtual
+    // only to allow overriding it in the user code for custom event loops
+    virtual int Run();

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


@@ -97,7 +99,15 @@ public:
     bool IsRunning() const;
 
     // exit from the loop with the given exit code
     bool IsRunning() const;
 
     // exit from the loop with the given exit code

-    virtual void Exit(int rc = 0) = 0;
+    //
+    // this can be only used to exit the currently running loop, use
+    // ScheduleExit() if this might not be the case
+    virtual void Exit(int rc = 0);
+
+    // ask the event loop to exit with the given exit code, can be used even if
+    // this loop is not running right now but the loop must have been started,
+    // i.e. Run() should have been already called
+    virtual void ScheduleExit(int rc = 0) = 0;

 
     // return true if any events are available
     virtual bool Pending() const = 0;
 
     // return true if any events are available
     virtual bool Pending() const = 0;


@@ -169,11 +179,20 @@ public:
 
 
 protected:
 
 
 protected:

+    // real implementation of Run()
+    virtual int DoRun() = 0;
+

     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of
     // an exception thrown from inside the loop)
     virtual void OnExit();
 
     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of
     // an exception thrown from inside the loop)
     virtual void OnExit();
 

+    // Return true if we're currently inside our Run(), even if another nested
+    // event loop is currently running, unlike IsRunning() (which should have
+    // been really called IsActive() but it's too late to change this now).
+    bool IsInsideRun() const { return m_isInsideRun; }
+
+

     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 
     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 


@@ -184,6 +203,10 @@ protected:
     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 
     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 

+private:
+    // this flag is set on entry into Run() and reset before leaving it
+    bool m_isInsideRun;
+

     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 


@@ -198,15 +221,15 @@ class WXDLLIMPEXP_BASE wxEventLoopManual : public wxEventLoopBase
 public:
     wxEventLoopManual();
 
 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
     // sets the "should exit" flag and wakes up the loop so that it terminates
     // soon

-    virtual void Exit(int rc = 0);
+    virtual void ScheduleExit(int rc = 0);

 
 protected:
 
 protected:

+    // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
+    // terminating when Exit() is called
+    virtual int DoRun();
+

     // may be overridden to perform some action at the start of each new event
     // loop iteration
     virtual void OnNextIteration() { }
     // may be overridden to perform some action at the start of each new event
     // loop iteration
     virtual void OnNextIteration() { }


@@ -272,21 +295,7 @@ public:
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 

-#if wxUSE_EVENTLOOP_SOURCE
-    // We need to define a base class pure virtual method but we can't provide
-    // a generic implementation for it so simply fail.
-    virtual wxEventLoopSource *
-    AddSourceForFD(int WXUNUSED(fd),
-                   wxEventLoopSourceHandler * WXUNUSED(handler),
-                   int WXUNUSED(flags))
-    {
-        wxFAIL_MSG( "support for event loop sources not implemented" );
-        return NULL;
-    }
-#endif // wxUSE_EVENTLOOP_SOURCE
-
-    virtual int Run();
-    virtual void Exit(int rc = 0);
+    virtual void ScheduleExit(int rc = 0);

     virtual bool Pending() const;
     virtual bool Dispatch();
     virtual int DispatchTimeout(unsigned long timeout)
     virtual bool Pending() const;
     virtual bool Dispatch();
     virtual int DispatchTimeout(unsigned long timeout)


@@ -307,6 +316,8 @@ public:
     virtual bool YieldFor(long eventsToProcess);
 
 protected:
     virtual bool YieldFor(long eventsToProcess);
 
 protected:

+    virtual int DoRun();
+

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