From 97e1d37c96655119ea25c3a099f3189885864c0c Mon Sep 17 00:00:00 2001
From: Julian Smart <julian@anthemion.co.uk>
Date: Mon, 30 Jun 2003 13:35:55 +0000
Subject: [PATCH] Documented event sink

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@21513 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/changes.txt          |  1 +
 docs/latex/wx/evthand.tex | 13 +++++++++----
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/docs/changes.txt b/docs/changes.txt
index c862fdd2b1..2b9b5340c6 100644
--- 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 ad4daf7f71..e891d4f826 100644
--- 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}
-- 
2.45.2