Use wxWebKitCtrlNameStr to adhere to the convention used by other wx classes.

[wxWidgets.git] / include / wx / evtloop.h

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index ad58b1482c1e354a6e1353f0a51bf78050a77aca..6da21416a5cb258fe560d0db00cad52b29b49620 100644 (file)
--- a/include/wx/evtloop.h
+++ b/include/wx/evtloop.h
@@ -15,6 +15,20 @@
 #include "wx/event.h"
 #include "wx/utils.h"
 
 #include "wx/event.h"
 #include "wx/utils.h"
 

+// TODO: implement wxEventLoopSource for MSW (it should wrap a HANDLE and be
+//       monitored using MsgWaitForMultipleObjects())
+#if defined(__WXOSX__) || defined(__WXGTK20__) || defined(__WXDFB__) || \
+        (!wxUSE_GUI && defined(__UNIX__))
+    #define wxUSE_EVENTLOOP_SOURCE 1
+#else
+    #define wxUSE_EVENTLOOP_SOURCE 0
+#endif
+
+#if wxUSE_EVENTLOOP_SOURCE
+    class wxEventLoopSource;
+    class wxEventLoopSourceHandler;
+#endif
+

 /*
     NOTE ABOUT wxEventLoopBase::YieldFor LOGIC
     ------------------------------------------
 /*
     NOTE ABOUT wxEventLoopBase::YieldFor LOGIC
     ------------------------------------------


@@ -64,6 +78,12 @@ public:
     // returns true if this is the main loop
     bool IsMain() const;
 
     // returns true if this is the main loop
     bool IsMain() const;
 

+#if wxUSE_EVENTLOOP_SOURCE
+    // create a new event loop source wrapping the given file descriptor and
+    // start monitoring it
+    virtual wxEventLoopSource *
+      AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags) = 0;
+#endif // wxUSE_EVENTLOOP_SOURCE

 
     // dispatch&processing
     // -------------------
 
     // dispatch&processing
     // -------------------


@@ -114,25 +134,25 @@ public:
     // Yield-related hooks
     // -------------------
 
     // Yield-related hooks
     // -------------------
 

-        // process all currently pending events right now
-        //
-        // it is an error to call Yield() recursively unless the value of
-        // onlyIfNeeded is true
-        //
-        // WARNING: this function is dangerous as it can lead to unexpected
-        //          reentrancies (i.e. when called from an event handler it
-        //          may result in calling the same event handler again), use
-        //          with _extreme_ care or, better, don't use at all!
+    // process all currently pending events right now
+    //
+    // it is an error to call Yield() recursively unless the value of
+    // onlyIfNeeded is true
+    //
+    // WARNING: this function is dangerous as it can lead to unexpected
+    //          reentrancies (i.e. when called from an event handler it
+    //          may result in calling the same event handler again), use
+    //          with _extreme_ care or, better, don't use at all!

     bool Yield(bool onlyIfNeeded = false);
     virtual bool YieldFor(long eventsToProcess) = 0;
 
     bool Yield(bool onlyIfNeeded = false);
     virtual bool YieldFor(long eventsToProcess) = 0;
 

-        // returns true if the main thread is inside a Yield() call
+    // returns true if the main thread is inside a Yield() call

     virtual bool IsYielding() const
         { return m_isInsideYield; }
 
     virtual bool IsYielding() const
         { return m_isInsideYield; }
 

-        // returns true if events of the given event category should be immediately
-        // processed inside a wxApp::Yield() call or rather should be queued for
-        // later processing by the main event loop
+    // returns true if events of the given event category should be immediately
+    // processed inside a wxApp::Yield() call or rather should be queued for
+    // later processing by the main event loop

     virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const
         { return (m_eventsToProcessInsideYield & cat) != 0; }
 
     virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const
         { return (m_eventsToProcessInsideYield & cat) != 0; }
 


@@ -197,23 +217,42 @@ protected:
     bool m_shouldExit;
 
 private:
     bool m_shouldExit;
 
 private:

+    // process all already pending events and dispatch a new one (blocking
+    // until it appears in the event queue if necessary)
+    //
+    // returns the return value of Dispatch()
+    bool ProcessEvents();
+

     wxDECLARE_NO_COPY_CLASS(wxEventLoopManual);
 };
 
 #endif // platforms using "manual" loop
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopManual);
 };
 
 #endif // platforms using "manual" loop
 

+// include the header defining wxConsoleEventLoop for Unix systems
+#if defined(__UNIX__)
+    #include "wx/unix/evtloop.h"
+#endif
+

 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for
 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for

-// integration with MFC) but currently this is done for MSW only, other ports
-// should follow a.s.a.p.
+// integration with MFC) but currently this is not done for all ports yet (e.g.
+// wxX11) so fall back to the old wxGUIEventLoop definition below for them
+

 #if defined(__WXPALMOS__)
     #include "wx/palmos/evtloop.h"
 #elif defined(__WXMSW__)
 #if defined(__WXPALMOS__)
     #include "wx/palmos/evtloop.h"
 #elif defined(__WXMSW__)

+    // this header defines both console and GUI loops for MSW

     #include "wx/msw/evtloop.h"
     #include "wx/msw/evtloop.h"

-#elif defined(__WXMAC__)
+#elif defined(__WXOSX__)
+    // CoreFoundation-based event loop is currently in wxBase so include it in
+    // any case too (although maybe it actually shouldn't be there at all)

     #include "wx/osx/evtloop.h"
     #include "wx/osx/evtloop.h"

-#elif defined(__WXCOCOA__)
+#elif wxUSE_GUI
+
+// include the appropriate header defining wxGUIEventLoop
+
+#if defined(__WXCOCOA__)

     #include "wx/cocoa/evtloop.h"
 #elif defined(__WXDFB__)
     #include "wx/dfb/evtloop.h"
     #include "wx/cocoa/evtloop.h"
 #elif defined(__WXDFB__)
     #include "wx/dfb/evtloop.h"


@@ -261,16 +300,13 @@ protected:
 
 #endif // platforms
 
 
 #endif // platforms
 

-// also include the header defining wxConsoleEventLoop for Unix systems
-#if defined(__UNIX__)
-    #include "wx/unix/evtloop.h"
-#endif
+#endif // wxUSE_GUI

 
 

-// we use a class rather than a typedef because wxEventLoop is forward-declared
-// in many places

 #if wxUSE_GUI
 #if wxUSE_GUI

+    // we use a class rather than a typedef because wxEventLoop is
+    // forward-declared in many places

     class wxEventLoop : public wxGUIEventLoop { };
     class wxEventLoop : public wxGUIEventLoop { };

-#else // !GUI
+#else // !wxUSE_GUI

     // we can't define wxEventLoop differently in GUI and base libraries so use
     // a #define to still allow writing wxEventLoop in the user code
     #if wxUSE_CONSOLE_EVENTLOOP && (defined(__WXMSW__) || defined(__UNIX__))
     // we can't define wxEventLoop differently in GUI and base libraries so use
     // a #define to still allow writing wxEventLoop in the user code
     #if wxUSE_CONSOLE_EVENTLOOP && (defined(__WXMSW__) || defined(__UNIX__))