include/wx/evtloop.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/evtloop.h
   3 // Purpose:     declares wxEventLoop class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     01.06.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_EVTLOOP_H_
  13 #define _WX_EVTLOOP_H_
  14
  15 #include "wx/utils.h"
  16
  17 class WXDLLEXPORT wxEventLoop;
  18
  19 // ----------------------------------------------------------------------------
  20 // wxEventLoop: a GUI event loop
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLEXPORT wxEventLoopBase
  24 {
  25 public:
  26     // trivial, but needed (because of wxEventLoopBase) ctor
  27     wxEventLoopBase() { }
  28
  29     // dtor
  30     virtual ~wxEventLoopBase() { }
  31
  32     // start the event loop, return the exit code when it is finished
  33     virtual int Run() = 0;
  34
  35     // exit from the loop with the given exit code
  36     virtual void Exit(int rc = 0) = 0;
  37
  38     // return true if any events are available
  39     virtual bool Pending() const = 0;
  40
  41     // dispatch a single event, return false if we should exit from the loop
  42     virtual bool Dispatch() = 0;
  43
  44     // is the event loop running now?
  45     virtual bool IsRunning() const = 0;
  46
  47     // return currently active (running) event loop, may be NULL
  48     static wxEventLoop *GetActive() { return ms_activeLoop; }
  49
  50     // set currently active (running) event loop
  51     static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; }
  52
  53 protected:
  54     // this function should be called before the event loop terminates, whether
  55     // this happens normally (because of Exit() call) or abnormally (because of
  56     // an exception thrown from inside the loop)
  57     virtual void OnExit() { }
  58
  59
  60     // the pointer to currently active loop
  61     static wxEventLoop *ms_activeLoop;
  62
  63     DECLARE_NO_COPY_CLASS(wxEventLoopBase)
  64 };
  65
  66 // we're moving away from old m_impl wxEventLoop model as otherwise the user
  67 // code doesn't have access to platform-specific wxEventLoop methods and this
  68 // can sometimes be very useful (e.g. under MSW this is necessary for
  69 // integration with MFC) but currently this is done for MSW only, other ports
  70 // should follow a.s.a.p.
  71 #if defined(__WXPALMOS__)
  72     #include "wx/palmos/evtloop.h"
  73 #elif defined(__WXMSW__)
  74     #include "wx/msw/evtloop.h"
  75 #else
  76
  77 class WXDLLEXPORT wxEventLoopImpl;
  78
  79 class WXDLLEXPORT wxEventLoop : public wxEventLoopBase
  80 {
  81 public:
  82     wxEventLoop() { m_impl = NULL; }
  83     virtual ~wxEventLoop();
  84
  85     virtual int Run();
  86     virtual void Exit(int rc = 0);
  87     virtual bool Pending() const;
  88     virtual bool Dispatch();
  89     virtual bool IsRunning() const { return GetActive() == this; }
  90
  91 protected:
  92     // the pointer to the port specific implementation class
  93     wxEventLoopImpl *m_impl;
  94
  95     DECLARE_NO_COPY_CLASS(wxEventLoop)
  96         };
  97
  98 #endif // __WXMSW__/!__WXMSW__
  99
 100 // ----------------------------------------------------------------------------
 101 // wxModalEventLoop
 102 // ----------------------------------------------------------------------------
 103
 104 // this is a naive generic implementation which uses wxWindowDisabler to
 105 // implement modality, we will surely need platform-specific implementations
 106 // too, this generic implementation is here only temporarily to see how it
 107 // works
 108 class WXDLLEXPORT wxModalEventLoop : public wxEventLoop
 109 {
 110 public:
 111     wxModalEventLoop(wxWindow *winModal)
 112     {
 113         m_windowDisabler = new wxWindowDisabler(winModal);
 114     }
 115
 116 protected:
 117     virtual void OnExit()
 118     {
 119         delete m_windowDisabler;
 120         m_windowDisabler = NULL;
 121
 122         wxEventLoop::OnExit();
 123     }
 124
 125 private:
 126     wxWindowDisabler *m_windowDisabler;
 127 };
 128
 129 #endif // _WX_EVTLOOP_H_