Hopefully fixed library names generated by wx-config for OS/2's PM port.

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

diff --git a/include/wx/gtk/treectrl.h b/include/wx/gtk/treectrl.h
index afdd14c5cce4bf52d91807d5ff1b755716c69729..b5452888b6b2d96e95433d1d34f98345358b703b 100644 (file)
--- a/include/wx/gtk/treectrl.h
+++ b/include/wx/gtk/treectrl.h
@@ -6,19 +6,17 @@
 // Created:     08/08/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Denis Pershin
 // Created:     08/08/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Denis Pershin

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

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TREECTRL_H_
 #define _WX_TREECTRL_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TREECTRL_H_
 #define _WX_TREECTRL_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "treectrl.h"
 #endif
 
 #include "wx/textctrl.h"
 #pragma interface "treectrl.h"
 #endif
 
 #include "wx/textctrl.h"

-#include "wx/control.h"
-#include "wx/event.h"

 #include "wx/imaglist.h"
 
 #include <gtk/gtk.h>
 #include "wx/imaglist.h"
 
 #include <gtk/gtk.h>


@@ -72,15 +70,6 @@ static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 // NB: all the following flags are for compatbility only and will be removed in
 //     next versions
 
 // NB: all the following flags are for compatbility only and will be removed in
 //     next versions
 

-// flags for deprecated `Expand(int action)'
-enum
-{
-    wxTREE_EXPAND_EXPAND,
-    wxTREE_EXPAND_COLLAPSE,
-    wxTREE_EXPAND_COLLAPSE_RESET,
-    wxTREE_EXPAND_TOGGLE
-};
-

 // flags for deprecated InsertItem() variant
 #define wxTREE_INSERT_FIRST 0xFFFF0001
 #define wxTREE_INSERT_LAST  0xFFFF0002
 // flags for deprecated InsertItem() variant
 #define wxTREE_INSERT_FIRST 0xFFFF0001
 #define wxTREE_INSERT_LAST  0xFFFF0002


@@ -103,11 +92,12 @@ public:
 
   // conversion to/from either real (system-dependent) tree item id or
   // to "long" which used to be the type for tree item ids in previous
 
   // conversion to/from either real (system-dependent) tree item id or
   // to "long" which used to be the type for tree item ids in previous

-  // versions of wxWindows
+  // versions of wxWidgets

 
   // for wxTreeCtrl usage only
   wxTreeItemId(GtkTreeItem *itemId) { m_itemId = itemId; }
   operator GtkTreeItem *() const { return m_itemId; }
 
   // for wxTreeCtrl usage only
   wxTreeItemId(GtkTreeItem *itemId) { m_itemId = itemId; }
   operator GtkTreeItem *() const { return m_itemId; }

+  void operator =(GtkTreeItem *item) { m_itemId = item; }

 
 protected:
   GtkTreeItem *m_itemId;
 
 protected:
   GtkTreeItem *m_itemId;


@@ -126,25 +116,18 @@ protected:
 // Because the objects of this class are deleted by the tree, they should
 // always be allocated on the heap!
 // ----------------------------------------------------------------------------
 // Because the objects of this class are deleted by the tree, they should
 // always be allocated on the heap!
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxTreeItemData {
-friend class wxTreeCtrl;
+class WXDLLEXPORT wxTreeItemData : private wxTreeItemId {

 public:
 public:

-  // creation/destruction
-  // --------------------
-      // default ctor
-  wxTreeItemData() { }
+    // default ctor/copy ctor/assignment operator are ok

 
 

-      // default copy ctor/assignment operator are ok
-      // dtor is virtual and all the items are deleted by the tree control
-      // when it's deleted, so you normally don't have to care about freeing
-      // memory allocated in your wxTreeItemData-derived class
-  virtual ~wxTreeItemData() { }
+    // dtor is virtual and all the items are deleted by the tree control when
+    // it's deleted, so you normally don't have to care about freeing memory
+    // allocated in your wxTreeItemData-derived class
+    virtual ~wxTreeItemData() { }

 
 

-  // accessor: get the item associated with us
-  const wxTreeItemId& GetItemId() const { return m_itemId; }
-
-protected:
-  wxTreeItemId m_itemId;
+    // accessors: set/get the item associated with this node
+    void SetId(const wxTreeItemId& id) { m_itemId = id; }
+    const wxTreeItemId& GetId() const { return (wxTreeItemId&) m_itemId; }

 };
 
 class WXDLLEXPORT wxTreeCtrl: public wxControl {
 };
 
 class WXDLLEXPORT wxTreeCtrl: public wxControl {


@@ -153,7 +136,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,


@@ -164,7 +147,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,


@@ -240,10 +223,17 @@ public:
         // is this item currently selected (the same as has focus)?
     bool IsSelected(const wxTreeItemId& item) const;
 
         // is this item currently selected (the same as has focus)?
     bool IsSelected(const wxTreeItemId& item) const;
 

+    // number of children
+    // ------------------
+
+        // 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, bool recursively = true);
+

     // 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;


@@ -252,7 +242,7 @@ public:
     wxTreeItemId GetSelection() const;
 
         // get the parent of this item (may return NULL if root)
     wxTreeItemId GetSelection() const;
 
         // get the parent of this item (may return NULL if root)

-    wxTreeItemId GetParent(const wxTreeItemId& item) const;
+    wxTreeItemId GetItemParent(const wxTreeItemId& item) const;

 
         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library
 
         // for this enumeration function you must pass in a "cookie" parameter
         // which is opaque for the application but is necessary for the library


@@ -263,8 +253,10 @@ public:
 
         // get the first child of this item
     wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
 
         // get the first child of this item
     wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;

-        // get the next child
+        // get the next child (after GetFirstChild or GetNextChild)

     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
     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;

 
         // get the next sibling of this item
     wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
 
         // get the next sibling of this item
     wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;


@@ -341,7 +333,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);

 
         // sort the children of this item using the specified callback function
         // (it should return -1, 0 or +1 as usual), if it's not specified
 
         // sort the children of this item using the specified callback function
         // (it should return -1, 0 or +1 as usual), if it's not specified


@@ -355,7 +347,7 @@ public:
     // ----------
 
     // these methods are deprecated and will be removed in future versions of
     // ----------
 
     // these methods are deprecated and will be removed in future versions of

-    // wxWindows, they're here for compatibility only, don't use them in new
+    // 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)
 
     // code (the comments indicate why these methods are now useless and how to
     // replace them)
 


@@ -381,6 +373,7 @@ public:
   void SendSelChanging(const wxTreeItemId& item);
   void SendSelChanged(const wxTreeItemId& item);
 protected:
   void SendSelChanging(const wxTreeItemId& item);
   void SendSelChanged(const wxTreeItemId& item);
 protected:

+  wxTreeItemId m_editItem;

   GtkTree *m_tree;
   GtkTreeItem *m_anchor;
   wxTextCtrl*  m_textCtrl;
   GtkTree *m_tree;
   GtkTreeItem *m_anchor;
   wxTextCtrl*  m_textCtrl;


@@ -389,6 +382,7 @@ protected:
 
   long m_curitemId;
 
 
   long m_curitemId;
 

+  void SendMessage(wxEventType command, const wxTreeItemId& item);

 //  GtkTreeItem *findGtkTreeItem(wxTreeCtrlId &id) const;
 
     // the common part of all ctors
 //  GtkTreeItem *findGtkTreeItem(wxTreeCtrlId &id) const;
 
     // the common part of all ctors


@@ -403,85 +397,5 @@ protected:
   DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 };
 
   DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 };
 

-// ----------------------------------------------------------------------------
-// wxTreeEvent is a special class for all events associated with tree controls
-//
-// NB: note that not all accessors make sense for all events, see the event
-//     descriptions below
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTreeEvent : public wxCommandEvent
-{
-friend wxTreeCtrl;
-public:
-    wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
-
-    // accessors
-        // get the item on which the operation was performed or the newly
-        // selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
-    wxTreeItemId GetItem() const { return m_item; }
-
-        // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
-        // selected item
-    wxTreeItemId GetOldItem() const { return m_itemOld; }
-
-        // the point where the mouse was when the drag operation started (for
-        // wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
-    wxPoint GetPoint() const { return m_pointDrag; }
-
-        // keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
-    int GetCode() const { return m_code; }
-
-    // set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
-        // call this to forbid the change in item status
-    void Veto() { m_code = TRUE; }
-
-private:
-    // @@ we could save some space by using union here
-    int           m_code;
-    wxTreeItemId  m_item,
-                  m_itemOld;
-    wxPoint       m_pointDrag;
-
-    DECLARE_DYNAMIC_CLASS(wxTreeEvent)
-};
-
-typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
-
-// ----------------------------------------------------------------------------
-// macros for handling tree control events
-// ----------------------------------------------------------------------------
-
-// GetItem() returns the item being dragged, GetPoint() the mouse coords
-#define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-
-// GetItem() returns the itme whose label is being edited
-#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-
-// provide/update information about GetItem() item
-#define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-
-// GetItem() is the item being expanded/collapsed, the "ING" versions can use 
-#define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-#define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
-
-// GetOldItem() is the item which had the selection previously, GetItem() is
-// the item which acquires selection
-#define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
-#define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
-
-// GetCode() returns the key code
-// NB: this is the only message for which GetItem() is invalid (you may get the
-//     item from GetSelection())
-#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
-
-// GetItem() returns the item being deleted, the associated data (if any) will
-// be deleted just after the return of this event handler (if any)
-#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
-

 #endif
     // _WX_TREECTRL_H_
 #endif
     // _WX_TREECTRL_H_