1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: include/wx/osx/evtloop.h
3 // Purpose: simply forwards to wx/mac/carbon/evtloop.h for consistency with
4 // the other Mac headers
5 // Author: Vadim Zeitlin
9 // Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
10 // Licence: wxWindows licence
11 ///////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_OSX_EVTLOOP_H_
14 #define _WX_OSX_EVTLOOP_H_
16 typedef struct __CFRunLoop
* CFRunLoopRef
;
18 class WXDLLIMPEXP_BASE wxCFEventLoop
: public wxEventLoopBase
22 virtual ~wxCFEventLoop();
24 // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
25 // terminating when Exit() is called
28 // sets the "should exit" flag and wakes up the loop so that it terminates
30 virtual void Exit(int rc
= 0);
32 // return true if any events are available
33 virtual bool Pending() const;
35 // dispatch a single event, return false if we should exit from the loop
36 virtual bool Dispatch();
38 // same as Dispatch() but doesn't wait for longer than the specified (in
39 // ms) timeout, return true if an event was processed, false if we should
40 // exit the loop or -1 if timeout expired
41 virtual int DispatchTimeout(unsigned long timeout
);
43 // implement this to wake up the loop: usually done by posting a dummy event
44 // to it (can be called from non main thread)
45 virtual void WakeUp();
47 virtual bool YieldFor(long eventsToProcess
);
49 #if wxUSE_EVENTLOOP_SOURCE
50 virtual wxEventLoopSource
*
51 AddSourceForFD(int fd
, wxEventLoopSourceHandler
*handler
, int flags
);
52 #endif // wxUSE_EVENTLOOP_SOURCE
55 // get the currently executing CFRunLoop
56 virtual CFRunLoopRef
CFGetCurrentRunLoop() const;
58 virtual int DoDispatchTimeout(unsigned long timeout
);
62 // should we exit the loop?
69 // process all already pending events and dispatch a new one (blocking
70 // until it appears in the event queue if necessary)
72 // returns the return value of DoDispatchTimeout()
73 int DoProcessEvents();
77 #ifdef __WXOSX_COCOA__
78 #include "wx/osx/cocoa/evtloop.h"
80 #include "wx/osx/carbon/evtloop.h"
84 #endif // _WX_OSX_EVTLOOP_H_