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

diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index 500c31d863ab470792a8ab4aa28a73c1e67fa89d..504291ab664977f391195c36011b947b846be342 100644 (file)
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -812,9 +812,14 @@ public:
     virtual void ScrollTo(const wxTreeItemId& item);
 
     /**
     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);
 
     */
     virtual void SelectItem(const wxTreeItemId& item, bool select = true);