Refactor wxGTK IM-related code to allow future modifications.

[wxWidgets.git] / interface / wx / treectrl.h

diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index 5fe1b856c941b6a239c5f2c0749b58c9ace0e70c..f328935b7e25a119383055ce61338a7f263ef158 100644 (file)
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -158,7 +158,7 @@
 
     @library{wxcore}
     @category{ctrl}
 
     @library{wxcore}
     @category{ctrl}

-    @appearance{treectrl.png}
+    @appearance{treectrl}

 
     @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl,
          wxListBox, wxListCtrl, wxImageList
 
     @see wxDataViewTreeCtrl, wxTreeEvent, wxTreeItemData, @ref overview_treectrl,
          wxListBox, wxListCtrl, wxImageList


@@ -339,6 +339,18 @@ public:
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
                                   wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));
 
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
                                   wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));
 

+    /**
+        Enable or disable a beep if there is no match for the currently
+        entered text when searching for the item from keyboard.
+
+        The default is to not beep in this case except in wxMSW where the
+        beep is always generated by the native control and cannot be disabled,
+        i.e. calls to this function do nothing there.
+
+        @since 2.9.5
+    */
+    void EnableBellOnNoMatch(bool on = true);
+

     /**
         Ends label editing. If @a cancelEdit is @true, the edit will be
         cancelled.
     /**
         Ends label editing. If @a cancelEdit is @true, the edit will be
         cancelled.


@@ -383,12 +395,6 @@ public:
         So, for example, the x coordinate may be negative if the tree has a
         horizontal scrollbar and its position is not 0.
 
         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).
         @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 +444,6 @@ public:
         Returns an invalid tree item (i.e. wxTreeItemId::IsOk() returns @false)
         if there are no further children.
 
         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).
         @beginWxPerlOnly
         In wxPerl this method only takes the @a item parameter, and
         returns a 2-element list (item, cookie).


@@ -505,12 +506,6 @@ public:
 
         @see wxTreeItemData
 
 
         @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
         @beginWxPerlOnly
         wxPerl provides the following shortcut method:
         - GetPlData(item): returns the Perl data


@@ -578,11 +573,6 @@ public:
 
         Returns an invalid tree item if there are no further children.
 
 
         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.
         @beginWxPerlOnly
         In wxPerl this method returns a 2-element list
         (item, cookie) instead of modifying its parameters.


@@ -657,11 +647,6 @@ public:
 
         Returns the number of selected items.
 
 
         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.
         @beginWxPerlOnly
         In wxPerl this method takes no parameters and returns a list of
         @c Wx::TreeItemId.


@@ -693,10 +678,6 @@ public:
         - @c wxTREE_HITTEST_TOLEFT: To the right of the client area.
         - @c wxTREE_HITTEST_TORIGHT: To the left of the client area.
 
         - @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).
         @beginWxPerlOnly
         In wxPerl this method only takes the @a point parameter
         and returns a 2-element list (item, flags).


@@ -722,20 +703,16 @@ public:
 
     /**
         Inserts an item before one identified
 
     /**
         Inserts an item before one identified

-        by its position (@a before). @a before must be less than the number of
-        children.
+        by its position (@a pos). @a pos must be less than or equal to
+        the number of children.

 
         The @a image and @a selImage parameters are an index within the normal
         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.
 
         The @a image and @a selImage parameters are an index within the normal
         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,
     */
     wxTreeItemId InsertItem(const wxTreeItemId& parent,

-                            size_t before,
+                            size_t pos,

                             const wxString& text,
                             int image = -1,
                             int selImage = -1,
                             const wxString& text,
                             int image = -1,
                             int selImage = -1,


@@ -749,7 +726,7 @@ public:
     virtual bool IsBold(const wxTreeItemId& item) const;
 
     /**
     virtual bool IsBold(const wxTreeItemId& item) const;
 
     /**

-        Returns @true if the control is empty (i.e. has no items, even no root
+        Returns @true if the control is empty (i.e.\ has no items, even no root

         one).
     */
     bool IsEmpty() const;
         one).
     */
     bool IsEmpty() const;


@@ -875,11 +852,6 @@ public:
         multiple times for the same item will result in memory leaks unless you
         delete the old item data pointer yourself.
 
         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
         @beginWxPerlOnly
         wxPerl provides the following shortcut method:
         - SetPlData(item, data): sets the Perl data


@@ -1083,7 +1055,7 @@ public:
         The state image has been clicked.
     @endEventTable
 
         The state image has been clicked.
     @endEventTable
 

-    @library{wxbase}
+    @library{wxcore}

     @category{events}
 
     @see wxTreeCtrl
     @category{events}
 
     @see wxTreeCtrl


@@ -1146,3 +1118,27 @@ public:
     */
     void SetToolTip(const wxString& tooltip);
 };
     */
     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;
+