Document that wxTreeCtrl::SelectItem() generates events.

This is another exception to the general rule that program actions don't
generate any events so document it explicitly.

See #13153.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67584 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2011-04-23 11:17:43 +00:00
parent df97a4ef79
commit b22a1070b3

View File

@ -812,9 +812,14 @@ public:
virtual void ScrollTo(const wxTreeItemId& item);
/**
Selects the given item. In multiple selection controls, can be also used
to deselect a currently selected item if the value of @a select is
@false.
Selects the given item.
In multiple selection controls, can be also used to deselect a
currently selected item if the value of @a select is @false.
Notice that calling this method will generate
@c wxEVT_COMMAND_TREE_SEL_CHANGING and @c wxEVT_COMMAND_TREE_SEL_CHANGED
events and that the change could be vetoed by the former event handler.
*/
virtual void SelectItem(const wxTreeItemId& item, bool select = true);