added wxApp::IsMainLoopRunnning() (see bug 994293)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29645 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index 3606ab231be539cabf6a8433e84895fb612e18c9..c0a89645afa9a2d10599518a40acf8a1d1b3ee53 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -207,6 +207,18 @@ attract users attention to the application, you may use
 to do it.
 
 
+\membersection{wxApp::IsMainLoopRunning}\label{wxappismainlooprunning}
+
+\constfunc{bool}{IsMainLoopRunning}{\void}
+
+Returns \true if the main event loop is currently running, i.e. if the
+application is inside \helpref{OnRun}{wxapponrun}.
+
+This can be useful to test whether the events can be dispatched. For example,
+if this function returns \false, non-blocking sockets cannot be used because
+the events from them would never be processed.
+
+
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
 
 \func{virtual int}{MainLoop}{\void}

diff --git a/include/wx/app.h b/include/wx/app.h
index d4648e873d2d58853740a7141341b301ffddff96..4eae440186f8fee3691237cba975e648c8ababd7 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -376,6 +376,17 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
+        // return true if we're running main loop, i.e. if the events can
+        // (already) be dispatched
+    bool IsMainLoopRunning() const
+    {
+#if wxUSE_EVTLOOP_IN_APP
+        return m_mainLoop != NULL;
+#else
+        return false;
+#endif
+    }
+
         // execute the main GUI loop, the function returns when the loop ends
     virtual int MainLoop();