Correct decoding of 4-byte integers in png2c script.

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

diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index 6897303738d1e5fb885438b07174e3818cdef957..d41d5d4336e7ef2428b9515483c6f7f6d772e298 100644 (file)
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTreeItemData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTreeItemData
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -65,51 +65,73 @@
           Begin dragging with the left mouse button.
           If you want to enable left-dragging you need to intercept this event
           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.
           Begin dragging with the left mouse button.
           If you want to enable left-dragging you need to intercept this event
           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.

+          Processes a @c wxEVT_COMMAND_TREE_BEGIN_DRAG event type.

     @event{EVT_TREE_BEGIN_RDRAG(id, func)}
           Begin dragging with the right mouse button.
           If you want to enable right-dragging you need to intercept this event
           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.
     @event{EVT_TREE_BEGIN_RDRAG(id, func)}
           Begin dragging with the right mouse button.
           If you want to enable right-dragging you need to intercept this event
           and explicitely call wxTreeEvent::Allow(), as it's vetoed by default.

+          Processes a @c wxEVT_COMMAND_TREE_BEGIN_RDRAG event type.

     @event{EVT_TREE_END_DRAG(id, func)}
           End dragging with the left or right mouse button.
     @event{EVT_TREE_END_DRAG(id, func)}
           End dragging with the left or right mouse button.

+          Processes a @c wxEVT_COMMAND_TREE_END_DRAG event type.

     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
           Begin editing a label. This can be prevented by calling Veto().
     @event{EVT_TREE_BEGIN_LABEL_EDIT(id, func)}
           Begin editing a label. This can be prevented by calling Veto().

+          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().
     @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.

     @event{EVT_TREE_DELETE_ITEM(id, func)}
           An item was deleted.
     @event{EVT_TREE_DELETE_ITEM(id, func)}
           An item was deleted.

+          Processes a @c wxEVT_COMMAND_TREE_DELETE_ITEM event type.

     @event{EVT_TREE_GET_INFO(id, func)}
           Request information from the application.
     @event{EVT_TREE_GET_INFO(id, func)}
           Request information from the application.

+          Processes a @c wxEVT_COMMAND_TREE_GET_INFO event type.

     @event{EVT_TREE_SET_INFO(id, func)}
           Information is being supplied.
     @event{EVT_TREE_SET_INFO(id, func)}
           Information is being supplied.

+          Processes a @c wxEVT_COMMAND_TREE_SET_INFO event type.

     @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
           The item has been activated, i.e. chosen by double clicking it with
           mouse or from keyboard.
     @event{EVT_TREE_ITEM_ACTIVATED(id, func)}
           The item has been activated, i.e. chosen by double clicking it with
           mouse or from keyboard.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_ACTIVATED event type.

     @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
           The item has been collapsed.
     @event{EVT_TREE_ITEM_COLLAPSED(id, func)}
           The item has been collapsed.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_COLLAPSED event type.

     @event{EVT_TREE_ITEM_COLLAPSING(id, func)}
           The item is being collapsed. This can be prevented by calling Veto().
     @event{EVT_TREE_ITEM_COLLAPSING(id, func)}
           The item is being collapsed. This can be prevented by calling Veto().

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_COLLAPSING event type.

     @event{EVT_TREE_ITEM_EXPANDED(id, func)}
           The item has been expanded.
     @event{EVT_TREE_ITEM_EXPANDED(id, func)}
           The item has been expanded.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_EXPANDED event type.

     @event{EVT_TREE_ITEM_EXPANDING(id, func)}
           The item is being expanded. This can be prevented by calling Veto().
     @event{EVT_TREE_ITEM_EXPANDING(id, func)}
           The item is being expanded. This can be prevented by calling Veto().

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_EXPANDING event type.

     @event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
           The user has clicked the item with the right mouse button.
     @event{EVT_TREE_ITEM_RIGHT_CLICK(id, func)}
           The user has clicked the item with the right mouse button.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK event type.

     @event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}
     @event{EVT_TREE_ITEM_MIDDLE_CLICK(id, func)}

-          The user has clicked the item with the middle mouse button.
+          The user has clicked the item with the middle mouse button. This is
+          only supported by the generic control.
+          Processes a @c wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK event type.

     @event{EVT_TREE_SEL_CHANGED(id, func)}
           Selection has changed.
     @event{EVT_TREE_SEL_CHANGED(id, func)}
           Selection has changed.

+          Processes a @c wxEVT_COMMAND_TREE_SEL_CHANGED event type.

     @event{EVT_TREE_SEL_CHANGING(id, func)}
           Selection is changing. This can be prevented by calling Veto().
     @event{EVT_TREE_SEL_CHANGING(id, func)}
           Selection is changing. This can be prevented by calling Veto().

+          Processes a @c wxEVT_COMMAND_TREE_SEL_CHANGING event type.

     @event{EVT_TREE_KEY_DOWN(id, func)}
           A key has been pressed.
     @event{EVT_TREE_KEY_DOWN(id, func)}
           A key has been pressed.

+          Processes a @c wxEVT_COMMAND_TREE_KEY_DOWN event type.

     @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
           The opportunity to set the item tooltip is being given to the application
           (call wxTreeEvent::SetToolTip). Windows only.
     @event{EVT_TREE_ITEM_GETTOOLTIP(id, func)}
           The opportunity to set the item tooltip is being given to the application
           (call wxTreeEvent::SetToolTip). Windows only.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP event type.

     @event{EVT_TREE_ITEM_MENU(id, func)}
           The context menu for the selected item has been requested, either by a
           right click or by using the menu key.
     @event{EVT_TREE_ITEM_MENU(id, func)}
           The context menu for the selected item has been requested, either by a
           right click or by using the menu key.

+          Processes a @c wxEVT_COMMAND_TREE_ITEM_MENU event type.

     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
           The state image has been clicked. Windows only.
     @event{EVT_TREE_STATE_IMAGE_CLICK(id, func)}
           The state image has been clicked. Windows only.

+          Processes a @c wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK event type.

     @endEventTable
 
 
     @endEventTable
 
 


@@ -307,7 +329,7 @@ public:
         @see EndEditLabel(), wxTreeEvent
     */
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
         @see EndEditLabel(), wxTreeEvent
     */
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,

-                                  wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
+                                  wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));

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


@@ -358,6 +380,11 @@ public:
         textOnly parameters. The return value is either a wxRect object or @c
         None.
         @endWxPythonOnly
         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).
+        @endWxPerlOnly

     */
     virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
                                  bool textOnly = false) const;
     */
     virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
                                  bool textOnly = false) const;


@@ -408,6 +435,11 @@ public:
         returned as a tuple containing the two values.
         @endWxPythonOnly
 
         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).
+        @endWxPerlOnly
+

         @see GetNextChild(), GetNextSibling()
     */
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
         @see GetNextChild(), GetNextSibling()
     */
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,


@@ -427,6 +459,24 @@ public:
     */
     virtual wxTreeItemId GetFocusedItem() const;
 
     */
     virtual wxTreeItemId GetFocusedItem() const;
 

+
+    /**
+        Clears the currently focused item
+
+        @since 2.9.1
+    */
+    virtual void ClearFocusedItem();
+
+    /**
+        Sets the currently focused item.
+
+        @param item
+            The item to make the current one. It must be valid.
+        @since 2.9.1
+    */
+    virtual void SetFocusedItem(const wxTreeItemId& item);
+
+

     /**
         Returns the normal image list.
     */
     /**
         Returns the normal image list.
     */


@@ -452,6 +502,13 @@ public:
         @li GetPyData(item): Returns the Python Object associated with the
             wxTreeItemData for the given item Id.
         @endWxPythonOnly
         @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
+          associated with the Wx::TreeItemData. It is just the same as
+          tree->GetItemData(item)->GetData().
+        @endWxPerlOnly

     */
     virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
 
     */
     virtual wxTreeItemData* GetItemData(const wxTreeItemId& item) const;
 


@@ -518,6 +575,11 @@ public:
         returned as a tuple containing the two values.
         @endWxPythonOnly
 
         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.
+        @endWxPerlOnly
+

         @see GetFirstChild()
     */
     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
         @see GetFirstChild()
     */
     virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,


@@ -591,6 +653,11 @@ public:
         The wxPython version of this method accepts no parameters and returns a
         Python list of @ref wxTreeItemId "wxTreeItemId"s.
         @endWxPythonOnly
         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.
+        @endWxPerlOnly

     */
     virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
 
     */
     virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
 


@@ -621,6 +688,11 @@ public:
         @beginWxPythonOnly
         In wxPython both the wxTreeItemId and the flags are returned as a tuple.
         @endWxPythonOnly
         @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).
+        @endWxPerlOnly

     */
     wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
 
     */
     wxTreeItemId HitTest(const wxPoint& point, int& flags) const;
 


@@ -701,8 +773,8 @@ public:
         zero or positive value if the first item is less than, equal to or
         greater than the second one.
 
         zero or positive value if the first item is less than, equal to or
         greater than the second one.
 

-        Please note that you @b must use wxRTTI macros DECLARE_DYNAMIC_CLASS()
-        and IMPLEMENT_DYNAMIC_CLASS() if you override this function because
+        Please note that you @b must use wxRTTI macros wxDECLARE_DYNAMIC_CLASS()
+        and wxIMPLEMENT_DYNAMIC_CLASS() if you override this function because

         otherwise the base class considers that it is not overridden and uses
         the default comparison, i.e. sorts the items alphabetically, which
         allows it optimize away the calls to the virtual function completely.
         otherwise the base class considers that it is not overridden and uses
         the default comparison, i.e. sorts the items alphabetically, which
         allows it optimize away the calls to the virtual function completely.


@@ -795,6 +867,12 @@ public:
             the wxTreeItemData for the given item Id.
         @endWxPythonOnly
 
             the wxTreeItemData for the given item Id.
         @endWxPythonOnly
 

+        @beginWxPerlOnly
+        wxPerl provides the following shortcut method:
+        - SetPlData(item, data): sets the Perl data
+          associated with the @c Wx::TreeItemData. It is just the same as
+          tree->GetItemData(item)->SetData(data).
+        @endWxPerlOnly

     */
     virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
 
     */
     virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData* data);
 


@@ -916,6 +994,15 @@ public:
         Unselects the given item. This works in multiselection controls only.
     */
     void UnselectItem(const wxTreeItemId& item);
         Unselects the given item. This works in multiselection controls only.
     */
     void UnselectItem(const wxTreeItemId& item);

+
+    /**
+        Select all the immediate children of the given parent.
+
+        This function can be used with multiselection controls only.
+
+        @since 2.9.1
+    */
+    virtual void SelectChildren(const wxTreeItemId& parent);

 };
 
 
 };