Faster Deselect

[wxWidgets.git] / docs / latex / wx / app.tex

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index d230d5d265ee4ca5dbb75dd50c1e361676950259..49a09ab262e16ad28fd9a37818fbbf71556a3008 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -33,14 +33,14 @@ a reference to your application object) to be visible to other files.
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxApp::wxApp}
+\membersection{wxApp::wxApp}\label{wxappctor}
 
 \func{void}{wxApp}{\void}
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
 
-\membersection{wxApp::\destruct{wxApp}}
+\membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}
 
 \func{void}{\destruct{wxApp}}{\void}
 
@@ -76,7 +76,7 @@ implementation returns a new wxLogGui class.
 
 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 
-\func{void}{Dispatch}{\void}
+\func{virtual void}{Dispatch}{\void}
 
 Dispatches the next event in the windowing system event queue.
 
@@ -104,6 +104,15 @@ had been already processed (for the former return value) or that it is not
 going to be processed at all (for the latter one).
 
 
+\membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
+
+\func{virtual void}{ExitMainLoop}{\void}
+
+Call this to explicitly exit the main message (event) loop.
+You should normally exit the main loop (and the application) by deleting
+the top window.
+
+
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
@@ -187,18 +196,32 @@ different visuals, false otherwise.
 Returns the application's vendor name.
 
 
-\membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
+\membersection{wxApp::IsActive}\label{wxappisactive}
 
-\func{void}{ExitMainLoop}{\void}
+\constfunc{bool}{IsActive}{\void}
 
-Call this to explicitly exit the main message (event) loop.
-You should normally exit the main loop (and the application) by deleting
-the top window.
+Returns \true if the application is active, i.e. if one of its windows is
+currently in the foreground. If this function returns \false and you need to
+attract users attention to the application, you may use 
+\helpref{wxTopLevelWindow::RequestUserAttention}{wxtoplevelwindowrequestuserattention} 
+to do it.
+
+
+\membersection{wxApp::IsMainLoopRunning}\label{wxappismainlooprunning}
+
+\func{static 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{int}{MainLoop}{\void}
+\func{virtual int}{MainLoop}{\void}
 
 Called by wxWidgets on creation of the application. Override this if you wish
 to provide your own (environment-dependent) main loop.
@@ -320,7 +343,7 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
 
-\membersection{wxApp::OnExceptionInMainLoop}{wxapponexceptioninmainloop}
+\membersection{wxApp::OnExceptionInMainLoop}\label{wxapponexceptioninmainloop}
 
 \func{virtual bool}{OnExceptionInMainLoop}{\void}
 
@@ -539,7 +562,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg)
 
 \membersection{wxApp::Pending}\label{wxapppending}
 
-\func{bool}{Pending}{\void}
+\func{virtual bool}{Pending}{\void}
 
 Returns true if unprocessed events are in the window system event queue.