Set TOOLKIT_LOWERCASE correctly for the various flavors of wxOSX

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

diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h
index d390c6307dd764c08e15654f751b2a7c534f9837..16236a68459cb4456c5ad78c1c0eaaf15231dcb9 100644 (file)
--- a/interface/wx/treectrl.h
+++ b/interface/wx/treectrl.h
@@ -155,12 +155,12 @@ public:
 
         @see Create(), wxValidator
     */
-    wxTreeCtrl(wxWindow* parent, wxWindowID id,
+    wxTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
-               long style = wxTR_HAS_BUTTONS,
+               long style = wxTR_DEFAULT_STYLE,
                const wxValidator& validator = wxDefaultValidator,
-               const wxString& name = "treeCtrl");
+               const wxString& name = wxTreeCtrlNameStr);
 
 
     /**
@@ -253,15 +253,15 @@ public:
     virtual void CollapseAndReset(const wxTreeItemId& item);
 
     /**
-        Creates the tree control. See wxTreeCtrl::wxTreeCtrl() for further
-        details.
+        Creates the tree control.
+        See wxTreeCtrl::wxTreeCtrl() for further details.
     */
-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
-                long style = wxTR_HAS_BUTTONS,
+                long style = wxTR_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "treeCtrl");
+                const wxString& name = wxTreeCtrlNameStr);
 
     /**
         Deletes the specified item. A EVT_TREE_DELETE_ITEM() event will be
@@ -298,7 +298,8 @@ public:
 
         @see EndEditLabel(), wxTreeEvent
     */
-    void EditLabel(const wxTreeItemId& item);
+    virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
+                                  wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
 
     /**
         Ends label editing. If @a cancelEdit is @true, the edit will be
@@ -309,7 +310,7 @@ public:
 
         @see EditLabel()
     */
-    void EndEditLabel(bool cancelEdit);
+    virtual void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);
 
     /**
         Scrolls and/or expands items to ensure that the given item is visible.
@@ -350,8 +351,8 @@ public:
         None.
         @endWxPythonOnly
     */
-    bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
-                         bool textOnly = false) const;
+    virtual bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect,
+                                 bool textOnly = false) const;
 
     /**
         Returns the buttons image list (from which application-defined button
@@ -366,8 +367,8 @@ public:
         returns the total number of descendants, otherwise only one level of
         children is counted.
     */
-    unsigned int GetChildrenCount(const wxTreeItemId& item,
-                                  bool recursively = true) const;
+    virtual size_t GetChildrenCount(const wxTreeItemId& item,
+                                    bool recursively = true) const;
 
     /**
         Returns the number of items in the control.
@@ -401,8 +402,8 @@ public:
 
         @see GetNextChild(), GetNextSibling()
     */
-    wxTreeItemId GetFirstChild(const wxTreeItemId& item,
-                               wxTreeItemIdValue& cookie) const;
+    virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+                                       wxTreeItemIdValue& cookie) const;
 
     /**
         Returns the first visible item.
@@ -417,7 +418,7 @@ public:
     /**
         Returns the current tree control indentation.
     */
-    int GetIndent() const;
+    virtual unsigned int GetIndent() const;
 
     /**
         Returns the background colour of the item.
@@ -454,21 +455,14 @@ public:
         - ::wxTreeItemIcon_SelectedExpanded: to get the selected expanded image
             (which is shown when an expanded item is currently selected).
     */
-    int GetItemImage(const wxTreeItemId& item,
-                     wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
+    virtual int GetItemImage(const wxTreeItemId& item,
+                             wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
 
     /**
         Returns the item's parent.
     */
     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 
-    /**
-        Gets the selected item image (this function is obsolete, use @ref
-        GetItemImage() "GetItemImage"( @a item, ::wxTreeItemIcon_Selected)
-        instead).
-    */
-    int GetItemSelectedImage(const wxTreeItemId& item) const;
-
     /**
         Gets the specified item state.
     */
@@ -509,8 +503,8 @@ public:
 
         @see GetFirstChild()
     */
-    wxTreeItemId GetNextChild(const wxTreeItemId& item,
-                              wxTreeItemIdValue& cookie) const;
+    virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
+                                      wxTreeItemIdValue& cookie) const;
 
     /**
         Returns the next sibling of the specified item; call GetPrevSibling()
@@ -580,7 +574,7 @@ public:
         Python list of @ref wxTreeItemId "wxTreeItemId"s.
         @endWxPythonOnly
     */
-    unsigned int GetSelections(wxArrayTreeItemIds& selection) const;
+    virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
 
     /**
         Returns the state image list (from which application-defined state
@@ -699,8 +693,8 @@ public:
 
         @see SortChildren()
     */
-    int OnCompareItems(const wxTreeItemId& item1,
-                       const wxTreeItemId& item2);
+    virtual int OnCompareItems(const wxTreeItemId& item1,
+                               const wxTreeItemId& item2);
 
     /**
         Appends an item as the first child of @a parent, return a new item id.
@@ -756,13 +750,13 @@ public:
     /**
         Sets the indentation for the tree control.
     */
-    void SetIndent(int indent);
+    virtual void SetIndent(unsigned int indent);
 
     /**
         Sets the colour of the item's background.
     */
-    void SetItemBackgroundColour(const wxTreeItemId& item,
-                                 const wxColour& col);
+    virtual void SetItemBackgroundColour(const wxTreeItemId& item,
+                                         const wxColour& col);
 
     /**
         Makes item appear in bold font if @a bold parameter is @true or resets
@@ -790,8 +784,8 @@ public:
         (as opposed to a DnD operation within the tree control, which already
         is implemented internally).
     */
-    void SetItemDropHighlight(const wxTreeItemId& item,
-                              bool highlight = true);
+    virtual void SetItemDropHighlight(const wxTreeItemId& item,
+                                      bool highlight = true);
 
     /**
         Sets the item's font. All items in the tree should have the same height
@@ -808,22 +802,15 @@ public:
         but instead adding them only when needed, thus minimizing memory
         usage and loading time.
     */
-    void SetItemHasChildren(const wxTreeItemId& item,
-                            bool hasChildren = true);
+    virtual void SetItemHasChildren(const wxTreeItemId& item,
+                                    bool hasChildren = true);
 
     /**
         Sets the specified item's image. See GetItemImage() for the description
         of the @a which parameter.
     */
-    void SetItemImage(const wxTreeItemId& item, int image,
-                      wxTreeItemIcon which = wxTreeItemIcon_Normal);
-
-    /**
-        Sets the selected item image (this function is obsolete, use @ref
-        SetItemImage() "SetItemImage"( @a item, ::wxTreeItemIcon_Selected )
-        instead).
-    */
-    void SetItemSelectedImage(const wxTreeItemId& item, int selImage);
+    virtual void SetItemImage(const wxTreeItemId& item, int image,
+                              wxTreeItemIcon which = wxTreeItemIcon_Normal);
 
     /**
         Sets the specified item state. The value of @a state may be:
@@ -842,8 +829,8 @@ public:
     /**
         Sets the colour of the item's text.
     */
-    void SetItemTextColour(const wxTreeItemId& item,
-                           const wxColour& col);
+    virtual void SetItemTextColour(const wxTreeItemId& item,
+                                   const wxColour& col);
 
     /**
         If @true is passed, specifies that the control will use a quick
@@ -980,7 +967,8 @@ public:
     /**
         Constructor, used by wxWidgets itself only.
     */
-    wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree);
+    wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree,
+                const wxTreeItemId& item = wxTreeItemId());
 
     /**
         Returns the item (valid for all events).
@@ -996,12 +984,12 @@ public:
     /**
         Returns the key event for EVT_TREE_KEY_DOWN() events.
     */
-    const wxKeyEvent GetKeyEvent() const;
+    const wxKeyEvent& GetKeyEvent() const;
 
     /**
         Returns the label if the event is a begin or end edit label event.
     */
-    const wxString GetLabel() const;
+    const wxString& GetLabel() const;
 
     /**
         Returns the old item index (valid for EVT_TREE_ITEM_CHANGING() and