Updates to event docs. (removed evthandler::default).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4644 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -32,6 +32,39 @@ Destructor. If the handler is part of a chain, the destructor will
|
||||
unlink itself and restore the previous and next handlers so that they point to
|
||||
each other.
|
||||
|
||||
\membersection{wxEvtHandler::AddPendingEvent}\label{wxevthandleraddpendingevent}
|
||||
|
||||
\func{virtual void}{AddPendingEvent}{\param{wxEvent\& }{event}}
|
||||
|
||||
Adds an event to be processed later. The function will return immediately and the
|
||||
event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}
|
||||
method.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{event}{Event to add to process queue.}
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
Note that this requires that the event has a fully implemented Clone()
|
||||
methods so that the event can be duplicated and stored until later processing.
|
||||
Not all events in wxWindows currently have a fully implemented Clone() method,
|
||||
you may have to look at the source to verify this.
|
||||
|
||||
This methods automatically wakes up idle handling even if the underlying window
|
||||
system is currently idle anyway and thus would not send any idle events. (Waking
|
||||
up the idle handling is done calling \helpref{::wxWakeUpIdle}{wxwakeupidle}.)
|
||||
|
||||
This is also the method to call for inter-thread communication. When using
|
||||
a multi-threading program, you will often have to inform the main GUI thread
|
||||
about the status of other working threads and this has to be done using this
|
||||
method - which also means that this method is thread safe by means of using
|
||||
crtical sections where needed.
|
||||
|
||||
Furthermore, it may be noted that some ports of wxWindows will probably move
|
||||
to using this method more and more in preference over calling ProcessEvent()
|
||||
directly so as to avoid problems with reentrant code.
|
||||
|
||||
\membersection{wxEvtHandler::Connect}\label{wxevthandlerconnect}
|
||||
|
||||
\func{void}{Connect}{\param{int}{ id},
|
||||
@@ -65,24 +98,33 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
|
||||
(wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) MyFrame::OnQuit );
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{wxEvtHandler::Default}\label{wxevthandlerdefault}
|
||||
\membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect}
|
||||
|
||||
\func{virtual long}{Default}{\void}
|
||||
\func{bool}{Disconnect}{\param{int}{ id},
|
||||
\param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL},
|
||||
\param{wxObject*}{ userData = NULL}}
|
||||
|
||||
Invokes default processing if this event handler is a window.
|
||||
\func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1},
|
||||
\param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL},
|
||||
\param{wxObject*}{ userData = NULL}}
|
||||
|
||||
\wxheading{Return value}
|
||||
Disconnects the given function dynamically from the event handler, using the specified
|
||||
parameters as search criteria and returning TRUE if a matching event handler has been
|
||||
found and removed. This method can only disconnect from functions which have been added
|
||||
using the \helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. There is no way
|
||||
to disconnect from events used in the (static) event tables.
|
||||
|
||||
System dependent.
|
||||
\wxheading{Parameters}
|
||||
|
||||
\wxheading{Remarks}
|
||||
\docparam{id}{The identifier (or first of the identifier range) associated with the event handler function.}
|
||||
|
||||
A generic way of delegating processing to the default system behaviour. It calls a platform-dependent
|
||||
default function, with parameters dependent on the event or message parameters
|
||||
originally sent from the windowing system.
|
||||
\docparam{lastId}{The second part of the identifier range associated with the event handler function.}
|
||||
|
||||
Normally the application should call a base member, such as \helpref{wxWindow::OnChar}{wxwindowonchar}, which itself
|
||||
may call {\bf Default}.
|
||||
\docparam{eventType}{The event type associated with this event handler.}
|
||||
|
||||
\docparam{function}{The event handler function.}
|
||||
|
||||
\docparam{userData}{Data to be associated with the event table entry.}
|
||||
|
||||
\membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
|
||||
|
||||
|
Reference in New Issue
Block a user