wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
and cmd values like you would construct wxAcceleratorEntry objects with.}
+\perlnote{The wxPerl constructor accepts a list of either
+ Wx::AcceleratorEntry objects or references to 3-element arrays
+ ( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.}
+
\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}
\func{}{\destruct{wxAcceleratorTable}}{\void}
Get the caret position (in pixels).
+\perlnote{In wxPerl there are two methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetPosition()}}{Returns a Wx::Point}
+\twocolitem{{\bf GetPositionXY()}}{Returns a 2-element list
+ {\tt ( x, y )}}
+\end{twocollist}
+}}
+
\membersection{wxCaret::GetSize}\label{wxcaretgetsize}
\constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
Get the caret size.
+\perlnote{In wxPerl there are two methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
+\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
+ {\tt ( width, height )}}
+\end{twocollist}
+}}
+
\membersection{wxCaret::GetWindow}\label{wxcaretgetwindow}
\constfunc{wxWindow*}{GetWindow}{\void}
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
+\perlnote{The wxPerl version of this method accepts
+ as its first parameter a reference to an array
+ of wxPoint objects.}
+
\membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
+\perlnote{The wxPerl version of this method accepts
+ as its first parameter a reference to an array
+ of wxPoint objects.}
+
\membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
\func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
+\perlnote{The wxPerl version of this method accepts a reference to an array
+ of wxPoint objects.}
+
\membersection{wxDC::DrawText}\label{wxdcdrawtext}
\func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
\pythonnote{Only a single parameter is required, a Python list of
integers.}
-\perlnote{In wxPerl this method takes the widths as parameters.}
+\perlnote{In wxPerl this method takes the field widths as parameters.}
\membersection{wxFrame::SetToolBar}\label{wxframesettoolbar}
<wx/choicdlg.h>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and no {\tt selections} parameter; the function
+returns an array containing the user selections.}
+
\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
\func{long}{wxGetNumberFromUser}{
<wx/choicdlg.h>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
<wx/choicdlg.h>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
<wx/choicdlg.h>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and the client data array must have the
+same length as the choices array.}
+
\membersection{::wxMessageBox}\label{wxmessagebox}
\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
\end{twocollist}}
}
+\perlnote{In wxPerl there are three methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf FindItem( start, str, partial = FALSE ) }}{}
+\twocolitem{{\bf FindItemData( start, data ) }}{}
+\twocolitem{{\bf FindItemAtPos( start, point, direction )}}{}
+\end{twocollist}
+}}
+
\membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
\constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
Gets information about this column. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
information.
+\perlnote{In wxPerl this method takes only the {\bf col} parameter and
+ returns a Wx::ListItem ( or undef ).}
+
\membersection{wxListCtrl::GetColumnWidth}\label{wxlistctrlgetcolumnwidth}
\constfunc{int}{GetColumnWidth}{\param{int }{col}}
for the item ID, an optional integer for the column number, and
returns the wxListItem object.}
+\perlnote{In wxPerl this method takes as parameter the {\bf ID} of the item
+and ( optionally ) the column, and returns a Wx::ListItem object.}
+
\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount}
\constfunc{int}{GetItemCount}{\void}
\pythonnote{The wxPython version of this method accepts only the item
ID and returns the wxPoint.}
+\perlnote{In wxPerl this method takes only the {\bf item} parameter and
+returns a Wx::Point ( or undef ).}
+
\membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
\constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
\pythonnote{The wxPython version of this method accepts only the item
ID and code and returns the wxRect.}
+\perlnote{In wxPerl this method takes only the {\bf item} parameter and
+retutrns a Wx::Rect ( or undef ).}
+
\membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing}
\constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}}
this method. The first value is the item id and the second is the
flags value mentioned above.}
+\perlnote{In wxPerl this method only takes the {\bf point} parameter
+ and returns a 2-element list ( item, flags ).}
+
\membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn}
\func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}}
\end{twocollist}}
}
+\perlnote{In wxPerl there are four methods instead of a single overloaded
+method:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf InsertItem( item )}}{Inserts a Wx::ListItem}
+\twocolitem{{\bf InsertStringItem( index, label )}}{Inserts a string item}
+\twocolitem{{\bf InsertImageItem( index, imageIndex )}}{Inserts an image item}
+\twocolitem{{\bf InsertImageStringItem( index, label, imageIndex )}}{Inserts
+ an item with a string and an image}
+\end{twocollist}
+}}
+
\membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist}
\func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}}
SortItems with a reference to a callable object that expects two
parameters.}
+\perlnote{In wxPerl the comparison function must take just two parameters;
+ however, you may use a closure to achieve an effect similar to the
+ SortItems third parameter.}
+
\helpref{wxPalette::Create}{wxpalettecreate}
+\perlnote{In wxPerl the third constructor form takes as parameters
+ 3 array references ( they must be of the same length ).}
+
\membersection{wxPalette::\destruct{wxPalette}}
\func{}{\destruct{wxPalette}}{\void}
\helpref{wxPalette::GetPixel}{wxpalettegetpixel}
+\perlnote{In wxPerl this method takes only the {\tt pixel} parameter and
+ returns a 3-element list ( or the empty list upon failure ).}
+
\membersection{wxPalette::Ok}\label{wxpaletteok}
\constfunc{bool}{Ok}{\void}
into a single parameter {\tt choices} which is expected to be a Python
list of strings.}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and the client data array, if present, must have the
+same length as the choices array.}
+
\membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}
\func{}{\destruct{wxSingleChoiceDialog}}{\void}
{\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}}
\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}
\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},
\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}}
\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}
\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},
\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}}
\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}}
projects / wxWidgets.git / commitdiff
