X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/052d2fc5818243dadbc1ec54b1120e295304fc55..5595181f48d45d2c277c7d40a4d24bea42d6847b:/docs/latex/wx/cmdevent.tex diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex index d6c40d0525..5983803d53 100644 --- a/docs/latex/wx/cmdevent.tex +++ b/docs/latex/wx/cmdevent.tex @@ -5,12 +5,17 @@ simple controls. More complex controls, such as \helpref{wxTreeCtrl}{wxtreectrl} \wxheading{Derived from} -\helpref{wxEvent}{wxevent} +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Event table macros} To process a menu command event, use these event handler macros to direct input to member @@ -61,6 +66,7 @@ such events.} 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 +93,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 +123,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} @@ -204,7 +186,7 @@ that has longer life time than the event object. \membersection{wxCommandEvent::SetExtraLong}\label{wxcommandeventsetextralong} -\func{void}{SetExtraLong}{\param{int}{ extraLong}} +\func{void}{SetExtraLong}{\param{long}{ extraLong}} Sets the {\bf m\_extraLong} member.