]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/treectrl.h
Interface fixes for Phoenix
[wxWidgets.git] / interface / wx / treectrl.h
index 6bd7e2378c32352de12ad263193886aea8b96280..83274018034800c1e8127de7872e431617b51ddb 100644 (file)
@@ -15,7 +15,7 @@
     wxTreeItemId handles, which may be tested for validity by calling
     wxTreeItemId::IsOk().
 
-    A similar control with a fully native implemtation for GTK+ and OS X
+    A similar control with a fully native implementation for GTK+ and OS X
     as well is wxDataViewTreeCtrl.
 
     To intercept events from a tree control, use the event table macros
@@ -87,7 +87,7 @@
           Processes a @c wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT event type.
     @event{EVT_TREE_END_LABEL_EDIT(id, func)}
           Finish editing a label. This can be prevented by calling Veto().
-          Processes a @c wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT event type.
+          Processes a @c wxEVT_COMMAND_TREE_END_LABEL_EDIT event type.
     @event{EVT_TREE_DELETE_ITEM(id, func)}
           An item was deleted.
           Processes a @c wxEVT_COMMAND_TREE_DELETE_ITEM event type.
@@ -383,12 +383,6 @@ public:
         So, for example, the x coordinate may be negative if the tree has a
         horizontal scrollbar and its position is not 0.
 
-        @beginWxPythonOnly
-        The wxPython version of this method requires only the @a item and @a
-        textOnly parameters. The return value is either a wxRect object or @c
-        None.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         In wxPerl this method only takes the @a item and
         @a textOnly parameters and returns a @c Wx::Rect (or @c undef).
@@ -438,11 +432,6 @@ public:
         Returns an invalid tree item (i.e. wxTreeItemId::IsOk() returns @false)
         if there are no further children.
 
-        @beginWxPythonOnly
-        In wxPython the returned wxTreeItemId and the new cookie value are both
-        returned as a tuple containing the two values.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         In wxPerl this method only takes the @a item parameter, and
         returns a 2-element list (item, cookie).
@@ -505,12 +494,6 @@ public:
 
         @see wxTreeItemData
 
-        @beginWxPythonOnly
-        wxPython provides the following shortcut method:
-        @li GetPyData(item): Returns the Python Object associated with the
-            wxTreeItemData for the given item Id.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         wxPerl provides the following shortcut method:
         - GetPlData(item): returns the Perl data
@@ -578,11 +561,6 @@ public:
 
         Returns an invalid tree item if there are no further children.
 
-        @beginWxPythonOnly
-        In wxPython the returned wxTreeItemId and the new cookie value are both
-        returned as a tuple containing the two values.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         In wxPerl this method returns a 2-element list
         (item, cookie) instead of modifying its parameters.
@@ -657,11 +635,6 @@ public:
 
         Returns the number of selected items.
 
-        @beginWxPythonOnly
-        The wxPython version of this method accepts no parameters and returns a
-        Python list of @ref wxTreeItemId "wxTreeItemId"s.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         In wxPerl this method takes no parameters and returns a list of
         @c Wx::TreeItemId.
@@ -693,10 +666,6 @@ public:
         - @c wxTREE_HITTEST_TOLEFT: To the right of the client area.
         - @c wxTREE_HITTEST_TORIGHT: To the left of the client area.
 
-        @beginWxPythonOnly
-        In wxPython both the wxTreeItemId and the flags are returned as a tuple.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         In wxPerl this method only takes the @a point parameter
         and returns a 2-element list (item, flags).
@@ -729,10 +698,6 @@ public:
         image list specifying the image to use for unselected and selected
         items, respectively. If @a image -1 and @a selImage is -1, the same
         image is used for both selected and unselected items.
-
-        @beginWxPythonOnly
-        In wxPython, this form of this method is called @c InsertItemBefore().
-        @endWxPythonOnly
     */
     wxTreeItemId InsertItem(const wxTreeItemId& parent,
                             size_t before,
@@ -812,9 +777,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);
 
@@ -870,11 +840,6 @@ public:
         multiple times for the same item will result in memory leaks unless you
         delete the old item data pointer yourself.
 
-        @beginWxPythonOnly
-        - @b SetPyData( @a item, @c obj): Associate the given Python Object with
-            the wxTreeItemData for the given item Id.
-        @endWxPythonOnly
-
         @beginWxPerlOnly
         wxPerl provides the following shortcut method:
         - SetPlData(item, data): sets the Perl data
@@ -1141,3 +1106,27 @@ public:
     */
     void SetToolTip(const wxString& tooltip);
 };
+
+
+wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG;
+wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG;
+wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT;
+wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT;
+wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM;
+wxEventType wxEVT_COMMAND_TREE_GET_INFO;
+wxEventType wxEVT_COMMAND_TREE_SET_INFO;
+wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED;
+wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING;
+wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED;
+wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING;
+wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED;
+wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING;
+wxEventType wxEVT_COMMAND_TREE_KEY_DOWN;
+wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED;
+wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK;
+wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK;
+wxEventType wxEVT_COMMAND_TREE_END_DRAG;
+wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
+wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
+wxEventType wxEVT_COMMAND_TREE_ITEM_MENU;
+