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

/////////////////////////////////////////////////////////////////////////////
// Name:        treectrl.h
// Purpose:     wxTreeCtrl class
// Author:      Denis Pershin
// Modified by:
// Created:     08/08/98
// RCS-ID:      $Id$
// Copyright:   (c) Denis Pershin
// Licence:   	wxWindows license
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_TREECTRL_H_
#define _WX_TREECTRL_H_

#ifdef __GNUG__
#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>

// WXDLLEXPORT_DATA(extern const char*) wxTreeNameStr;

#define wxTREE_MASK_HANDLE          0x0001
#define wxTREE_MASK_STATE           0x0002
#define wxTREE_MASK_TEXT            0x0004
#define wxTREE_MASK_IMAGE           0x0008
#define wxTREE_MASK_SELECTED_IMAGE  0x0010
#define wxTREE_MASK_CHILDREN        0x0020
#define wxTREE_MASK_DATA            0x0040

#define wxTREE_STATE_BOLD           0x0001
#define wxTREE_STATE_DROPHILITED    0x0002
#define wxTREE_STATE_EXPANDED       0x0004
#define wxTREE_STATE_EXPANDEDONCE   0x0008
#define wxTREE_STATE_FOCUSED        0x0010
#define wxTREE_STATE_SELECTED       0x0020
#define wxTREE_STATE_CUT            0x0040

#define wxTREE_HITTEST_ABOVE            0x0001  // Above the client area.
#define wxTREE_HITTEST_BELOW            0x0002  // Below the client area.
#define wxTREE_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
#define wxTREE_HITTEST_ONITEMBUTTON     0x0010  // On the button associated with an item.
#define wxTREE_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
#define wxTREE_HITTEST_ONITEMINDENT     0x0040  // In the indentation associated with an item.
#define wxTREE_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
#define wxTREE_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
#define wxTREE_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
#define wxTREE_HITTEST_TOLEFT           0x0400  // To the right of the client area.
#define wxTREE_HITTEST_TORIGHT          0x0800  // To the left of the client area.

#define wxTREE_HITTEST_ONITEM (wxTREE_HITTEST_ONITEMICON | wxTREE_HITTEST_ONITEMLABEL | wxTREE_HITTEST_ONITEMSTATEICON)

// Flags for GetNextItem
enum {
    wxTREE_NEXT_CARET,                 // Retrieves the currently selected item.
    wxTREE_NEXT_CHILD,                 // Retrieves the first child item. The hItem parameter must be NULL.
    wxTREE_NEXT_DROPHILITE,            // Retrieves the item that is the target of a drag-and-drop operation.
    wxTREE_NEXT_FIRSTVISIBLE,          // Retrieves the first visible item.
    wxTREE_NEXT_NEXT,                 // Retrieves the next sibling item.
    wxTREE_NEXT_NEXTVISIBLE,           // Retrieves the next visible item that follows the specified item.
    wxTREE_NEXT_PARENT,                // Retrieves the parent of the specified item.
    wxTREE_NEXT_PREVIOUS,              // Retrieves the previous sibling item.
    wxTREE_NEXT_PREVIOUSVISIBLE,       // Retrieves the first visible item that precedes the specified item.
    wxTREE_NEXT_ROOT                   // Retrieves the first child item of the root item of which the specified item is a part.
};

// Flags for ExpandItem
enum {
    wxTREE_EXPAND_EXPAND,
    wxTREE_EXPAND_COLLAPSE,
    wxTREE_EXPAND_COLLAPSE_RESET,
    wxTREE_EXPAND_TOGGLE
};

// Flags for InsertItem
#define wxTREE_INSERT_FIRST 0xFFFF0001
#define wxTREE_INSERT_LAST  0xFFFF0002
#define wxTREE_INSERT_SORT  0xFFFF0003

class WXDLLEXPORT wxTreeItem: public wxObject
{
 DECLARE_DYNAMIC_CLASS(wxTreeItem)
public:
    long            m_mask;
    long            m_itemId;
    long            m_state;
    long            m_stateMask;
    wxString        m_text;
    int             m_image;
    int             m_selectedImage;
    int             m_children;
    long            m_data;

    wxTreeItem();

// Accessors
    inline long GetMask() const { return m_mask; }
    inline long GetItemId() const { return m_itemId; }
    inline long GetState() const { return m_state; }
    inline long GetStateMask() const { return m_stateMask; }
    inline wxString GetText() const { return m_text; }
    inline int GetImage() const { return m_image; }
    inline int GetSelectedImage() const { return m_selectedImage; }
    inline int GetChildren() const { return m_children; }
    inline long GetData() const { return m_data; }

    inline void SetMask(long mask) { m_mask = mask; }
    inline void SetItemId(long id) { m_itemId = m_itemId = id; }
    inline void SetState(long state) { m_state = state; }
    inline void SetStateMask(long stateMask) { m_stateMask = stateMask; }
    inline void GetText(const wxString& text) { m_text = text; }
    inline void SetImage(int image) { m_image = image; }
    inline void GetSelectedImage(int selImage) { m_selectedImage = selImage; }
    inline void SetChildren(int children) { m_children = children; }
    inline void SetData(long data) { m_data = data; }
};

class WXDLLEXPORT wxTreeCtrl: public wxControl {
public:
 /*
  * Public interface
  */
    
  // creation
  // --------
  wxTreeCtrl();
    
  inline wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
      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);
  }
  ~wxTreeCtrl();
  
  bool Create(wxWindow *parent, wxWindowID id = -1,
              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");
    
  // accessors
  // ---------
    //
  int GetCount() const;

    // indent
  int GetIndent() const;
  void SetIndent(int indent);
    // image list
  wxImageList *GetImageList(int which = wxIMAGE_LIST_NORMAL) const;
  void SetImageList(wxImageList *imageList, int which = wxIMAGE_LIST_NORMAL);

    // navigation inside the tree
  long GetNextItem(long item, int code) const;
  bool ItemHasChildren(long item) const;
  long GetChild(long item) const;
  long GetParent(long item) const;
  long GetFirstVisibleItem() const;
  long GetNextVisibleItem(long item) const;
  long GetSelection() const;
  long GetRootItem() const;

    // generic function for (g|s)etting item attributes
  bool GetItem(wxTreeItem& info) const;
  bool SetItem(wxTreeItem& info);
    // item state
  int  GetItemState(long item, long stateMask) const;
  bool SetItemState(long item, long state, long stateMask);
    // item image
  bool SetItemImage(long item, int image, int selImage);
    // item text
  wxString GetItemText(long item) const;
  void SetItemText(long item, const wxString& str);
    // custom data associated with the item
  long GetItemData(long item) const;
  bool SetItemData(long item, long data);
    // convenience function
  bool IsItemExpanded(long item) { 
    return (GetItemState(item, wxTREE_STATE_EXPANDED) & 
                         wxTREE_STATE_EXPANDED) != 0;
  }

    // bounding rect
  bool GetItemRect(long item, wxRectangle& rect, bool textOnly = FALSE) const;
    //
  wxTextCtrl* GetEditControl() const;
    
    // operations
    // ----------
    // adding/deleting items
  bool DeleteItem(long item);
  long InsertItem(long parent, wxTreeItem& info,
                  long insertAfter = wxTREE_INSERT_LAST);
  // If image > -1 and selImage == -1, the same image is used for
  // both selected and unselected items.
  long InsertItem(long parent, const wxString& label,
                  int image = -1, int selImage = -1, 
                  long insertAfter = wxTREE_INSERT_LAST);

  // changing item state
  bool ExpandItem(long item)   { return ExpandItem(item, wxTREE_EXPAND_EXPAND);   }
  bool CollapseItem(long item) { return ExpandItem(item, wxTREE_EXPAND_COLLAPSE); }
  bool ToggleItem(long item)   { return ExpandItem(item, wxTREE_EXPAND_TOGGLE);   }
  // common interface for {Expand|Collapse|Toggle}Item
  bool ExpandItem(long item, int action);
    
  // 
  bool SelectItem(long item);
  bool ScrollTo(long item);
  bool DeleteAllItems();
  bool DeleteChildren(long item);

  // Edit the label (tree must have the focus)
  wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));

  // End label editing, optionally cancelling the edit
  bool EndEditLabel(bool cancel);

  long HitTest(const wxPoint& point, int& flags);
  //  wxImageList *CreateDragImage(long item);
  bool SortChildren(long item);
  bool EnsureVisible(long item);

  void SendExpanding(long item);
  void SendExpanded(long item);
  void SendCollapsing(long item);
  void SendCollapsed(long item);
  void SendSelChanging(long item);
  void SendSelChanged(long item);
protected:
  GtkTree *m_tree;
  GtkTreeItem *m_anchor;
  wxTextCtrl*  m_textCtrl;
  wxImageList* m_imageListNormal;
  wxImageList* m_imageListState;

  long m_curitemId;

  GtkTreeItem *findGtkTreeItem(long item) const;

  DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
};

/*
 wxEVT_COMMAND_TREE_BEGIN_DRAG,
 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
 wxEVT_COMMAND_TREE_DELETE_ITEM,
 wxEVT_COMMAND_TREE_GET_INFO,
 wxEVT_COMMAND_TREE_SET_INFO,
 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
 wxEVT_COMMAND_TREE_SEL_CHANGED,
 wxEVT_COMMAND_TREE_SEL_CHANGING,
 wxEVT_COMMAND_TREE_KEY_DOWN
*/

class WXDLLEXPORT wxTreeEvent: public wxCommandEvent
{
  DECLARE_DYNAMIC_CLASS(wxTreeEvent)

 public:
  wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);

  int           m_code;
  wxTreeItem    m_item;
  long          m_oldItem;
  wxPoint       m_pointDrag;

  inline long GetOldItem() const { return m_oldItem; }
  inline wxTreeItem& GetItem() const { return (wxTreeItem&) m_item; }
  inline wxPoint GetPoint() const { return m_pointDrag; }
  inline int GetCode() const { return m_code; }
};

typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);

#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 },
#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 },
#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
#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 },
#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 },
#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 },
#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },

#endif
    // _WX_TREECTRL_H_
Commit	Line	Data
4540e33b DP	1	/////////////////////////////////////////////////////////////////////////////
4540e33b DP	2	// Name: treectrl.h
1c3d4180	3	// Purpose: wxTreeCtrl class
4540e33b	4	// Author: Denis Pershin
1c3d4180	5	// Modified by:
4540e33b	6	// Created: 08/08/98
1c3d4180 DP	7	// RCS-ID: $Id$
	8	// Copyright: (c) Denis Pershin
	9	// Licence: wxWindows license
4540e33b	10	/////////////////////////////////////////////////////////////////////////////
f4e325b3	11
1c3d4180 DP	12	#ifndef _WX_TREECTRL_H_
1c3d4180 DP	13	#define _WX_TREECTRL_H_
f4e325b3 DP	14
	15	#ifdef __GNUG__
	16	#pragma interface "treectrl.h"
	17	#endif
	18
1c3d4180	19	#include "wx/textctrl.h"
f4e325b3 DP	20	#include "wx/control.h"
	21	#include "wx/event.h"
	22	#include "wx/imaglist.h"
f4e325b3 DP	23
	24	#include <gtk/gtk.h>
	25
1c3d4180	26	// WXDLLEXPORT_DATA(extern const char*) wxTreeNameStr;
f4e325b3 DP	27
	28	#define wxTREE_MASK_HANDLE 0x0001
	29	#define wxTREE_MASK_STATE 0x0002
	30	#define wxTREE_MASK_TEXT 0x0004
	31	#define wxTREE_MASK_IMAGE 0x0008
	32	#define wxTREE_MASK_SELECTED_IMAGE 0x0010
	33	#define wxTREE_MASK_CHILDREN 0x0020
	34	#define wxTREE_MASK_DATA 0x0040
	35
	36	#define wxTREE_STATE_BOLD 0x0001
	37	#define wxTREE_STATE_DROPHILITED 0x0002
	38	#define wxTREE_STATE_EXPANDED 0x0004
	39	#define wxTREE_STATE_EXPANDEDONCE 0x0008
	40	#define wxTREE_STATE_FOCUSED 0x0010
	41	#define wxTREE_STATE_SELECTED 0x0020
	42	#define wxTREE_STATE_CUT 0x0040
	43
	44	#define wxTREE_HITTEST_ABOVE 0x0001 // Above the client area.
	45	#define wxTREE_HITTEST_BELOW 0x0002 // Below the client area.
	46	#define wxTREE_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
	47	#define wxTREE_HITTEST_ONITEMBUTTON 0x0010 // On the button associated with an item.
	48	#define wxTREE_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
	49	#define wxTREE_HITTEST_ONITEMINDENT 0x0040 // In the indentation associated with an item.
	50	#define wxTREE_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
	51	#define wxTREE_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
	52	#define wxTREE_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
	53	#define wxTREE_HITTEST_TOLEFT 0x0400 // To the right of the client area.
	54	#define wxTREE_HITTEST_TORIGHT 0x0800 // To the left of the client area.
	55
	56	#define wxTREE_HITTEST_ONITEM (wxTREE_HITTEST_ONITEMICON \| wxTREE_HITTEST_ONITEMLABEL \| wxTREE_HITTEST_ONITEMSTATEICON)
	57
	58	// Flags for GetNextItem
	59	enum {
	60	wxTREE_NEXT_CARET, // Retrieves the currently selected item.
	61	wxTREE_NEXT_CHILD, // Retrieves the first child item. The hItem parameter must be NULL.
	62	wxTREE_NEXT_DROPHILITE, // Retrieves the item that is the target of a drag-and-drop operation.
	63	wxTREE_NEXT_FIRSTVISIBLE, // Retrieves the first visible item.
1c3d4180	64	wxTREE_NEXT_NEXT, // Retrieves the next sibling item.
f4e325b3 DP	65	wxTREE_NEXT_NEXTVISIBLE, // Retrieves the next visible item that follows the specified item.
	66	wxTREE_NEXT_PARENT, // Retrieves the parent of the specified item.
	67	wxTREE_NEXT_PREVIOUS, // Retrieves the previous sibling item.
	68	wxTREE_NEXT_PREVIOUSVISIBLE, // Retrieves the first visible item that precedes the specified item.
	69	wxTREE_NEXT_ROOT // Retrieves the first child item of the root item of which the specified item is a part.
	70	};
	71
	72	// Flags for ExpandItem
	73	enum {
	74	wxTREE_EXPAND_EXPAND,
	75	wxTREE_EXPAND_COLLAPSE,
	76	wxTREE_EXPAND_COLLAPSE_RESET,
	77	wxTREE_EXPAND_TOGGLE
	78	};
	79
	80	// Flags for InsertItem
1c3d4180 DP	81	#define wxTREE_INSERT_FIRST 0xFFFF0001
	82	#define wxTREE_INSERT_LAST 0xFFFF0002
	83	#define wxTREE_INSERT_SORT 0xFFFF0003
f4e325b3 DP	84
	85	class WXDLLEXPORT wxTreeItem: public wxObject
	86	{
1c3d4180	87	DECLARE_DYNAMIC_CLASS(wxTreeItem)
f4e325b3	88	public:
1c3d4180 DP	89	long m_mask;
	90	long m_itemId;
	91	long m_state;
	92	long m_stateMask;
	93	wxString m_text;
	94	int m_image;
	95	int m_selectedImage;
	96	int m_children;
	97	long m_data;
	98
	99	wxTreeItem();
	100
	101	// Accessors
	102	inline long GetMask() const { return m_mask; }
	103	inline long GetItemId() const { return m_itemId; }
	104	inline long GetState() const { return m_state; }
	105	inline long GetStateMask() const { return m_stateMask; }
	106	inline wxString GetText() const { return m_text; }
	107	inline int GetImage() const { return m_image; }
	108	inline int GetSelectedImage() const { return m_selectedImage; }
	109	inline int GetChildren() const { return m_children; }
	110	inline long GetData() const { return m_data; }
	111
	112	inline void SetMask(long mask) { m_mask = mask; }
	113	inline void SetItemId(long id) { m_itemId = m_itemId = id; }
	114	inline void SetState(long state) { m_state = state; }
	115	inline void SetStateMask(long stateMask) { m_stateMask = stateMask; }
	116	inline void GetText(const wxString& text) { m_text = text; }
	117	inline void SetImage(int image) { m_image = image; }
	118	inline void GetSelectedImage(int selImage) { m_selectedImage = selImage; }
	119	inline void SetChildren(int children) { m_children = children; }
	120	inline void SetData(long data) { m_data = data; }
f4e325b3 DP	121	};
f4e325b3 DP	122
1c3d4180	123	class WXDLLEXPORT wxTreeCtrl: public wxControl {
f4e325b3	124	public:
1c3d4180 DP	125	/*
	126	* Public interface
	127	*/
	128
	129	// creation
	130	// --------
f4e325b3	131	wxTreeCtrl();
1c3d4180 DP	132
1c3d4180 DP	133	inline wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
f4e325b3 DP	134	const wxPoint& pos = wxDefaultPosition,
f4e325b3 DP	135	const wxSize& size = wxDefaultSize,
1c3d4180 DP	136	long style = wxTR_HAS_BUTTONS\|wxTR_LINES_AT_ROOT,
	137	const wxValidator& validator = wxDefaultValidator,
	138	const wxString& name = "wxTreeCtrl") {
	139	Create(parent, id, pos, size, style, validator, name);
	140	}
f4e325b3	141	~wxTreeCtrl();
1c3d4180 DP	142
	143	bool Create(wxWindow *parent, wxWindowID id = -1,
	144	const wxPoint& pos = wxDefaultPosition,
	145	const wxSize& size = wxDefaultSize,
	146	long style = wxTR_HAS_BUTTONS\|wxTR_LINES_AT_ROOT,
	147	const wxValidator& validator = wxDefaultValidator,
	148	const wxString& name = "wxTreeCtrl");
	149
	150	// accessors
	151	// ---------
	152	//
f4e325b3 DP	153	int GetCount() const;
f4e325b3 DP	154
1c3d4180 DP	155	// indent
	156	int GetIndent() const;
	157	void SetIndent(int indent);
	158	// image list
	159	wxImageList *GetImageList(int which = wxIMAGE_LIST_NORMAL) const;
	160	void SetImageList(wxImageList *imageList, int which = wxIMAGE_LIST_NORMAL);
f4e325b3	161
1c3d4180 DP	162	// navigation inside the tree
	163	long GetNextItem(long item, int code) const;
	164	bool ItemHasChildren(long item) const;
	165	long GetChild(long item) const;
	166	long GetParent(long item) const;
	167	long GetFirstVisibleItem() const;
	168	long GetNextVisibleItem(long item) const;
	169	long GetSelection() const;
	170	long GetRootItem() const;
f4e325b3	171
1c3d4180 DP	172	// generic function for (g\|s)etting item attributes
	173	bool GetItem(wxTreeItem& info) const;
	174	bool SetItem(wxTreeItem& info);
	175	// item state
	176	int GetItemState(long item, long stateMask) const;
	177	bool SetItemState(long item, long state, long stateMask);
	178	// item image
	179	bool SetItemImage(long item, int image, int selImage);
	180	// item text
	181	wxString GetItemText(long item) const;
	182	void SetItemText(long item, const wxString& str);
	183	// custom data associated with the item
	184	long GetItemData(long item) const;
	185	bool SetItemData(long item, long data);
	186	// convenience function
	187	bool IsItemExpanded(long item) {
	188	return (GetItemState(item, wxTREE_STATE_EXPANDED) &
	189	wxTREE_STATE_EXPANDED) != 0;
	190	}
f4e325b3	191
1c3d4180 DP	192	// bounding rect
	193	bool GetItemRect(long item, wxRectangle& rect, bool textOnly = FALSE) const;
	194	//
	195	wxTextCtrl* GetEditControl() const;
	196
	197	// operations
	198	// ----------
	199	// adding/deleting items
	200	bool DeleteItem(long item);
	201	long InsertItem(long parent, wxTreeItem& info,
	202	long insertAfter = wxTREE_INSERT_LAST);
	203	// If image > -1 and selImage == -1, the same image is used for
	204	// both selected and unselected items.
	205	long InsertItem(long parent, const wxString& label,
	206	int image = -1, int selImage = -1,
	207	long insertAfter = wxTREE_INSERT_LAST);
	208
	209	// changing item state
	210	bool ExpandItem(long item) { return ExpandItem(item, wxTREE_EXPAND_EXPAND); }
f4e325b3 DP	211	bool CollapseItem(long item) { return ExpandItem(item, wxTREE_EXPAND_COLLAPSE); }
f4e325b3 DP	212	bool ToggleItem(long item) { return ExpandItem(item, wxTREE_EXPAND_TOGGLE); }
1c3d4180 DP	213	// common interface for {Expand\|Collapse\|Toggle}Item
	214	bool ExpandItem(long item, int action);
	215
	216	//
	217	bool SelectItem(long item);
	218	bool ScrollTo(long item);
	219	bool DeleteAllItems();
	220	bool DeleteChildren(long item);
f4e325b3	221
1c3d4180 DP	222	// Edit the label (tree must have the focus)
1c3d4180 DP	223	wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
f4e325b3	224
1c3d4180 DP	225	// End label editing, optionally cancelling the edit
1c3d4180 DP	226	bool EndEditLabel(bool cancel);
f4e325b3	227
1c3d4180 DP	228	long HitTest(const wxPoint& point, int& flags);
	229	// wxImageList *CreateDragImage(long item);
	230	bool SortChildren(long item);
	231	bool EnsureVisible(long item);
f4e325b3	232
1c3d4180 DP	233	void SendExpanding(long item);
	234	void SendExpanded(long item);
	235	void SendCollapsing(long item);
	236	void SendCollapsed(long item);
	237	void SendSelChanging(long item);
	238	void SendSelChanged(long item);
	239	protected:
	240	GtkTree *m_tree;
	241	GtkTreeItem *m_anchor;
	242	wxTextCtrl* m_textCtrl;
	243	wxImageList* m_imageListNormal;
	244	wxImageList* m_imageListState;
f4e325b3	245
1c3d4180	246	long m_curitemId;
f4e325b3	247
1c3d4180	248	GtkTreeItem *findGtkTreeItem(long item) const;
f4e325b3	249
f4e325b3 DP	250	DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
	251	};
	252
1c3d4180 DP	253	/*
	254	wxEVT_COMMAND_TREE_BEGIN_DRAG,
	255	wxEVT_COMMAND_TREE_BEGIN_RDRAG,
	256	wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
	257	wxEVT_COMMAND_TREE_END_LABEL_EDIT,
	258	wxEVT_COMMAND_TREE_DELETE_ITEM,
	259	wxEVT_COMMAND_TREE_GET_INFO,
	260	wxEVT_COMMAND_TREE_SET_INFO,
	261	wxEVT_COMMAND_TREE_ITEM_EXPANDED,
	262	wxEVT_COMMAND_TREE_ITEM_EXPANDING,
	263	wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
	264	wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
	265	wxEVT_COMMAND_TREE_SEL_CHANGED,
	266	wxEVT_COMMAND_TREE_SEL_CHANGING,
	267	wxEVT_COMMAND_TREE_KEY_DOWN
	268	*/
f4e325b3 DP	269
	270	class WXDLLEXPORT wxTreeEvent: public wxCommandEvent
	271	{
	272	DECLARE_DYNAMIC_CLASS(wxTreeEvent)
	273
	274	public:
	275	wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
	276
	277	int m_code;
	278	wxTreeItem m_item;
	279	long m_oldItem;
	280	wxPoint m_pointDrag;
	281
	282	inline long GetOldItem() const { return m_oldItem; }
	283	inline wxTreeItem& GetItem() const { return (wxTreeItem&) m_item; }
	284	inline wxPoint GetPoint() const { return m_pointDrag; }
f4e325b3 DP	285	inline int GetCode() const { return m_code; }
	286	};
	287
	288	typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
	289
c67daf87 UR	290	#define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
c67daf87 UR	291	#define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
1c3d4180	292	#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
c67daf87	293	#define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
1c3d4180	294	#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
c67daf87 UR	295	#define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
	296	#define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
	297	#define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
	298	#define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
	299	#define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
1c3d4180 DP	300	#define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
	301	#define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
	302	#define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
	303	#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
f4e325b3 DP	304
f4e325b3 DP	305	#endif
1c3d4180	306	// _WX_TREECTRL_H_