Documented event sink

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@21513 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2003-06-30 13:35:55 +00:00
parent 65b17727e6
commit 97e1d37c96
2 changed files with 10 additions and 4 deletions

View File

@@ -46,6 +46,7 @@ All:
- fixed bug with deleting entries at root level in wxFileConfig - fixed bug with deleting entries at root level in wxFileConfig
- chkconf.h now includes platform-specific versions (for MSW - chkconf.h now includes platform-specific versions (for MSW
and Mac) which contain some tests that were in setup.h and Mac) which contain some tests that were in setup.h
- Added event sink argument to wxEvtHandler::Connect()
wxBase: wxBase:

View File

@@ -70,11 +70,11 @@ up idle handling is done calling \helpref{::wxWakeUpIdle}{wxwakeupidle}.)
\func{void}{Connect}{\param{int}{ id}, \func{void}{Connect}{\param{int}{ id},
\param{wxEventType }{eventType}, \param{wxObjectEventFunction}{ function}, \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}, \func{void}{Connect}{\param{int}{ id}, \param{int}{ lastId},
\param{wxEventType }{eventType}, \param{wxObjectEventFunction}{ function}, \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 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. 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{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} \wxheading{Example}
\begin{verbatim} \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}, \func{bool}{Disconnect}{\param{int}{ id},
\param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \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}, \func{bool}{Disconnect}{\param{int}{ id}, \param{int}{ lastId = -1},
\param{wxEventType }{eventType = wxEVT\_NULL}, \param{wxObjectEventFunction}{ function = NULL}, \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 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 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{userData}{Data associated with the event table entry.}
\docparam{eventSink}{Object whose member function should be called.}
\membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata} \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
\func{void* }{GetClientData}{\void} \func{void* }{GetClientData}{\void}