Applied patch [ 1042241 ] Fixes print setup problem (MSW UNICODE build)

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

diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex
index dfba91d860534c1e48c247db0d920a0a1c9e18de..8f34b39be93cfdd745c3bcc4cd19c0e07021c0d7 100644 (file)
--- a/docs/latex/wx/cmdevent.tex
+++ b/docs/latex/wx/cmdevent.tex
@@ -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
@@ -87,14 +87,14 @@ which is generated by a control.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCommandEvent::m\_clientData}
+\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}
+\membersection{wxCommandEvent::m\_commandInt}\label{wxcommandeventmcommandint}
 
 \member{int}{m\_commandInt}
 
@@ -102,13 +102,13 @@ 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}
+\membersection{wxCommandEvent::m\_commandString}\label{wxcommandeventmcommandstring}
 
 \member{wxString}{m\_commandString}
 
 Contains a string corresponding to a listbox or choice selection.
 
-\membersection{wxCommandEvent::m\_extraLong}
+\membersection{wxCommandEvent::m\_extraLong}\label{wxcommandeventmextralong}
 
 \member{long}{m\_extraLong}
 
@@ -118,45 +118,52 @@ 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}
+\membersection{wxCommandEvent::wxCommandEvent}\label{wxcommandeventctor}
 
 \func{}{wxCommandEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}}
 
 Constructor.
 
-\membersection{wxCommandEvent::Checked}
+\membersection{wxCommandEvent::Checked}\label{wxcommandeventchecked}
 
 \constfunc{bool}{Checked}{\void}
 
 Deprecated, use \helpref{IsChecked}{wxcommandeventischecked} instead.
 
-\membersection{wxCommandEvent::GetClientData}
+\membersection{wxCommandEvent::GetClientData}\label{wxcommandeventgetclientdata}
 
 \func{void*}{GetClientData}{\void}
 
 Returns client data pointer for a listbox or choice selection event
 (not valid for a deselection).
 
-\membersection{wxCommandEvent::GetExtraLong}
+\membersection{wxCommandEvent::GetClientObject}\label{wxcommandeventgetclientobject}
+
+\func{wxClientData *}{GetClientObject}{\void}
+
+Returns client object pointer for a listbox or choice selection event
+(not valid for a deselection).
+
+\membersection{wxCommandEvent::GetExtraLong}\label{wxcommandeventgetextralong}
 
 \func{long}{GetExtraLong}{\void}
 
 Returns the {\bf m\_extraLong} member.
 
-\membersection{wxCommandEvent::GetInt}
+\membersection{wxCommandEvent::GetInt}\label{wxcommandeventgetint}
 
 \func{int}{GetInt}{\void}
 
 Returns the {\bf m\_commandInt} member.
 
-\membersection{wxCommandEvent::GetSelection}
+\membersection{wxCommandEvent::GetSelection}\label{wxcommandeventgetselection}
 
 \func{int}{GetSelection}{\void}
 
 Returns item index for a listbox or choice selection event (not valid for
 a deselection).
 
-\membersection{wxCommandEvent::GetString}
+\membersection{wxCommandEvent::GetString}\label{wxcommandeventgetstring}
 
 \func{wxString}{GetString}{\void}
 
@@ -173,32 +180,41 @@ 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}
+\membersection{wxCommandEvent::IsSelection}\label{wxcommandeventisselection}
 
 \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}
+\membersection{wxCommandEvent::SetClientData}\label{wxcommandeventsetclientdata}
 
 \func{void}{SetClientData}{\param{void*}{ clientData}}
 
 Sets the client data for this event.
 
-\membersection{wxCommandEvent::SetExtraLong}
+\membersection{wxCommandEvent::SetClientObject}\label{wxcommandeventsetclientobject}
+
+\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}\label{wxcommandeventsetextralong}
 
 \func{void}{SetExtraLong}{\param{int}{ extraLong}}
 
 Sets the {\bf m\_extraLong} member.
 
-\membersection{wxCommandEvent::SetInt}
+\membersection{wxCommandEvent::SetInt}\label{wxcommandeventsetint}
 
 \func{void}{SetInt}{\param{int}{ intCommand}}
 
 Sets the {\bf m\_commandInt} member.
 
-\membersection{wxCommandEvent::SetString}
+\membersection{wxCommandEvent::SetString}\label{wxcommandeventsetstring}
 
 \func{void}{SetString}{\param{const wxString\&}{ string}}