X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cfbe561401380c3308f92c02b1b34f05d067a18e..8db2e3ef1565e738ade7f63580951d1d040b9c29:/interface/wx/treebase.h diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h index 4218dac815..2b51f90fa7 100644 --- a/interface/wx/treebase.h +++ b/interface/wx/treebase.h @@ -3,7 +3,7 @@ // Purpose: interface of wxTreeItemId // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -12,7 +12,7 @@ An opaque reference to a tree item. @library{wxcore} - @category{misc} + @category{data} @see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl */ @@ -77,6 +77,13 @@ public: - GetData(): Returns a reference to the Python Object. - SetData(obj): Associates a new Python Object with the wxTreeItemData. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl the constructor accepts a scalar as an optional parameter + and stores it as client data; use + - GetData() to retrieve the value. + - SetData(data) to set it. + @endWxPerlOnly */ wxTreeItemData(); @@ -92,6 +99,12 @@ public: /** Sets the item associated with this node. + + Notice that this function is automatically called by wxTreeCtrl methods + associating an object of this class with a tree control item such as + wxTreeCtrl::AppendItem(), wxTreeCtrl::InsertItem() and + wxTreeCtrl::SetItemData() so there is usually no need to call it + yourself. */ void SetId(const wxTreeItemId& id); };