enable VS2005 project files for samples, but without dependencies on library projects...

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index 1107b980592118bd640aa2dc31e7f5fdf11e6e29..8f2e0ced5d318ab44618a44d01384e2f407c5b87 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}


@@ -42,7 +46,7 @@ Constructor. Called implicitly with a definition of a wxApp object.
 
 \membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}
 
 
 \membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}
 

-\func{}{\destruct{wxApp}}{\void}
+\func{virtual}{\destruct{wxApp}}{\void}

 
 Destructor. Will be called implicitly on program exit if the wxApp
 object is created on the stack.
 
 Destructor. Will be called implicitly on program exit if the wxApp
 object is created on the stack.


@@ -57,7 +61,7 @@ Number of command line arguments (after environment-specific processing).
 
 \membersection{wxApp::argv}\label{wxappargv}
 
 
 \membersection{wxApp::argv}\label{wxappargv}
 

-\member{char **}{argv}
+\member{wxChar **}{argv}

 
 Command line arguments (after environment-specific processing).
 
 
 Command line arguments (after environment-specific processing).
 


@@ -74,6 +78,18 @@ implementation returns a new wxLogGui class.
 \helpref{wxLog}{wxlog}
 
 
 \helpref{wxLog}{wxlog}
 
 

+\membersection{wxApp::CreateTraits}\label{wxappcreatetraits}
+
+\func{virtual wxAppTraits *}{CreateTraits}{\void}
+
+Creates the \helpref{wxAppTraits}{wxapptraits} object when \helpref{GetTraits}{wxappgettraits}
+needs it for the first time.
+
+\wxheading{See also}
+
+\helpref{wxAppTraits}{wxapptraits}
+
+

 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 
 \func{virtual void}{Dispatch}{\void}
 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 
 \func{virtual void}{Dispatch}{\void}


@@ -113,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{3.0}
+
+

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


@@ -124,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}
 


@@ -178,6 +213,17 @@ function will find the first top-level window (frame or dialog) and return that.
 \helpref{SetTopWindow}{wxappsettopwindow}
 
 
 \helpref{SetTopWindow}{wxappsettopwindow}
 
 

+
+\membersection{wxApp::GetTraits}\label{wxappgettraits}
+
+\func{wxAppTraits *}{GetTraits}{\void}
+
+Returns a pointer to the \helpref{wxAppTraits}{wxapptraits} object for the application.
+If you want to customize the \helpref{wxAppTraits}{wxapptraits} object, you must override the
+\helpref{CreateTraits}{wxappcreatetraits} function.
+
+
+

 \membersection{wxApp::GetUseBestVisual}\label{wxappgetusebestvisual}
 
 \constfunc{bool}{GetUseBestVisual}{\void}
 \membersection{wxApp::GetUseBestVisual}\label{wxappgetusebestvisual}
 
 \constfunc{bool}{GetUseBestVisual}{\void}


@@ -190,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}


@@ -215,7 +276,7 @@ to do it.
 Returns \true if the main event loop is currently running, i.e. if the
 application is inside \helpref{OnRun}{wxapponrun}.
 
 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,
+This can be useful to test whether 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.
 
 if this function returns \false, non-blocking sockets cannot be used because
 the events from them would never be processed.
 


@@ -268,25 +329,28 @@ Returns 0 under X, and the wParam of the WM\_QUIT message under Windows.
 %%\helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, \helpref{wxDialog::OnCharHook}{wxdialogoncharhook}
 
 
 %%\helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, \helpref{wxDialog::OnCharHook}{wxdialogoncharhook}
 
 

-\membersection{wxApp::OnAssert}\label{wxapponassert}
+\membersection{wxApp::OnAssertFailure}\label{wxapponassertfailure}

 
 

-\func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*cond}, \param{const wxChar }{*msg}}
+\func{void}{OnAssertFailure}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*func}, \param{const wxChar }{*cond}, \param{const wxChar }{*msg}}

 
 This function is called when an assert failure occurs, i.e. the condition
 specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}.
 It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as
 asserts are not left in the release code at all.
 
 
 This function is called when an assert failure occurs, i.e. the condition
 specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}.
 It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as
 asserts are not left in the release code at all.
 

-The base class version show the default assert failure dialog box proposing to
+The base class version shows the default assert failure dialog box proposing to

 the user to stop the program, continue or ignore all subsequent asserts.
 
 \wxheading{Parameters}
 
 the user to stop the program, continue or ignore all subsequent asserts.
 
 \wxheading{Parameters}
 

-\docparam{file}{the name of the source file where the assert occured}
+\docparam{file}{the name of the source file where the assert occurred}

 
 

-\docparam{line}{the line number in this file where the assert occured}
+\docparam{line}{the line number in this file where the assert occurred}

 
 

-\docparam{cond}{the condition of the failed assert in string form}
+\docparam{func}{the name of the function where the assert occurred, may be
+empty if the compiler doesn't support C99 \texttt{\_\_FUNCTION\_\_}}
+
+\docparam{cond}{the condition of the failed assert in text form}

 
 \docparam{msg}{the message specified as argument to 
 \helpref{wxASSERT\_MSG}{wxassertmsg} or \helpref{wxFAIL\_MSG}{wxfailmsg}, will
 
 \docparam{msg}{the message specified as argument to 
 \helpref{wxASSERT\_MSG}{wxassertmsg} or \helpref{wxFAIL\_MSG}{wxfailmsg}, will


@@ -493,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}


@@ -554,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}
 


@@ -633,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}
 


@@ -649,13 +736,16 @@ wxWidgets.
 
 \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
 
 
 \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
 

-\func{void}{SetUseBestVisual}{\param{bool}{ flag}}
+\func{void}{SetUseBestVisual}{\param{bool}{ flag}, \param{bool}{ forceTrueColour = false}}

 
 Allows the programmer to specify whether the application will use the best visual
 on systems that support several visual on the same display. This is typically the
 case under Solaris and IRIX, where the default visual is only 8-bit whereas certain
 applications are supposed to run in TrueColour mode.
 
 
 Allows the programmer to specify whether the application will use the best visual
 on systems that support several visual on the same display. This is typically the
 case under Solaris and IRIX, where the default visual is only 8-bit whereas certain
 applications are supposed to run in TrueColour mode.
 

+If \arg{forceTrueColour} is true then the application will try to force
+using a TrueColour visual and abort the app if none is found.
+

 Note that this function has to be called in the constructor of the {\tt wxApp} 
 instance and won't have any effect when called later on.
 
 Note that this function has to be called in the constructor of the {\tt wxApp} 
 instance and won't have any effect when called later on.
 


@@ -699,7 +789,7 @@ messages immediately (otherwise it will be done during the next idle loop
 iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
 
 Calling Yield() recursively is normally an error and an assert failure is
 iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
 
 Calling Yield() recursively is normally an error and an assert failure is

-raised in debug build if such situation is detected. However if the the 
+raised in debug build if such situation is detected. However if the 

 {\it onlyIfNeeded} parameter is {\tt true}, the method will just silently
 return {\tt false} instead.
 
 {\it onlyIfNeeded} parameter is {\tt true}, the method will just silently
 return {\tt false} instead.