An opaque reference to a tree item.
@library{wxcore}
- @category{misc}
+ @category{data}
@see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
*/
- 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();
/**
Returns the item associated with this node.
*/
- const wxTreeItemId GetId();
+ const wxTreeItemId& GetId() const;
/**
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);
};
/**
Indicates which type to associate an image with a wxTreeCtrl item.
-
+
@see wxTreeCtrl::GetItemImage(), wxTreeCtrl::SetItemImage()
*/
enum wxTreeItemIcon