Added possibility of 2-step initialisation, and wxWIZARD_EX_HELPBUTTON style.

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

diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex
index a922333c501b000a2b4d99a86a1a105e9d57833c..cc269395f3c522414ddde35ea326fc9e8bdd2881 100644 (file)
--- a/docs/latex/wx/evthand.tex
+++ b/docs/latex/wx/evthand.tex
@@ -37,7 +37,7 @@ each other.
 \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}
+event will get processed in idle time using the \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent} 
 method.
 
 \wxheading{Parameters}
@@ -46,21 +46,23 @@ method.
 
 \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.
+Note that this requires that the event implements 
+\helpref{CopyObject}{wxobjectcopyobject} 
+method so that the event can be duplicated and stored until it gets processed later.
+Not all events in wxWindows currently fully implement this method,
+so 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
+This is also the method to call for inter-thread communication. In
+a multi-threaded 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.
 
+% VZ: bad idea IMHO - we're going to have a lot of problems with this
 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.
@@ -101,18 +103,18 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
 \membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect}
 
 \func{bool}{Disconnect}{\param{int}{ id},
- \param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL},
+ \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL},
  \param{wxObject*}{ userData = NULL}}
 
 \func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1},
- \param{wxEventType }{eventType = wxEVT_NULL}, \param{wxObjectEventFunction}{ function = NULL},
+ \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL},
  \param{wxObject*}{ userData = NULL}}
 
 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
+parameters as search criteria and returning TRUE if a matching function has been
+found and removed. This method can only disconnect 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.
+to disconnect functions connected using the (static) event tables.
 
 \wxheading{Parameters}
 
@@ -124,19 +126,18 @@ to disconnect from events used in the (static) event tables.
 
 \docparam{function}{The event handler function.}
 
-\docparam{userData}{Data to be associated with the event table entry.}
+\docparam{userData}{Data associated with the event table entry.}
 
 \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
 
-\func{char* }{GetClientData}{\void}
+\func{void* }{GetClientData}{\void}
 
 Gets user-supplied client data.
 
 \wxheading{Remarks}
 
 Normally, any extra data the programmer wishes to associate with the object
-should be made available by deriving a new class
-with new data members.
+should be made available by deriving a new class with new data members.
 
 \wxheading{See also}
 
@@ -270,7 +271,7 @@ fail, and searching will continue.
 
 \membersection{wxEvtHandler::SetClientData}\label{wxevthandlersetclientdata}
 
-\func{void}{SetClientData}{\param{char* }{data}}
+\func{void}{SetClientData}{\param{void* }{data}}
 
 Sets user-supplied client data.
 
@@ -280,10 +281,9 @@ Sets user-supplied client data.
 
 \wxheading{Remarks}
 
-Normally, any extra data the programmer wishes
-to associate with the object should be made available by deriving a new class
+Normally, any extra data the programmer wishes to associate with 
+the object should be made available by deriving a new class
 with new data members.
-%TODO: make this void*, char* only in compatibility mode.
 
 \wxheading{See also}