Documented event sink

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

diff --git a/docs/changes.txt b/docs/changes.txt
index c862fdd2b1d9cc4a99d026de13d803f10985b1d9..2b9b5340c609423385f317b653bd053fa8012646 100644 (file)
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -46,6 +46,7 @@ All:
 - fixed bug with deleting entries at root level in wxFileConfig
 - chkconf.h now includes platform-specific versions (for MSW
   and Mac) which contain some tests that were in setup.h
+- Added event sink argument to wxEvtHandler::Connect()
 
 wxBase:
 

diff --git a/docs/latex/wx/evthand.tex b/docs/latex/wx/evthand.tex
index ad4daf7f71673be7944bfc6abe404245ce357f81..e891d4f826337a79b19a0eafe79bae3ea5d5e71e 100644 (file)
--- a/docs/latex/wx/evthand.tex
+++ b/docs/latex/wx/evthand.tex
@@ -70,11 +70,11 @@ up idle handling is done calling \helpref{::wxWakeUpIdle}{wxwakeupidle}.)
 
 \func{void}{Connect}{\param{int}{ id},
  \param{wxEventType }{eventType}, \param{wxObjectEventFunction}{ function},
- \param{wxObject*}{ userData = NULL}}
+ \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}}
 
 \func{void}{Connect}{\param{int}{ id}, \param{int}{ lastId},
  \param{wxEventType }{eventType}, \param{wxObjectEventFunction}{ function},
- \param{wxObject*}{ userData = NULL}}
+ \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}}
 
 Connects the given function dynamically with the event handler, id and event type. This
 is an alternative to the use of static event tables. See the 'dynamic' sample for usage.
@@ -91,6 +91,9 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
 
 \docparam{userData}{Data to be associated with the event table entry.}
 
+\docparam{eventSink}{Object whose member function should be called. If this is NULL,
+'this' will be used.}
+
 \wxheading{Example}
 
 \begin{verbatim}
@@ -103,11 +106,11 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
 
 \func{bool}{Disconnect}{\param{int}{ id},
  \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL},
- \param{wxObject*}{ userData = NULL}}
+ \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}}
 
 \func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1},
  \param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL},
- \param{wxObject*}{ userData = NULL}}
+ \param{wxObject*}{ userData = NULL}, \param{wxEvtHandler*}{ eventSink = NULL}}
 
 Disconnects the given function dynamically from the event handler, using the specified
 parameters as search criteria and returning true if a matching function has been
@@ -127,6 +130,8 @@ to disconnect functions connected using the (static) event tables.
 
 \docparam{userData}{Data associated with the event table entry.}
 
+\docparam{eventSink}{Object whose member function should be called.}
+
 \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
 
 \func{void* }{GetClientData}{\void}