]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk/treectrl.h
Minimum is now GTK+ 2.4
[wxWidgets.git] / include / wx / gtk / treectrl.h
index 280b08ea3a5f7f96144b88360e92bc68eaa07d8f..c45ecf4eed566ca005239bf15c9706cdcf453174 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        treectrl.h
+// Name:        wx/gtk/treectrl.h
 // Purpose:     wxTreeCtrl class
 // Author:      Denis Pershin
 // Modified by:
@@ -27,7 +27,7 @@ struct wxTreeViewItem;
 // a callback function used for sorting tree items, it should return -1 if the
 // first item precedes the second, +1 if the second precedes the first or 0 if
 // they're equivalent
-class WXDLLIMPEXP_CORE wxTreeItemData;
+class WXDLLIMPEXP_FWD_CORE wxTreeItemData;
 typedef int (*wxTreeItemCmpFunc)(wxTreeItemData *item1, wxTreeItemData *item2);
 
 // ----------------------------------------------------------------------------
@@ -63,12 +63,13 @@ static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
                                           wxTREE_HITTEST_ONITEMLABEL |
                                           wxTREE_HITTEST_ONITEMSTATEICON;
 
-// NB: all the following flags are for compatbility only and will be removed in
-//     next versions
-
-// flags for deprecated InsertItem() variant
-#define wxTREE_INSERT_FIRST 0xFFFF0001
-#define wxTREE_INSERT_LAST  0xFFFF0002
+#if WXWIN_COMPATIBILITY_2_6
+    // NB: all the following flags are for compatbility only and will be removed in
+    //     next versions
+    // flags for deprecated InsertItem() variant
+    #define wxTREE_INSERT_FIRST 0xFFFF0001
+    #define wxTREE_INSERT_LAST  0xFFFF0002
+#endif
 
 // ----------------------------------------------------------------------------
 // wxTreeItemId identifies an element of the tree. In this implementation, it's
@@ -126,22 +127,24 @@ public:
     const wxTreeItemId& GetId() const { return (wxTreeItemId&) m_itemId; }
 };
 
-class WXDLLEXPORT wxTreeCtrl: public wxControl {
+class WXDLLEXPORT wxTreeCtrl: public wxControl
+{
 public:
-  // creation
-  // --------
-  wxTreeCtrl() { Init(); }
-
-  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 wxValidator& validator = wxDefaultValidator,
-             const wxString& name = "wxTreeCtrl") {
-      Create(parent, id, pos, size, style, validator, name);
-  }
-
-  virtual ~wxTreeCtrl();
+    // creation
+    // --------
+    wxTreeCtrl() { Init(); }
+
+    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 wxValidator& validator = wxDefaultValidator,
+               const wxString& name = "wxTreeCtrl")
+    {
+        Create(parent, id, pos, size, style, validator, name);
+    }
+
+    virtual ~wxTreeCtrl();
 
     bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
@@ -154,7 +157,7 @@ public:
     // ---------
 
         // get the total number of items in the control
-    size_t GetCount() const;
+    virtual unsigned int GetCount() const;
 
         // indent is the number of pixels the children are indented relative to
         // the parents position. SetIndent() also redraws the control
@@ -190,8 +193,6 @@ public:
     wxString GetItemText(const wxTreeItemId& item) const;
         // get the normal item image
     int GetItemImage(const wxTreeItemId& item) const;
-        // get the selected item image
-    int GetItemSelectedImage(const wxTreeItemId& item) const;
         // get the data associated with the item
     wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
 
@@ -202,8 +203,6 @@ public:
     void SetItemText(const wxTreeItemId& item, const wxString& text);
         // set the normal item image
     void SetItemImage(const wxTreeItemId& item, int image);
-        // set the selected item image
-    void SetItemSelectedImage(const wxTreeItemId& item, int image);
         // associate some data with the item
     void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
 
@@ -247,10 +246,6 @@ public:
         // the "cookie" passed to GetFirstChild() and GetNextChild() should be
         // the same!
 
-        // get the first child of this item
-    wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
-        // get the next child (after GetFirstChild or GetNextChild)
-    wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
         // get the last child of this item - this method doesn't use cookies
     wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
 
@@ -342,55 +337,71 @@ public:
     // deprecated
     // ----------
 
+#if WXWIN_COMPATIBILITY_2_6
     // 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
-    void ExpandItem(const wxTreeItemId& item, int action);
+    wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) );
+
+        // use SetImageList
+    wxDEPRECATED( void SetImageList(wxImageList *imageList, int) )
+        { SetImageList(imageList); }
+
+        // use Set/GetItemImage directly
+    wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const );
+    wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) );
 
+    // use the versions taking wxTreeItemIdValue cookies
+    wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+                                             long& cookie) const );
+    wxDEPRECATED( wxTreeItemId GetNextChild(const wxTreeItemId& item,
+                                            long& cookie) const );
         // use AddRoot, PrependItem or AppendItem
-    wxTreeItemId InsertItem(const wxTreeItemId& parent,
-                            const wxString& text,
-                            int image = -1, int selImage = -1,
-                            long insertAfter = wxTREE_INSERT_LAST);
+    wxDEPRECATED( wxTreeItemId InsertItem(const wxTreeItemId& parent,
+                                          const wxString& text,
+                                          int image = -1, int selImage = -1,
+                                          long insertAfter = wxTREE_INSERT_LAST) );
+
+#endif // WXWIN_COMPATIBILITY_2_6
 
         // use Set/GetImageList and Set/GetStateImageList
     wxImageList *GetImageList(int) const
         { return GetImageList(); }
-    void SetImageList(wxImageList *imageList, int)
-        { SetImageList(imageList); }
 
-  void SendExpanding(const wxTreeItemId& item);
-  void SendExpanded(const wxTreeItemId& item);
-  void SendCollapsing(const wxTreeItemId& item);
-  void SendCollapsed(const wxTreeItemId& item);
-  void SendSelChanging(const wxTreeItemId& item);
-  void SendSelChanged(const wxTreeItemId& item);
+    void SendExpanding(const wxTreeItemId& item);
+    void SendExpanded(const wxTreeItemId& item);
+    void SendCollapsing(const wxTreeItemId& item);
+    void SendCollapsed(const wxTreeItemId& item);
+    void SendSelChanging(const wxTreeItemId& item);
+    void SendSelChanged(const wxTreeItemId& item);
+
 protected:
-  wxTreeItemId m_editItem;
-  GtkTree *m_tree;
-  GtkTreeItem *m_anchor;
-  wxTextCtrl*  m_textCtrl;
-  wxImageList* m_imageListNormal;
-  wxImageList* m_imageListState;
 
-  long m_curitemId;
+    wxTreeItemId m_editItem;
+    GtkTree *m_tree;
+    GtkTreeItem *m_anchor;
+    wxTextCtrl*  m_textCtrl;
+    wxImageList* m_imageListNormal;
+    wxImageList* m_imageListState;
+
+    long m_curitemId;
 
-  void SendMessage(wxEventType command, const wxTreeItemId& item);
+    void SendMessage(wxEventType command, const wxTreeItemId& item);
 //  GtkTreeItem *findGtkTreeItem(wxTreeCtrlId &id) const;
 
     // the common part of all ctors
-  void Init();
+    void Init();
       // insert a new item in as the last child of the parent
-  wxTreeItemId p_InsertItem(GtkTreeItem *p,
-                          const wxString& text,
-                          int image, int selectedImage,
-                          wxTreeItemData *data);
+    wxTreeItemId p_InsertItem(GtkTreeItem *p,
+                              const wxString& text,
+                              int image, int selectedImage,
+                              wxTreeItemData *data);
 
 
-  DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
+    DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 };
 
 #endif