Ref counting overview.

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index fc1fa101d680a91a2ab4129107096344ed998d97..76e50a1c1e9fc419573d74361a6d4506a76c4081 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -42,7 +42,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.


@@ -74,6 +74,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}


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


@@ -197,20 +220,6 @@ different visuals, false otherwise.
 Returns the application's vendor name.
 
 
 Returns the application's vendor name.
 
 

-\membersection{wxApp::HandleEvent}\label{wxapphandleevent}
-
-\constfunc{virtual void}{HandleEvent}{\param{wxEvtHandler}{ *handler}, \param{wxEventFunction}{ func}, \param{wxEvent\& }{event}}
-
-This function simply invokes the
-\helpref{DoHandleEvent}{wxevthandlerdohandleevent} method of event handler
-\arg{handler}, passing \arg{func} and \arg{event} as parameters. If an
-exception occurs, \helpref{OnExceptionInMainLoop}{wxapponexceptioninmainloop}
-is called by this function. You can override it to customize exceptions
-handling.
-
-If you want to modify this behaviour, override this function.
-
-

 \membersection{wxApp::IsActive}\label{wxappisactive}
 
 \constfunc{bool}{IsActive}{\void}
 \membersection{wxApp::IsActive}\label{wxappisactive}
 
 \constfunc{bool}{IsActive}{\void}


@@ -282,16 +291,16 @@ 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}


@@ -300,7 +309,10 @@ the user to stop the program, continue or ignore all subsequent asserts.
 
 \docparam{line}{the line number in this file where the assert occurred}
 
 
 \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


@@ -679,6 +691,18 @@ This function currently only has effect under GTK.
 
 \docparam{flag}{If true, the app will use the best visual.}
 
 
 \docparam{flag}{If true, the app will use the best visual.}
 

+
+\membersection{wxApp::HandleEvent}\label{wxapphandleevent}
+
+\constfunc{virtual void}{HandleEvent}{\param{wxEvtHandler}{ *handler}, \param{wxEventFunction}{ func}, \param{wxEvent\& }{event}}
+
+This function simply invokes the given method \arg{func} of the specified
+event handler \arg{handler} with the \arg{event} as parameter. It exists solely
+to allow to catch the C++ exceptions which could be thrown by all event
+handlers in the application in one place: if you want to do this, override this
+function in your wxApp-derived class and add try/catch clause(s) to it.
+
+

 \membersection{wxApp::Yield}\label{wxappyield}
 
 \func{bool}{Yield}{\param{bool}{ onlyIfNeeded = false}}
 \membersection{wxApp::Yield}\label{wxappyield}
 
 \func{bool}{Yield}{\param{bool}{ onlyIfNeeded = false}}