Large parts rewritten and reorganized

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

diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex
index eeab34240e7d45b63e0bcd8b441f86cc32c75140..13c342c370f310ccdc760edd13cccf21b8fd7b5d 100644 (file)
--- a/docs/latex/wx/cmdevent.tex
+++ b/docs/latex/wx/cmdevent.tex
@@ -7,6 +7,10 @@ simple controls. More complex controls, such as \helpref{wxTreeCtrl}{wxtreectrl}
 
 \helpref{wxEvent}{wxevent}
 
+\wxheading{Include files}
+
+<wx/event.h>
+
 \wxheading{Event table macros}
 
 To process a menu command event, use these event handler macros to direct input to member
@@ -14,9 +18,9 @@ functions that take a wxCommandEvent argument.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_COMMAND(id, cmd, func)}}{Process a command, supplying the window identifier,
+\twocolitem{{\bf EVT\_COMMAND(id, event, func)}}{Process a command, supplying the window identifier,
 command event identifier, and member function.}
-\twocolitem{{\bf EVT\_COMMAND\_RANGE(id1, id2, cmd, func)}}{Process a command for a range
+\twocolitem{{\bf EVT\_COMMAND\_RANGE(id1, id2, event, func)}}{Process a command for a range
 of window identifiers, supplying the minimum and maximum window identifiers,
 command event identifier, and member function.}
 \twocolitem{{\bf EVT\_BUTTON(id, func)}}{Process a wxEVT\_COMMAND\_BUTTON\_CLICKED command,
@@ -27,6 +31,8 @@ which is generated by a wxCheckBox control.}
 which is generated by a wxChoice control.}
 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED command,
 which is generated by a wxListBox control.}
+\twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED command,
+which is generated by a wxListBox control.}
 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED command,
 which is generated by a wxTextCtrl control.}
 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER command,
@@ -46,12 +52,16 @@ which is generated by a wxScrollBar control. This is provided for compatibility
 more specific scrollbar event macros should be used instead (see \helpref{wxScrollEvent}{wxscrollevent}).}
 \twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED command,
 which is generated by a wxComboBox control.}
-\twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED command,
-which is generated by a toobar button.}
-\twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED command,
-which is generated by a toobar button.}
-\twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER command,
-which is generated by a toobar button.}
+\twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
+(a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
+\twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
+for a range id identifiers. Pass the ids of the tools.}
+\twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
+Pass the id of the tool.}
+\twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
+for a range of ids. Pass the ids of the tools.}
+\twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
+Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool.}
 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_CLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_CLICK command,
 which is generated by a control (Windows 95 and NT only).}
 \twocolitem{{\bf EVT\_COMMAND\_LEFT\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LEFT\_DCLICK command,
@@ -70,10 +80,10 @@ which is generated by a control.}
 
 \membersection{wxCommandEvent::m\_clientData}
 
-\member{char*}{m\_clientData}
+\member{void*}{m\_clientData}
 
 Contains a pointer to client data for listboxes and choices, if the event
-was a selection.
+was a selection. Beware, this is not implemented anyway...
 
 \membersection{wxCommandEvent::m\_commandInt}
 
@@ -113,10 +123,10 @@ Returns TRUE or FALSE for a checkbox selection event.
 
 \membersection{wxCommandEvent::GetClientData}
 
-\func{char*}{GetClientData}{\void}
+\func{void*}{GetClientData}{\void}
 
 Returns client data pointer for a listbox or choice selection event
-(not valid for a deselection).
+(not valid for a deselection). Beware, this is not implmented anywhere...
 
 \membersection{wxCommandEvent::GetExtraLong}
 
@@ -153,7 +163,7 @@ is a deselection.
 
 \membersection{wxCommandEvent::SetClientData}
 
-\func{void}{SetClientData}{\param{char*}{ clientData}}
+\func{void}{SetClientData}{\param{void*}{ clientData}}
 
 Sets the client data for this event.