X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/924b84ab9461c95cf5c5386d1091ae0f7a8e7ce7..380740af5dd112601916704a6d78d1112ebb31b5:/docs/latex/wx/evthand.tex diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex index 8c3e91fc83..180636f90d 100644 --- a/docs/latex/wx/evthand.tex +++ b/docs/latex/wx/evthand.tex @@ -18,6 +18,10 @@ will be identical to the "this" pointer for the wxEvtHandler portion. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \overview{Event handling overview}{eventhandlingoverview} @@ -40,7 +44,7 @@ each other. \membersection{wxEvtHandler::AddPendingEvent}\label{wxevthandleraddpendingevent} -\func{void}{AddPendingEvent}{\param{wxEvent\& }{event}} +\func{virtual void}{AddPendingEvent}{\param{const wxEvent\& }{event}} This function posts an event to be processed later. @@ -155,20 +159,6 @@ to disconnect functions connected using the (static) event tables. \perlnote{In wxPerl this function takes 3 arguments: \texttt{id, lastid, type}.} -\membersection{wxEvtHandler::DoHandleEvent}\label{wxevthandlerdohandleevent} - -\func{virtual void}{DoHandleEvent}{\param{wxEventFunction}{ func}, \param{wxEvent\& }{event}} - -This function simply invokes the given method \arg{func} of this -event handler with the \arg{event} as parameter. It exists solely -to allow to catch the C++ exceptions which could be thrown by this event -handlers in one place: if you want to do this, override this -function in your wxEvtHandler-derived class and add try/catch clause(s) to it. - -Exceptions not caught at this level propagate to -\helpref{wxApp::HandleEvent}{wxapphandleevent} which in turn calls -\helpref{wxApp::OnExceptionInMainLoop}{wxapponexceptioninmainloop}. - \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata} \func{void* }{GetClientData}{\void} @@ -284,6 +274,30 @@ recursively applied to the parent window's event handler. If this returns true, \helpref{wxEvtHandler::SearchEventTable}{wxevthandlersearcheventtable} + +\membersection{wxEvtHandler::SafelyProcessEvent}\label{wxevthandlersafelyprocessevent} + +\func{bool}{SafelyProcessEvent}{\param{wxEvent\& }{event}} + +Processes an event by calling \helpref{ProcessEvent}{wxevthandlerprocessevent} +and handles any exceptions that occur in the process. If an exception is +thrown in event handler, \helpref{wxApp::OnExceptionInMainLoop}{wxapponexceptioninmainloop} +is called. + +\wxheading{Parameters} + +\docparam{event}{Event to process.} + +\wxheading{Return value} + +\true if the event was processed, \false if no handler was found or an +exception was thrown. + +\wxheading{See also} + +\helpref{wxWindow::HandleWindowEvent}{wxwindowhandlewindowevent} + + \membersection{wxEvtHandler::SearchEventTable}\label{wxevthandlersearcheventtable} \func{virtual bool}{SearchEventTable}{\param{wxEventTable\& }{table}, \param{wxEvent\& }{event}}