Copy wxPerl notes from the LaTeX documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62451 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2009-10-18 17:47:01 +00:00
parent c06957daf1
commit 1058f65203
33 changed files with 606 additions and 4 deletions

View File

@@ -358,6 +358,11 @@ public:
textOnly parameters. The return value is either a wxRect object or @c
None.
@endWxPythonOnly
@beginWxPerlOnly
In wxPerl this method only takes the @a item and
@a textOnly parameters and returns a @c Wx::Rect (or @c undef).
@endWxPerlOnly
*/
virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
bool textOnly = false) const;
@@ -408,6 +413,11 @@ public:
returned as a tuple containing the two values.
@endWxPythonOnly
@beginWxPerlOnly
In wxPerl this method only takes the @a item parameter, and
returns a 2-element list (item, cookie).
@endWxPerlOnly
@see GetNextChild(), GetNextSibling()
*/
virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
@@ -452,6 +462,13 @@ public:
@li GetPyData(item): Returns the Python Object associated with the
wxTreeItemData for the given item Id.
@endWxPythonOnly
@beginWxPerlOnly
wxPerl provides the following shortcut method:
- GetPlData(item): returns the Perl data
associated with the Wx::TreeItemData. It is just the same as
tree->GetItemData(item)->GetData().
@endWxPerlOnly
*/
virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
@@ -518,6 +535,11 @@ public:
returned as a tuple containing the two values.
@endWxPythonOnly
@beginWxPerlOnly
In wxPerl this method returns a 2-element list
(item, cookie) instead of modifying its parameters.
@endWxPerlOnly
@see GetFirstChild()
*/
virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
@@ -591,6 +613,11 @@ public:
The wxPython version of this method accepts no parameters and returns a
Python list of @ref wxTreeItemId "wxTreeItemId"s.
@endWxPythonOnly
@beginWxPerlOnly
In wxPerl this method takes no parameters and returns a list of
@c Wx::TreeItemId.
@endWxPerlOnly
*/
virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
@@ -621,6 +648,11 @@ public:
@beginWxPythonOnly
In wxPython both the wxTreeItemId and the flags are returned as a tuple.
@endWxPythonOnly
@beginWxPerlOnly
In wxPerl this method only takes the @a point parameter
and returns a 2-element list (item, flags).
@endWxPerlOnly
*/
wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
@@ -795,6 +827,12 @@ public:
the wxTreeItemData for the given item Id.
@endWxPythonOnly
@beginWxPerlOnly
wxPerl provides the following shortcut method:
- SetPlData(item, data): sets the Perl data
associated with the @c Wx::TreeItemData. It is just the same as
tree->GetItemData(item)->SetData(data).
@endWxPerlOnly
*/
virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);