]> git.saurik.com Git - wxWidgets.git/blame - include/wx/osx/core/evtloop.h
Use correct extensions in wxDynamicLibrary::CanonicalizeName() on OS X.
[wxWidgets.git] / include / wx / osx / core / evtloop.h
CommitLineData
7ce6da52
VZ
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
15DECLARE_WXOSX_OPAQUE_CFREF( CFRunLoop );
16DECLARE_WXOSX_OPAQUE_CFREF( CFRunLoopObserver );
17
754afd10 18class WXDLLIMPEXP_FWD_BASE wxCFEventLoopPauseIdleEvents;
7ce6da52
VZ
19
20class WXDLLIMPEXP_BASE wxCFEventLoop : public wxEventLoopBase
21{
22 friend class wxCFEventLoopPauseIdleEvents;
23public:
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
19736e64 57 bool ShouldProcessIdleEvents() const { return m_processIdleEvents ; }
7ce6da52
VZ
58protected:
59 void CommonModeObserverCallBack(CFRunLoopObserverRef observer, int activity);
60 void DefaultModeObserverCallBack(CFRunLoopObserverRef observer, int activity);
61
62 // set to false to avoid idling at unexpected moments - eg when having native message boxes
63 void SetProcessIdleEvents(bool process) { m_processIdleEvents = process; }
64
65 static void OSXCommonModeObserverCallBack(CFRunLoopObserverRef observer, int activity, void *info);
66 static void OSXDefaultModeObserverCallBack(CFRunLoopObserverRef observer, int activity, void *info);
67
68 // get the currently executing CFRunLoop
69 virtual CFRunLoopRef CFGetCurrentRunLoop() const;
70
71 virtual int DoDispatchTimeout(unsigned long timeout);
72
73 virtual void DoRun();
74
75 virtual void DoStop();
76
77 // should we exit the loop?
78 bool m_shouldExit;
79
80 // the loop exit code
81 int m_exitcode;
82
83 // cfrunloop
84 CFRunLoopRef m_runLoop;
85
86 // common modes runloop observer
87 CFRunLoopObserverRef m_commonModeRunLoopObserver;
88
89 // default mode runloop observer
90 CFRunLoopObserverRef m_defaultModeRunLoopObserver;
91
92 // set to false to avoid idling at unexpected moments - eg when having native message boxes
93 bool m_processIdleEvents;
94
95private:
96 // process all already pending events and dispatch a new one (blocking
97 // until it appears in the event queue if necessary)
98 //
99 // returns the return value of DoDispatchTimeout()
100 int DoProcessEvents();
101
102 wxDECLARE_NO_COPY_CLASS(wxCFEventLoop);
103};
104
105class WXDLLIMPEXP_BASE wxCFEventLoopPauseIdleEvents : public wxObject
106{
107public:
108 wxCFEventLoopPauseIdleEvents();
109 virtual ~wxCFEventLoopPauseIdleEvents();
19736e64
SC
110private:
111 bool m_formerState;
7ce6da52
VZ
112};
113
114#endif // _WX_OSX_EVTLOOP_H_