X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/18e33484810be21beaedde30f40d4fb824277d83..fb91e8d098a80754a04833636c5c2c2677148601:/docs/latex/wx/evthand.tex diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex index 2efdccbe7d..a5e0a0949a 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. @@ -100,7 +104,7 @@ argument, it defaults to \texttt{wxID\_ANY}.} \docparam{function}{The event handler function. Note that this function should be explicitly converted to the correct type which can be done using a macro -called \texttt{wxFooHandler} for the handler for any \texttt{wxFooEvent}.} +called \texttt{wxFooEventHandler} for the handler for any \texttt{wxFooEvent}.} \docparam{userData}{Data to be associated with the event table entry.} @@ -121,11 +125,14 @@ handler is disconnected.} \membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect} -\func{bool}{Disconnect}{\param{int}{ id}, +\func{bool}{Disconnect}{\param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, + \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}} + +\func{bool}{Disconnect}{\param{int}{ id = \texttt{wxID\_ANY}}, \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}} -\func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1}, +\func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = \texttt{wxID\_ANY}}, \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}} @@ -267,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}}