Add a couple of wxPerl notes.

Mark keyed wxList methods as deprecated.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@23862 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2003-09-23 19:29:23 +00:00
parent 15b6268b64
commit 74b4ca1c60
2 changed files with 17 additions and 3 deletions

View File

@@ -99,6 +99,10 @@ is an alternative to the use of static event tables. See the 'dynamic' sample fo
(wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) MyFrame::OnQuit ); (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) MyFrame::OnQuit );
\end{verbatim} \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} \membersection{wxEvtHandler::Disconnect}\label{wxevthandlerdisconnect}
\func{bool}{Disconnect}{\param{int}{ id}, \func{bool}{Disconnect}{\param{int}{ id},
@@ -129,6 +133,9 @@ to disconnect functions connected using the (static) event tables.
\membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata} \membersection{wxEvtHandler::GetClientData}\label{wxevthandlergetclientdata}
\perlnote{In wxPerl this function takes 3 arguments: \texttt{id,
lastid, type}.}
\func{void* }{GetClientData}{\void} \func{void* }{GetClientData}{\void}
Gets user-supplied client data. Gets user-supplied client data.

View File

@@ -2,7 +2,8 @@
wxList classes provide linked list functionality for wxWindows, and for an wxList classes provide linked list functionality for wxWindows, and for an
application if it wishes. Depending on the form of constructor used, a list 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 See \helpref{wxHashMap}{wxhashmap}\rtfsp for a faster method of storage
when random access is required. when random access is required.
@@ -138,12 +139,14 @@ members for getting to the next or previous node.
\func{}{wxList}{\void} \func{}{wxList}{\void}
\func{}{wxList}{\param{unsigned int}{ key\_type}}
\func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}} \func{}{wxList}{\param{int}{ n}, \param{T *}{objects[]}}
\func{}{wxList}{\param{T *}{object}, ...} \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, Constructors. {\it key\_type} is one of wxKEY\_NONE, wxKEY\_INTEGER, or wxKEY\_STRING,
and indicates what sort of keying is required (if any). 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}} \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{long}{ key}, \param{T *}{object}}
\func{wxNode<T> *}{Append}{\param{const wxString\& }{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. 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{long}{ key}}
\func{wxNode<T> *}{Find}{\param{const wxString\& }{key}} \func{wxNode<T> *}{Find}{\param{const wxString\& }{key}}