X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/81d66cf39f810503baed79213bc3122fda0ccc7b..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/cmdevent.tex diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex index 649f0d5038..f129cfc0ce 100644 --- 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} + + + \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, @@ -32,7 +36,13 @@ 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, -which is generated by a wxTextCtrl control.} +which is generated by a wxTextCtrl control. Note that you must use +wxTE\_PROCESS\_ENTER flag when creating the control if you want it to generate +such events.} +\twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_MAXLEN command, +which is generated by a wxTextCtrl control when the user tries to enter more +characters into it than the limit previosuly set with +\helpref{SetMaxLength}{wxtextctrlsetmaxlength}.} \twocolitem{{\bf EVT\_MENU(id, func)}}{Process a wxEVT\_COMMAND\_MENU\_SELECTED command, which is generated by a menu item.} \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_MENU\_RANGE command, @@ -76,10 +86,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,13 +123,13 @@ Constructor. \membersection{wxCommandEvent::Checked} -\func{bool}{Checked}{\void} +\constfunc{bool}{Checked}{\void} -Returns TRUE or FALSE for a checkbox selection event. +Deprecated, use \helpref{IsChecked}{wxcommandeventischecked} instead. \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). @@ -150,6 +160,16 @@ a deselection). Returns item string for a listbox or choice selection event (not valid for a deselection). +\membersection{wxCommandEvent::IsChecked}\label{wxcommandeventischecked} + +\constfunc{bool}{IsChecked}{\void} + +This method can be used with checkbox and menu events: for the checkboxes, the +method returns {\tt TRUE} for a selection event and {\tt FALSE} for a +deselection one. For the menu events, this method indicates if the menu item +just has become checked or unchecked (and thus only makes sense for checkable +menu items). + \membersection{wxCommandEvent::IsSelection} \func{bool}{IsSelection}{\void} @@ -159,7 +179,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. @@ -181,8 +201,3 @@ Sets the {\bf m\_commandInt} member. Sets the {\bf m\_commandString} member. - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "referenc" -%%% End: