From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Thu, 15 Apr 2004 23:10:08 +0000 (+0000)
Subject: changed return type of wxCommandEvent::GetClientObject() to wxClientData * from void... 
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/88eadcf21824e55efb94abeebe19c82891af658c?hp=5c9f6bf455c4a27161fce95688eeffe4e958e696

changed return type of wxCommandEvent::GetClientObject() to wxClientData * from void * and documented it (patch 918655)


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@26823 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/cmdevent.tex b/docs/latex/wx/cmdevent.tex
index 8951c4cb19..d0515813e7 100644
--- a/docs/latex/wx/cmdevent.tex
+++ b/docs/latex/wx/cmdevent.tex
@@ -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}
@@ -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}}
diff --git a/include/wx/event.h b/include/wx/event.h
index 29100ac661..6fd81a8097 100644
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -502,7 +502,7 @@ public:
 
     // Set/Get client object from controls
     void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
-    void *GetClientObject() const { return m_clientObject; }
+    wxClientData *GetClientObject() const { return m_clientObject; }
 
     // Get listbox selection if single-choice
     int GetSelection() const { return m_commandInt; }