]> git.saurik.com Git - wxWidgets.git/commitdiff
Add a couple of wxPerl notes.
authorMattia Barbon <mbarbon@cpan.org>
Tue, 23 Sep 2003 19:29:23 +0000 (19:29 +0000)
committerMattia Barbon <mbarbon@cpan.org>
Tue, 23 Sep 2003 19:29:23 +0000 (19:29 +0000)
  Mark keyed wxList methods as deprecated.

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

docs/latex/wx/evthand.tex
docs/latex/wx/list.tex

index e891d4f826337a79b19a0eafe79bae3ea5d5e71e..ab602afed66e9ead8a427673f5f3cbb2cf53774c 100644 (file)
@@ -102,6 +102,10 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
     (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) MyFrame::OnQuit );
 \end{verbatim}
 
+\perlnote{In wxPerl this function takes 4 arguments: \texttt{id,
+lastid, type, method}; if \texttt{method} is \texttt{undef}, the
+handler is disconnected.}
+
 \membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect}
 
 \func{bool}{Disconnect}{\param{int}{ id},
@@ -132,6 +136,9 @@ to disconnect functions connected using the (static) event tables.
 
 \docparam{eventSink}{Object whose member function should be called.}
 
+\perlnote{In wxPerl this function takes 3 arguments: \texttt{id,
+lastid, type}.}
+
 \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
 
 \func{void* }{GetClientData}{\void}
index 6073e3a2ef7c852ac04c2c6ae9fc0a5ed4705e2a..ba7fef8068fa8a948a08fd270ab801ed1c6dbadf 100644 (file)
@@ -2,7 +2,8 @@
 
 wxList classes provide linked list functionality for wxWindows, and for an
 application if it wishes.  Depending on the form of constructor used, a list
-can be keyed on integer or string keys to provide a primitive look-up ability.
+can be keyed on integer or string keys to provide a primitive look-up ability,
+but please note that this feature is {\bf deprecated}.
 See \helpref{wxHashMap}{wxhashmap}\rtfsp for a faster method of storage
 when random access is required.
 
@@ -138,12 +139,14 @@ members for getting to the next or previous node.
 
 \func{}{wxList}{\void}
 
-\func{}{wxList}{\param{unsigned int}{ key\_type}}
-
 \func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}}
 
 \func{}{wxList}{\param{T *}{object}, ...}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
+\func{}{wxList}{\param{unsigned int}{ key\_type}}
+
 Constructors. {\it key\_type} is one of wxKEY\_NONE, wxKEY\_INTEGER, or wxKEY\_STRING,
 and indicates what sort of keying is required (if any).
 
@@ -163,6 +166,8 @@ client data held in the nodes.
 
 \func{wxNode<T> *}{Append}{\param{T *}{object}}
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
 \func{wxNode<T> *}{Append}{\param{long}{ key}, \param{T *}{object}}
 
 \func{wxNode<T> *}{Append}{\param{const wxString\& }{key}, \param{T *}{object}}
@@ -207,6 +212,8 @@ Finds the given client {\it object} and deletes the appropriate node from the li
 
 Returns the node whose client date is {\it object} or NULL if none found.
 
+{\bf Note}: keyed lists are deprecated and should not be used in new code.
+
 \func{wxNode<T> *}{Find}{\param{long}{ key}}
 
 \func{wxNode<T> *}{Find}{\param{const wxString\& }{key}}