include/wx/msw/evtloop.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/evtloop.h
   3 // Purpose:     wxEventLoop class for MSW
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2004-07-31
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003-2004 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSW_EVTLOOP_H_
  13 #define _WX_MSW_EVTLOOP_H_
  14
  15 #if wxUSE_GUI
  16 #include "wx/window.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // wxEventLoop
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLIMPEXP_BASE wxMSWEventLoopBase : public wxEventLoopManual
  24 {
  25 public:
  26     wxMSWEventLoopBase();
  27
  28     // implement base class pure virtuals
  29     virtual bool Pending() const;
  30
  31 protected:
  32     // get the next message from queue and return true or return false if we
  33     // got WM_QUIT or an error occurred
  34     bool GetNextMessage(WXMSG *msg);
  35
  36     // same as above but with a timeout and return value can be -1 meaning that
  37     // time out expired in addition to
  38     int GetNextMessageTimeout(WXMSG *msg, unsigned long timeout);
  39 };
  40
  41 #if wxUSE_GUI
  42
  43 WX_DECLARE_OBJARRAY(MSG, wxMSGArray);
  44
  45 class WXDLLIMPEXP_CORE wxGUIEventLoop : public wxMSWEventLoopBase
  46 {
  47 public:
  48     wxGUIEventLoop() { }
  49
  50     // process a single message: calls PreProcessMessage() before dispatching
  51     // it
  52     virtual void ProcessMessage(WXMSG *msg);
  53
  54     // preprocess a message, return true if processed (i.e. no further
  55     // dispatching required)
  56     virtual bool PreProcessMessage(WXMSG *msg);
  57
  58     // set the critical window: this is the window such that all the events
  59     // except those to this window (and its children) stop to be processed
  60     // (typical examples: assert or crash report dialog)
  61     //
  62     // calling this function with NULL argument restores the normal event
  63     // handling
  64     static void SetCriticalWindow(wxWindowMSW *win) { ms_winCritical = win; }
  65
  66     // return true if there is no critical window or if this window is [a child
  67     // of] the critical one
  68     static bool AllowProcessing(wxWindowMSW *win)
  69     {
  70         return !ms_winCritical || IsChildOfCriticalWindow(win);
  71     }
  72
  73     // override/implement base class virtuals
  74     virtual bool Dispatch();
  75     virtual int DispatchTimeout(unsigned long timeout);
  76     virtual void WakeUp();
  77     virtual bool YieldFor(long eventsToProcess);
  78
  79 protected:
  80     virtual void OnNextIteration();
  81
  82 private:
  83     // check if the given window is a child of ms_winCritical (which must be
  84     // non NULL)
  85     static bool IsChildOfCriticalWindow(wxWindowMSW *win);
  86
  87     // array of messages used for temporary storage by YieldFor()
  88     wxMSGArray m_arrMSG;
  89
  90     // critical window or NULL
  91     static wxWindowMSW *ms_winCritical;
  92 };
  93
  94 #else // !wxUSE_GUI
  95
  96 #if wxUSE_CONSOLE_EVENTLOOP
  97
  98 class WXDLLIMPEXP_BASE wxConsoleEventLoop : public wxMSWEventLoopBase
  99 {
 100 public:
 101     wxConsoleEventLoop() { }
 102
 103     // override/implement base class virtuals
 104     virtual bool Dispatch();
 105     virtual int DispatchTimeout(unsigned long timeout);
 106     virtual void WakeUp();
 107     virtual bool YieldFor(long WXUNUSED(eventsToProcess)) { return true; }
 108
 109     // MSW-specific function to process a single message
 110     virtual void ProcessMessage(WXMSG *msg);
 111 };
 112
 113 #endif // wxUSE_CONSOLE_EVENTLOOP
 114
 115 #endif // wxUSE_GUI/!wxUSE_GUI
 116
 117 #endif // _WX_MSW_EVTLOOP_H_