X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f510b7b2f386afe6c3705c2cdbc9208435984dac..a387938f80a2804f259e7305513231be39620fd2:/docs/latex/wx/cmdevent.tex diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex index 8f34b39be9..2406164240 100644 --- a/docs/latex/wx/cmdevent.tex +++ b/docs/latex/wx/cmdevent.tex @@ -29,20 +29,12 @@ which is generated by a wxButton control.} which is generated by a wxCheckBox control.} \twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED command, which is generated by a wxChoice control.} +\twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED command, +which is generated by a wxComboBox 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, -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 previously 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, @@ -50,8 +42,6 @@ which is generated by a range of menu items.} \twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process the event generated when the user has requested a popup menu to appear by pressing a special keyboard key (under Windows) or by right clicking the mouse.} -\twocolitem{{\bf EVT\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED command, -which is generated by a wxSlider control.} \twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED command, which is generated by a wxRadioBox control.} \twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED command, @@ -59,8 +49,19 @@ which is generated by a wxRadioButton control.} \twocolitem{{\bf EVT\_SCROLLBAR(id, func)}}{Process a wxEVT\_COMMAND\_SCROLLBAR\_UPDATED command, which is generated by a wxScrollBar control. This is provided for compatibility only; 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\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED command, +which is generated by a wxSlider 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. 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 previously set with +\helpref{SetMaxLength}{wxtextctrlsetmaxlength}.} +\twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_TOGGLEBUTTON\_CLICKED event.} \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 @@ -87,37 +88,6 @@ which is generated by a control.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxCommandEvent::m\_clientData}\label{wxcommandeventmclientdata} - -\member{void*}{m\_clientData} - -Contains a pointer to client data for listboxes and choices, if the event -was a selection. Beware, this is not implemented anyway... - -\membersection{wxCommandEvent::m\_commandInt}\label{wxcommandeventmcommandint} - -\member{int}{m\_commandInt} - -Contains an integer identifier corresponding to a listbox, choice or -radiobox selection (only if the event was a selection, not a -deselection), or a boolean value representing the value of a checkbox. - -\membersection{wxCommandEvent::m\_commandString}\label{wxcommandeventmcommandstring} - -\member{wxString}{m\_commandString} - -Contains a string corresponding to a listbox or choice selection. - -\membersection{wxCommandEvent::m\_extraLong}\label{wxcommandeventmextralong} - -\member{long}{m\_extraLong} - -Extra information. If the event comes from a listbox selection, it is -a boolean determining whether the event was a selection (true) or a -deselection (false). A listbox deselection only occurs for -multiple-selection boxes, and in this case the index and string values -are indeterminate and the listbox must be examined by the application. - \membersection{wxCommandEvent::wxCommandEvent}\label{wxcommandeventctor} \func{}{wxCommandEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}} @@ -148,13 +118,20 @@ Returns client object pointer for a listbox or choice selection event \func{long}{GetExtraLong}{\void} -Returns the {\bf m\_extraLong} member. +Returns extra information dependant on the event objects type. +If the event comes from a listbox selection, it is a boolean +determining whether the event was a selection (true) or a +deselection (false). A listbox deselection only occurs for +multiple-selection boxes, and in this case the index and string values +are indeterminate and the listbox must be examined by the application. \membersection{wxCommandEvent::GetInt}\label{wxcommandeventgetint} \func{int}{GetInt}{\void} -Returns the {\bf m\_commandInt} member. +Returns the integer identifier corresponding to a listbox, choice or +radiobox selection (only if the event was a selection, not a +deselection), or a boolean value representing the value of a checkbox. \membersection{wxCommandEvent::GetSelection}\label{wxcommandeventgetselection}