non-pch build fixes

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index d29ee9d6db8046fdf01a1da2787d0deeff310fe8..ab2a324b64dfea1889ee990b4acc0b935a117253 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -26,6 +26,10 @@ a reference to your application object) to be visible to other files.
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}
 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}


@@ -125,6 +129,21 @@ 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::GetAppDisplayName}\label{wxappgetappdisplayname}
+
+\constfunc{wxString}{GetAppDisplayName}{\void}
+
+Returns the user-readable application name. The difference between this string
+and the one returned by \helpref{GetAppName}{wxappgetappname} is that this one
+is meant to be shown to the user and so should be used for the window titles,
+page headers and so on while the other one should be only used internally, e.g.
+for the file names or configuration file keys.
+
+By default, returns the same string as \helpref{GetAppName}{wxappgetappname}.
+
+\newsince{2.9.0}
+
+

 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}


@@ -136,6 +155,10 @@ Returns the application name.
 wxWidgets sets this to a reasonable default before
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
 wxWidgets sets this to a reasonable default before
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 

+\wxheading{See also}
+
+\helpref{GetAppDisplayName}{wxappgetappdisplayname}
+

 
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 
 
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 


@@ -213,6 +236,21 @@ different visuals, false otherwise.
 \helpref{SetUseBestVisual}{wxappsetusebestvisual}
 
 
 \helpref{SetUseBestVisual}{wxappsetusebestvisual}
 
 

+\membersection{wxApp::GetVendorDisplayName}\label{wxappgetvendordisplayname}
+
+\constfunc{wxString}{GetVendorDisplayName}{\void}
+
+Returns the user-readable vendor name. The difference between this string
+and the one returned by \helpref{GetVendorName}{wxappgetvendorname} is that this one
+is meant to be shown to the user and so should be used for the window titles,
+page headers and so on while the other one should be only used internally, e.g.
+for the file names or configuration file keys.
+
+By default, returns the same string as \helpref{GetVendorName}{wxappgetvendorname}.
+
+\newsince{2.9.0}
+
+

 \membersection{wxApp::GetVendorName}\label{wxappgetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
 \membersection{wxApp::GetVendorName}\label{wxappgetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}


@@ -519,10 +557,13 @@ should return $0$ in case of successful termination.
 
 This function is called when an unhandled C++ exception occurs inside 
 \helpref{OnRun()}{wxapponrun} (the exceptions which occur during the program
 
 This function is called when an unhandled C++ exception occurs inside 
 \helpref{OnRun()}{wxapponrun} (the exceptions which occur during the program

-startup and shutdown might not be caught at all).
-Note that the exception type is lost by now, so if you want to really handle
-the exception you should override \helpref{OnRun()}{wxapponrun} and put a
-try/catch clause around the call to the base class version there.
+startup and shutdown might not be caught at all). Notice that by now the main
+event loop has been terminated and the program will exit, if you want to
+prevent this from happening (i.e. continue running after catching an exception)
+you need to override \helpref{OnExceptionInMainLoop}{wxapponexceptioninmainloop}.
+
+The default implementation shows information about the exception in debug build
+but does nothing in the release build.

 
 
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
 
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}


@@ -580,13 +621,25 @@ If true is returned, more OnIdle processing is requested by one or more window.
 \helpref{wxIdleEvent}{wxidleevent}
 
 
 \helpref{wxIdleEvent}{wxidleevent}
 
 

+\membersection{wxApp::SetAppDisplayName}\label{wxappsetappdisplayname}
+
+\func{void}{SetAppDisplayName}{\param{const wxString\& }{name}}
+
+Set the application name to be used in the user-visible places such as window
+titles. See \helpref{GetAppDisplayName}{wxappgetappdisplayname} for more about
+the differences between the display name and name.
+
+

 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 
 \func{void}{SetAppName}{\param{const wxString\& }{name}}
 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 
 \func{void}{SetAppName}{\param{const wxString\& }{name}}
 

-Sets the name of the application. The name may be used in dialogs
-(for example by the document/view framework). A default name is set by
-wxWidgets.
+Sets the name of the application. This name should be used for file names,
+configuration file entries and other internal strings. For the user-visible
+strings, such as the window titles, the application display name set by 
+\helpref{SetAppDisplayName}{wxappsetappdisplayname} is used instead.
+
+By default the application name is set to the name of its executable file.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -659,6 +712,14 @@ needs to use the top window.
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 

+\membersection{wxApp::SetVendorDisplayName}\label{wxappsetvendordisplayname}
+
+\func{void}{SetVendorDisplayName}{\param{const wxString\& }{name}}
+
+Set the vendor name to be used in the user-visible places. See
+\helpref{GetVendorDisplayName}{wxappgetvendordisplayname} for more about
+the differences between the display name and name.
+

 
 \membersection{wxApp::SetVendorName}\label{wxappsetvendorname}
 
 
 \membersection{wxApp::SetVendorName}\label{wxappsetvendorname}