X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ccef86c75da7844d15435f4093bf992f60786cea..544229d1069a20ca4c81fac6059aa4d92d8559ef:/docs/latex/wx/cmdevent.tex diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex index a208fe97f3..bd6ac03f30 100644 --- a/docs/latex/wx/cmdevent.tex +++ b/docs/latex/wx/cmdevent.tex @@ -41,7 +41,7 @@ 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 +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.} @@ -64,7 +64,7 @@ which is generated by a wxComboBox control.} \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.} +for a range of 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 @@ -104,7 +104,7 @@ deselection), or a boolean value representing the value of a checkbox. \membersection{wxCommandEvent::m\_commandString} -\member{char*}{m\_commandString} +\member{wxString}{m\_commandString} Contains a string corresponding to a listbox or choice selection. @@ -113,8 +113,8 @@ Contains a string corresponding to a listbox or choice selection. \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 +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. @@ -137,6 +137,13 @@ Deprecated, use \helpref{IsChecked}{wxcommandeventischecked} instead. Returns client data pointer for a listbox or choice selection event (not valid for a deselection). +\membersection{wxCommandEvent::GetClientObject} + +\func{wxClientData *}{GetClientObject}{\void} + +Returns client object pointer for a listbox or choice selection event +(not valid for a deselection). + \membersection{wxCommandEvent::GetExtraLong} \func{long}{GetExtraLong}{\void} @@ -158,7 +165,7 @@ a deselection). \membersection{wxCommandEvent::GetString} -\func{char*}{GetString}{\void} +\func{wxString}{GetString}{\void} Returns item string for a listbox or choice selection event (not valid for a deselection). @@ -168,7 +175,7 @@ a deselection). \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 +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). @@ -177,7 +184,7 @@ menu items). \func{bool}{IsSelection}{\void} -For a listbox or choice event, returns TRUE if it is a selection, FALSE if it +For a listbox or similar event, returns true if it is a selection, false if it is a deselection. \membersection{wxCommandEvent::SetClientData} @@ -186,6 +193,15 @@ is a deselection. Sets the client data for this event. +\membersection{wxCommandEvent::SetClientObject} + +\func{void}{SetClientObject}{\param{wxClientData*}{ clientObject}} + +Sets the client object for this event. The client object is \emph{not} owned by the event +object and the event object will not delete the client object in its destructor. +The client object must be owned and deleted by another object (e.g. a control) +that has longer life time than the event object. + \membersection{wxCommandEvent::SetExtraLong} \func{void}{SetExtraLong}{\param{int}{ extraLong}} @@ -200,7 +216,7 @@ Sets the {\bf m\_commandInt} member. \membersection{wxCommandEvent::SetString} -\func{void}{SetString}{\param{char*}{ string}} +\func{void}{SetString}{\param{const wxString\&}{ string}} Sets the {\bf m\_commandString} member.