From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 23 Apr 2011 11:17:43 +0000 (+0000)
Subject: Document that wxTreeCtrl::SelectItem() generates events.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/b22a1070b3f2de8ef85d34a841b5230aa08db967

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 500c31d863..504291ab66 100644
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -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);