include/wx/osx/evtloop.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/evtloop.h
   3 // Purpose:     simply forwards to wx/osx/carbon/evtloop.h or
   4 //              wx/osx/cocoa/evtloop.h for consistency with the other Mac
   5 //              headers
   6 // Author:      Vadim Zeitlin
   7 // Modified by:
   8 // Created:     2006-01-12
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
  11 // Licence:     wxWindows licence
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_OSX_EVTLOOP_H_
  15 #define _WX_OSX_EVTLOOP_H_
  16
  17 DECLARE_WXOSX_OPAQUE_CFREF( CFRunLoop );
  18 DECLARE_WXOSX_OPAQUE_CFREF( CFRunLoopObserver );
  19
  20 class WXDLLIMPEXP_BASE wxCFEventLoopPauseIdleEvents;
  21
  22 class WXDLLIMPEXP_BASE wxCFEventLoop : public wxEventLoopBase
  23 {
  24     friend class wxCFEventLoopPauseIdleEvents;
  25 public:
  26     wxCFEventLoop();
  27     virtual ~wxCFEventLoop();
  28
  29     // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
  30     // terminating when Exit() is called
  31     virtual int Run();
  32
  33     // sets the "should exit" flag and wakes up the loop so that it terminates
  34     // soon
  35     virtual void Exit(int rc = 0);
  36
  37     // return true if any events are available
  38     virtual bool Pending() const;
  39
  40     // dispatch a single event, return false if we should exit from the loop
  41     virtual bool Dispatch();
  42
  43     // same as Dispatch() but doesn't wait for longer than the specified (in
  44     // ms) timeout, return true if an event was processed, false if we should
  45     // exit the loop or -1 if timeout expired
  46     virtual int DispatchTimeout(unsigned long timeout);
  47
  48     // implement this to wake up the loop: usually done by posting a dummy event
  49     // to it (can be called from non main thread)
  50     virtual void WakeUp();
  51
  52     virtual bool YieldFor(long eventsToProcess);
  53
  54 #if wxUSE_EVENTLOOP_SOURCE
  55     virtual wxEventLoopSource *
  56       AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags);
  57 #endif // wxUSE_EVENTLOOP_SOURCE
  58
  59 protected:
  60     void CommonModeObserverCallBack(CFRunLoopObserverRef observer, int activity);
  61     void DefaultModeObserverCallBack(CFRunLoopObserverRef observer, int activity);
  62
  63     // set to false to avoid idling at unexpected moments - eg when having native message boxes
  64     void SetProcessIdleEvents(bool process) { m_processIdleEvents = process; }
  65
  66     static void OSXCommonModeObserverCallBack(CFRunLoopObserverRef observer, int activity, void *info);
  67     static void OSXDefaultModeObserverCallBack(CFRunLoopObserverRef observer, int activity, void *info);
  68
  69     // get the currently executing CFRunLoop
  70     virtual CFRunLoopRef CFGetCurrentRunLoop() const;
  71
  72     virtual int DoDispatchTimeout(unsigned long timeout);
  73
  74     virtual void DoRun();
  75
  76     virtual void DoStop();
  77
  78     // should we exit the loop?
  79     bool m_shouldExit;
  80
  81     // the loop exit code
  82     int m_exitcode;
  83
  84     // cfrunloop
  85     CFRunLoopRef m_runLoop;
  86
  87     // common modes runloop observer
  88     CFRunLoopObserverRef m_commonModeRunLoopObserver;
  89
  90     // default mode runloop observer
  91     CFRunLoopObserverRef m_defaultModeRunLoopObserver;
  92
  93     // set to false to avoid idling at unexpected moments - eg when having native message boxes
  94     bool m_processIdleEvents;
  95
  96 private:
  97     // process all already pending events and dispatch a new one (blocking
  98     // until it appears in the event queue if necessary)
  99     //
 100     // returns the return value of DoDispatchTimeout()
 101     int DoProcessEvents();
 102
 103     wxDECLARE_NO_COPY_CLASS(wxCFEventLoop);
 104 };
 105
 106 class WXDLLIMPEXP_BASE wxCFEventLoopPauseIdleEvents : public wxObject
 107 {
 108 public:
 109     wxCFEventLoopPauseIdleEvents();
 110     virtual ~wxCFEventLoopPauseIdleEvents();
 111 };
 112
 113 #if wxUSE_GUI
 114
 115 #ifdef __WXOSX_COCOA__
 116     #include "wx/osx/cocoa/evtloop.h"
 117 #else
 118     #include "wx/osx/carbon/evtloop.h"
 119 #endif
 120
 121 class WXDLLIMPEXP_FWD_CORE wxWindow;
 122 class WXDLLIMPEXP_FWD_CORE wxNonOwnedWindow;
 123
 124 class WXDLLIMPEXP_CORE wxModalEventLoop : public wxGUIEventLoop
 125 {
 126 public:
 127     wxModalEventLoop(wxWindow *modalWindow);
 128     wxModalEventLoop(WXWindow modalNativeWindow);
 129
 130 protected:
 131     virtual void DoRun();
 132
 133     virtual void DoStop();
 134
 135     // (in case) the modal window for this event loop
 136     wxNonOwnedWindow* m_modalWindow;
 137     WXWindow m_modalNativeWindow;
 138 };
 139
 140 #endif // wxUSE_GUI
 141
 142 #endif // _WX_OSX_EVTLOOP_H_