applied wxPerl doc patches

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@9748 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2001-04-14 19:46:05 +00:00
parent ea5999b96f
commit f35398824b
9 changed files with 134 additions and 1 deletions

View File

@@ -244,6 +244,9 @@ item is currently invisible.
{\tt item} and {\tt textOnly} parameters. The return value is either a
{\tt wxRect} object or {\tt None}.}
\perlnote{In wxPerl this method only takes the parameters {\tt item} and
{\tt textOnly}, and returns a Wx::Rect ( or undef ).}
\membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}}
@@ -284,6 +287,9 @@ Returns an invalid tree item if there are no further children.
\pythonnote{In wxPython the returned wxTreeItemId and the new cookie
value are both returned as a tuple containing the two values.}
\perlnote{In wxPerl this method only takes the {\tt item} parameter, and
returns a 2-element list ( item, cookie ).}
\membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
\constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void}
@@ -320,6 +326,15 @@ associated with the wxTreeItemData for the given item Id.}
\end{twocollist}}
}
\perlnote{wxPerl provides the following shortcut method:
\indented{2cm}{
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf GetPlData( item )}}{Returns the Perl data
associated with the Wx::TreeItemData ( it is just the same as
tree->GetItemData( item )->GetData(); ).}
\end{twocollist}}
}
\membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
@@ -376,6 +391,9 @@ Returns an invalid tree item if there are no further children.
\pythonnote{In wxPython the returned wxTreeItemId and the new cookie
value are both returned as a tuple containing the two values.}
\perlnote{In wxPerl this method returns a 2-element list
( item, cookie ), instead of modifying its parameters.}
\membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
\constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
@@ -455,6 +473,9 @@ Returns the number of selected items.
\pythonnote{The wxPython version of this method accepts no parameters
and returns a Python list of {\tt wxTreeItemId}s.}
\perlnote{In wxPerl this method takes no parameters and returns a list of
{\tt Wx::TreeItemId}s.}
\membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist}
\constfunc{wxImageList*}{GetStateImageList}{\void}
@@ -486,6 +507,9 @@ id at this point plus extra information {\it flags}. {\it flags} is a bitlist of
\pythonnote{in wxPython both the wxTreeItemId and the flags are
returned as a tuple.}
\perlnote{In wxPerl this method only takes the {\tt point} parameter
and returns a 2-element list ( item, flags ).}
\membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
\func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},
@@ -613,6 +637,15 @@ Object with the wxTreeItemData for the given item Id.}
\end{twocollist}}
}
\perlnote{wxPerl provides the following shortcut method:
\indented{2cm}{
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf SetPlData( item, data )}}{Sets the Perl data
associated with the Wx::TreeItemData ( it is just the same as
tree->GetItemData( item )->SetData( data ); ).}
\end{twocollist}}
}
\membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
\func{void}{SetItemFont}{\param{const wxTreeItemId\&}{ item}, \param{const wxFont\& }{font}}
@@ -752,6 +785,10 @@ wxTreeItemData}
\end{twocollist}}
}
\perlnote{In wxPerl the constructor accepts as parameter an optional scalar,
and stores it as client data. You may retrieve this data by calling
{\bf GetData()}, and set it by callling {\bf SetData( data ).}
}
\membersection{wxTreeItemData::\destruct{wxTreeItemData}}