Updated version to 2.5.5

[wxWidgets.git] / include / wx / palmos / treectrl.h

diff --git a/include/wx/palmos/treectrl.h b/include/wx/palmos/treectrl.h
index 09811d6c0c570199a71f0323db113b2d3769717c..bf7355d02723537f422060377ed16f40542218c7 100644 (file)
--- a/include/wx/palmos/treectrl.h
+++ b/include/wx/palmos/treectrl.h
@@ -1,10 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/palmos/treectrl.h
 // Purpose:     wxTreeCtrl class
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/palmos/treectrl.h
 // Purpose:     wxTreeCtrl class

-// Author:      William Osborne
+// Author:      William Osborne - minimal working wxPalmOS port

 // Modified by:
 // Created:     10/13/04
 // Modified by:
 // Created:     10/13/04

-// RCS-ID:      $Id: 
+// RCS-ID:      $Id$

 // Copyright:   (c) William Osborne
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) William Osborne
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -27,12 +27,6 @@
 #include "wx/treebase.h"
 #include "wx/hashmap.h"
 
 #include "wx/treebase.h"
 #include "wx/hashmap.h"
 

-#ifdef __GNUWIN32__
-    // Cygwin windows.h defines these identifiers
-    #undef GetFirstChild
-    #undef GetNextSibling
-#endif // Cygwin
-

 // fwd decl
 class  WXDLLEXPORT wxImageList;
 class  WXDLLEXPORT wxDragImage;
 // fwd decl
 class  WXDLLEXPORT wxImageList;
 class  WXDLLEXPORT wxDragImage;


@@ -69,7 +63,7 @@ public:
     // --------
     wxTreeCtrl() { Init(); }
 
     // --------
     wxTreeCtrl() { Init(); }
 

-    wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
+    wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,

                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,


@@ -81,7 +75,7 @@ public:
 
     virtual ~wxTreeCtrl();
 
 
     virtual ~wxTreeCtrl();
 

-    bool Create(wxWindow *parent, wxWindowID id = -1,
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,


@@ -101,7 +95,6 @@ public:
     void SetIndent(unsigned int indent);
 
     // spacing is the number of pixels between the start and the Text
     void SetIndent(unsigned int indent);
 
     // spacing is the number of pixels between the start and the Text

-        // not implemented under wxMSW

     unsigned int GetSpacing() const { return 18; } // return wxGTK default
     void SetSpacing(unsigned int WXUNUSED(spacing)) { }
 
     unsigned int GetSpacing() const { return 18; } // return wxGTK default
     void SetSpacing(unsigned int WXUNUSED(spacing)) { }
 


@@ -163,13 +156,13 @@ public:
         // allow the user to expand the items which don't have any children now
         // - but instead add them only when needed, thus minimizing memory
         // usage and loading time.
         // allow the user to expand the items which don't have any children now
         // - but instead add them only when needed, thus minimizing memory
         // usage and loading time.

-    void SetItemHasChildren(const wxTreeItemId& item, bool has = TRUE);
+    void SetItemHasChildren(const wxTreeItemId& item, bool has = true);

 
         // the item will be shown in bold
 
         // the item will be shown in bold

-    void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
+    void SetItemBold(const wxTreeItemId& item, bool bold = true);

 
         // the item will be shown with a drop highlight
 
         // the item will be shown with a drop highlight

-    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = TRUE);
+    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);

 
         // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
 
         // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);


@@ -197,15 +190,15 @@ public:
     // number of children
     // ------------------
 
     // number of children
     // ------------------
 

-        // if 'recursively' is FALSE, only immediate children count, otherwise
+        // if 'recursively' is false, only immediate children count, otherwise

         // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,
         // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,

-                            bool recursively = TRUE) const;
+                            bool recursively = true) const;

 
     // navigation
     // ----------
 
 
     // navigation
     // ----------
 

-    // wxTreeItemId.IsOk() will return FALSE if there is no such item
+    // wxTreeItemId.IsOk() will return false if there is no such item

 
         // get the root tree item
     wxTreeItemId GetRootItem() const;
 
         // get the root tree item
     wxTreeItemId GetRootItem() const;


@@ -222,15 +215,6 @@ public:
         // get the parent of this item (may return NULL if root)
     wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 
         // get the parent of this item (may return NULL if root)
     wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 

-#if WXWIN_COMPATIBILITY_2_2
-        // deprecated:  Use GetItemParent instead.
-    wxTreeItemId GetParent(const wxTreeItemId& item) const
-        { return GetItemParent( item ); }
-
-        // Expose the base class method hidden by the one above.
-    wxWindow *GetParent() const { return wxControl::GetParent(); }
-#endif  // WXWIN_COMPATIBILITY_2_2
-

         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library
         // to make these functions reentrant (i.e. allow more than one
         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library
         // to make these functions reentrant (i.e. allow more than one


@@ -340,7 +324,7 @@ public:
         // edited simultaneously)
     wxTextCtrl* GetEditControl() const;
         // end editing and accept or discard the changes to item label
         // edited simultaneously)
     wxTextCtrl* GetEditControl() const;
         // end editing and accept or discard the changes to item label

-    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
+    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);

 
     // sorting
         // this function is called to compare 2 items and should return -1, 0
 
     // sorting
         // this function is called to compare 2 items and should return -1, 0


@@ -371,43 +355,7 @@ public:
         // get the bounding rectangle of the item (or of its label only)
     bool GetBoundingRect(const wxTreeItemId& item,
                          wxRect& rect,
         // get the bounding rectangle of the item (or of its label only)
     bool GetBoundingRect(const wxTreeItemId& item,
                          wxRect& rect,

-                         bool textOnly = FALSE) const;
-
-    // deprecated
-    // ----------
-
-#if WXWIN_COMPATIBILITY_2_4
-    // these methods are deprecated and will be removed in future versions of
-    // wxWidgets, they're here for compatibility only, don't use them in new
-    // code (the comments indicate why these methods are now useless and how to
-    // replace them)
-
-        // use Expand, Collapse, CollapseAndReset or Toggle
-    wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) );
-
-        // use AddRoot, PrependItem or AppendItem
-    wxDEPRECATED( wxTreeItemId InsertItem(const wxTreeItemId& parent,
-                            const wxString& text,
-                            int image = -1, int selImage = -1,
-                            long insertAfter = wxTREE_INSERT_LAST) );
-
-        // use Set/GetImageList and Set/GetStateImageList
-    wxImageList *GetImageList(int) const { return GetImageList(); }
-    void SetImageList(wxImageList *imageList, int) { SetImageList(imageList); }
-
-    // use Set/GetItemImage directly
-    int GetItemSelectedImage(const wxTreeItemId& item) const
-        { return GetItemImage(item, wxTreeItemIcon_Selected); }
-    void SetItemSelectedImage(const wxTreeItemId& item, int image)
-        { SetItemImage(item, image, wxTreeItemIcon_Selected); }
-
-    // use the versions taking wxTreeItemIdValue cookies
-    wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
-                                             long& cookie) const );
-    wxDEPRECATED( wxTreeItemId GetNextChild(const wxTreeItemId& item,
-                                            long& cookie) const );
-#endif // WXWIN_COMPATIBILITY_2_4
-
+                         bool textOnly = false) const;

 
     // implementation
     // --------------
 
     // implementation
     // --------------


@@ -422,18 +370,13 @@ public:
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 

-
-    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-    virtual bool MSWCommand(WXUINT param, WXWORD id);
-    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
-

     // override some base class virtuals
     virtual bool SetBackgroundColour(const wxColour &colour);
     virtual bool SetForegroundColour(const wxColour &colour);
 
     // get/set the check state for the item (only for wxTR_MULTIPLE)
     bool IsItemChecked(const wxTreeItemId& item) const;
     // override some base class virtuals
     virtual bool SetBackgroundColour(const wxColour &colour);
     virtual bool SetForegroundColour(const wxColour &colour);
 
     // get/set the check state for the item (only for wxTR_MULTIPLE)
     bool IsItemChecked(const wxTreeItemId& item) const;

-    void SetItemCheck(const wxTreeItemId& item, bool check = TRUE);
+    void SetItemCheck(const wxTreeItemId& item, bool check = true);

 
     // set/get the item state.image (state == -1 means cycle to the next one)
     void SetState(const wxTreeItemId& node, int state);
 
     // set/get the item state.image (state == -1 means cycle to the next one)
     void SetState(const wxTreeItemId& node, int state);


@@ -477,7 +420,7 @@ private:
     void DeleteTextCtrl();
 
     // support for additional item images which we implement using
     void DeleteTextCtrl();
 
     // support for additional item images which we implement using

-    // wxTreeItemIndirectData technique - see the comments in msw/treectrl.cpp
+    // wxTreeItemIndirectData technique

     void SetIndirectItemData(const wxTreeItemId& item,
                              class wxTreeItemIndirectData *data);
     bool HasIndirectData(const wxTreeItemId& item) const;
     void SetIndirectItemData(const wxTreeItemId& item,
                              class wxTreeItemIndirectData *data);
     bool HasIndirectData(const wxTreeItemId& item) const;


@@ -487,7 +430,7 @@ private:
     // the hash storing the items attributes (indexed by item ids)
     wxMapTreeAttr m_attrs;
 
     // the hash storing the items attributes (indexed by item ids)
     wxMapTreeAttr m_attrs;
 

-    // TRUE if the hash above is not empty
+    // true if the hash above is not empty

     bool m_hasAnyAttr;
 
     // used for dragging
     bool m_hasAnyAttr;
 
     // used for dragging


@@ -508,5 +451,4 @@ private:
 
 #endif // wxUSE_TREECTRL
 
 
 #endif // wxUSE_TREECTRL
 

-#endif
-    // _WX_TREECTRL_H_
+#endif // _WX_TREECTRL_H_