]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/app.tex
wxURI/wxURL links in changes list.
[wxWidgets.git] / docs / latex / wx / app.tex
index 9c5457aba16c62875eb48e24cdb483f3236eba45..2929b042183f2d214a24c34719f3e6d810ca6da8 100644 (file)
@@ -33,14 +33,14 @@ a reference to your application object) to be visible to other files.
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 
 
 \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}
 
 
 \func{void}{\destruct{wxApp}}{\void}
 
@@ -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).
 
 
 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}
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
@@ -116,17 +125,6 @@ wxWidgets sets this to a reasonable default before
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
 
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
 
-\membersection{wxApp::GetAuto3D}\label{wxappgetauto3d}
-
-\constfunc{bool}{GetAuto3D}{\void}
-
-Returns true if 3D control mode is on, false otherwise.
-
-\wxheading{See also}
-
-\helpref{wxApp::SetAuto3D}{wxappsetauto3d}
-
-
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 
 \constfunc{wxString}{GetClassName}{\void}
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 
 \constfunc{wxString}{GetClassName}{\void}
@@ -187,13 +185,27 @@ different visuals, false otherwise.
 Returns the application's vendor name.
 
 
 Returns the application's vendor name.
 
 
-\membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
+\membersection{wxApp::IsActive}\label{wxappisactive}
 
 
-\func{virtual 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}
 
 
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
@@ -320,7 +332,7 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
 
-\membersection{wxApp::OnExceptionInMainLoop}{wxapponexceptioninmainloop}
+\membersection{wxApp::OnExceptionInMainLoop}\label{wxapponexceptioninmainloop}
 
 \func{virtual bool}{OnExceptionInMainLoop}{\void}
 
 
 \func{virtual bool}{OnExceptionInMainLoop}{\void}
 
@@ -580,26 +592,6 @@ wxWidgets.
 \helpref{wxApp::GetAppName}{wxappgetappname}
 
 
 \helpref{wxApp::GetAppName}{wxappgetappname}
 
 
-\membersection{wxApp::SetAuto3D}\label{wxappsetauto3d}
-
-\func{void}{SetAuto3D}{\param{const bool}{ auto3D}}
-
-Switches automatic 3D controls on or off.
-
-\wxheading{Parameters}
-
-\docparam{auto3D}{If true, all controls will be created with 3D appearances unless
-overridden for a control or dialog. The default is true}
-
-\wxheading{Remarks}
-
-This has an effect on Windows only.
-
-\wxheading{See also}
-
-\helpref{wxApp::GetAuto3D}{wxappgetauto3d}
-
-
 \membersection{wxApp::SetClassName}\label{wxappsetclassname}
 
 \func{void}{SetClassName}{\param{const wxString\& }{name}}
 \membersection{wxApp::SetClassName}\label{wxappsetclassname}
 
 \func{void}{SetClassName}{\param{const wxString\& }{name}}