include/wx/osx/core/evtloop.h

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