[wxWidgets.git] / include / wx / treebase.h

/////////////////////////////////////////////////////////////////////////////
// Name:        treebase.h
// Purpose:     wxTreeCtrl base classes and types
// Author:      Julian Smart et al
// Modified by:
// Created:     01/02/97
// RCS-ID:      $Id$
// Copyright:   (c) 1997,1998 Robert Roebling
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_TREEBASE_H_
#define _WX_TREEBASE_H_

#ifdef __GNUG__
    #pragma interface "treebase.h"
#endif

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

#if wxUSE_TREECTRL

#include "wx/window.h"  // for wxClientData
#include "wx/event.h"

// ----------------------------------------------------------------------------
// wxTreeItemId identifies an element of the tree. In this implementation, it's
// just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
// data structure in the generic version. It's opaque for the application and
// the only method which can be used by user code is IsOk().
// ----------------------------------------------------------------------------

// Using this typedef removes an ambiguity when calling Remove()
typedef unsigned long wxTreeItemIdValue;

class WXDLLEXPORT wxTreeItemId
{
public:
    // ctors
        // 0 is invalid value for HTREEITEM
    wxTreeItemId() { m_pItem = 0; }

        // this one is used in the generic version
    wxTreeItemId(void *pItem) { m_pItem = (long) pItem; }

        // and this one under MSW
    wxTreeItemId(long lItem) { m_pItem = lItem; }

        // default copy ctor/assignment operator are ok for us

    // accessors
        // is this a valid tree item?
    bool IsOk() const { return m_pItem != 0; }

    // deprecated: only for compatibility
    operator wxTreeItemIdValue() const { return m_pItem; }

    wxTreeItemIdValue m_pItem;
};

// ----------------------------------------------------------------------------
// wxTreeItemData is some (arbitrary) user class associated with some item. The
// main advantage of having this class (compared to old untyped interface) is
// that wxTreeItemData's are destroyed automatically by the tree and, as this
// class has virtual dtor, it means that the memory will be automatically
// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
// the size of this class is critical: in any real application, each tree leaf
// will have wxTreeItemData associated with it and number of leaves may be
// quite big.
//
// Because the objects of this class are deleted by the tree, they should
// always be allocated on the heap!
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxTreeItemData: public wxClientData
{
friend class WXDLLEXPORT wxTreeCtrl;
friend class WXDLLEXPORT wxGenericTreeCtrl;
public:
    // creation/destruction
    // --------------------
        // default ctor
    wxTreeItemData() { }

        // default copy ctor/assignment operator are ok

    // accessor: get the item associated with us
    const wxTreeItemId& GetId() const { return m_pItem; }
    void SetId(const wxTreeItemId& id) { m_pItem = id; }

protected:
    wxTreeItemId m_pItem;
};

WX_DEFINE_EXPORTED_ARRAY(wxTreeItemId, wxArrayTreeItemIds);

// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------

// enum for different images associated with a treectrl item
enum wxTreeItemIcon
{
    wxTreeItemIcon_Normal,              // not selected, not expanded
    wxTreeItemIcon_Selected,            //     selected, not expanded
    wxTreeItemIcon_Expanded,            // not selected,     expanded
    wxTreeItemIcon_SelectedExpanded,    //     selected,     expanded
    wxTreeItemIcon_Max
};

/*
 * wxTreeCtrl flags
 */
// TODO: maybe renumber these?
#define wxTR_NO_BUTTONS              0x0000     // for convenience
#define wxTR_HAS_BUTTONS             0x0001     // generates a +/- button
#define wxTR_TWIST_BUTTONS           0x0002     // generates a twister button
#define wxTR_NO_LINES                0x0004     // don't generate level connectors
#define wxTR_LINES_AT_ROOT           0x0008     // connect top-level nodes
#define wxTR_MAC_BUTTONS             wxTR_TWIST_BUTTONS // backward compatibility
#define wxTR_AQUA_BUTTONS            0x0010     // used internally

#define wxTR_SINGLE                  0x0000     // for convenience
#define wxTR_MULTIPLE                0x0020     // can select multiple items
#define wxTR_EXTENDED                0x0040     // TODO: allow extended selection
#define wxTR_FULL_ROW_HIGHLIGHT      0x2000     // highlight full horizontal space

#define wxTR_EDIT_LABELS             0x0200     // can edit item labels
#define wxTR_ROW_LINES               0x0400     // put border around items
#define wxTR_HIDE_ROOT               0x0800     // don't display root node
#define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080     // what it says

// TODO: different default styles for wxGTK, wxMotif, whatever?
#ifdef __WXMAC__
    #define wxTR_DEFAULT_STYLE (wxTR_TWIST_BUTTONS|wxTR_NO_LINES|wxTR_ROW_LINES)
#else
    #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT)
#endif

// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
// where exactly the specified point is situated:

static const int wxTREE_HITTEST_ABOVE            = 0x0001;
static const int wxTREE_HITTEST_BELOW            = 0x0002;
static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
    // on the button associated with an item.
static const int wxTREE_HITTEST_ONITEMBUTTON     = 0x0008;
    // on the bitmap associated with an item.
static const int wxTREE_HITTEST_ONITEMICON       = 0x0010;
    // on the indent associated with an item.
static const int wxTREE_HITTEST_ONITEMINDENT     = 0x0020;
    // on the label (string) associated with an item.
static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0040;
    // on the right of the label associated with an item.
static const int wxTREE_HITTEST_ONITEMRIGHT      = 0x0080;
    // on the label (string) associated with an item.
static const int wxTREE_HITTEST_ONITEMSTATEICON  = 0x0100;
    // on the left of the wxTreeCtrl.
static const int wxTREE_HITTEST_TOLEFT           = 0x0200;
    // on the right of the wxTreeCtrl.
static const int wxTREE_HITTEST_TORIGHT          = 0x0400;
    // on the upper part (first half) of the item.
static const int wxTREE_HITTEST_ONITEMUPPERPART  = 0x0800;
    // on the lower part (second half) of the item.
static const int wxTREE_HITTEST_ONITEMLOWERPART  = 0x1000;

    // anywhere on the item
static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
                                          wxTREE_HITTEST_ONITEMLABEL;

// tree ctrl default name
WXDLLEXPORT_DATA(extern const wxChar*) wxTreeCtrlNameStr;

// ----------------------------------------------------------------------------
// wxTreeItemAttr: a structure containing the visual attributes of an item
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxTreeItemAttr
{
public:
    // ctors
    wxTreeItemAttr() { }
    wxTreeItemAttr(const wxColour& colText,
                   const wxColour& colBack,
                   const wxFont& font)
        : m_colText(colText), m_colBack(colBack), m_font(font) { }

    // setters
    void SetTextColour(const wxColour& colText) { m_colText = colText; }
    void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
    void SetFont(const wxFont& font) { m_font = font; }

    // accessors
    bool HasTextColour() const { return m_colText.Ok(); }
    bool HasBackgroundColour() const { return m_colBack.Ok(); }
    bool HasFont() const { return m_font.Ok(); }

    const wxColour& GetTextColour() const { return m_colText; }
    const wxColour& GetBackgroundColour() const { return m_colBack; }
    const wxFont& GetFont() const { return m_font; }

private:
    wxColour m_colText,
             m_colBack;
    wxFont   m_font;
};

// ----------------------------------------------------------------------------
// 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 wxNotifyEvent
{
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) or click position
    wxPoint GetPoint() const { return m_pointDrag; }

        // keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
    const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
    int GetCode() const { return m_evtKey.GetKeyCode(); }

        // label (for EVT_TREE_{BEGIN|END}_LABEL_EDIT only)
    const wxString& GetLabel() const { return m_label; }

private:
    // not all of the members are used (or initialized) for all events
    wxKeyEvent    m_evtKey;
    wxTreeItemId  m_item,
                  m_itemOld;
    wxPoint       m_pointDrag;
    wxString      m_label;

    friend class WXDLLEXPORT wxTreeCtrl;
    friend class WXDLLEXPORT wxGenericTreeCtrl;

    DECLARE_DYNAMIC_CLASS(wxTreeEvent);
};

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

// ----------------------------------------------------------------------------
// tree control events and macros for handling them
// ----------------------------------------------------------------------------

BEGIN_DECLARE_EVENT_TYPES()
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616)
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617)
END_DECLARE_EVENT_TYPES()

// GetItem() returns the item being dragged, GetPoint() the mouse coords
//
// if you call event.Allow(), the drag operation will start and a
// EVT_TREE_END_DRAG event will be sent when the drag is over.
#define EVT_TREE_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

// GetItem() is the item on which the drop occured (if any) and GetPoint() the
// current mouse coords
#define EVT_TREE_END_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

// GetItem() returns the itme whose label is being edited, GetLabel() returns
// the current item label for BEGIN and the would be new one for END.
//
// Vetoing BEGIN event means that label editing won't happen at all,
// vetoing END means that the new value is discarded and the old one kept
#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_ITEM_EXPANDING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
#define EVT_TREE_ITEM_COLLAPSING(id, fn) DECLARE_EVENT_TABLE_ENTRY( 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
#define EVT_TREE_SEL_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( 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) DECLARE_EVENT_TABLE_ENTRY( 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) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),

// GetItem() returns the item that was activated (double click, enter, space)
#define EVT_TREE_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

// GetItem() returns the item that was clicked on
#define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
#define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),

#endif // wxUSE_TREECTRL

#endif // _WX_TREEBASE_H_
Commit	Line	Data
484523cf	1	/////////////////////////////////////////////////////////////////////////////
5e0e6ceb	2	// Name: treebase.h
484523cf JS	3	// Purpose: wxTreeCtrl base classes and types
	4	// Author: Julian Smart et al
	5	// Modified by:
	6	// Created: 01/02/97
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 1997,1998 Robert Roebling
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_TREEBASE_H_
	13	#define _WX_TREEBASE_H_
	14
	15	#ifdef __GNUG__
	16	#pragma interface "treebase.h"
	17	#endif
	18
	19	// ----------------------------------------------------------------------------
	20	// headers
	21	// ----------------------------------------------------------------------------
	22
1e6feb95	23	#if wxUSE_TREECTRL
33737618	24
618a5e38	25	#include "wx/window.h" // for wxClientData
484523cf JS	26	#include "wx/event.h"
	27
	28	// ----------------------------------------------------------------------------
	29	// wxTreeItemId identifies an element of the tree. In this implementation, it's
2f3dcbbf VZ	30	// just a trivial wrapper around Win32 HTREEITEM or a pointer to some private
	31	// data structure in the generic version. It's opaque for the application and
	32	// the only method which can be used by user code is IsOk().
484523cf JS	33	// ----------------------------------------------------------------------------
	34
	35	// Using this typedef removes an ambiguity when calling Remove()
	36	typedef unsigned long wxTreeItemIdValue;
	37
	38	class WXDLLEXPORT wxTreeItemId
	39	{
484523cf JS	40	public:
	41	// ctors
	42	// 0 is invalid value for HTREEITEM
	43	wxTreeItemId() { m_pItem = 0; }
	44
2f3dcbbf VZ	45	// this one is used in the generic version
	46	wxTreeItemId(void *pItem) { m_pItem = (long) pItem; }
	47
	48	// and this one under MSW
	49	wxTreeItemId(long lItem) { m_pItem = lItem; }
	50
484523cf JS	51	// default copy ctor/assignment operator are ok for us
	52
	53	// accessors
	54	// is this a valid tree item?
	55	bool IsOk() const { return m_pItem != 0; }
	56
	57	// deprecated: only for compatibility
484523cf JS	58	operator wxTreeItemIdValue() const { return m_pItem; }
484523cf JS	59
484523cf JS	60	wxTreeItemIdValue m_pItem;
	61	};
	62
	63	// ----------------------------------------------------------------------------
	64	// wxTreeItemData is some (arbitrary) user class associated with some item. The
	65	// main advantage of having this class (compared to old untyped interface) is
	66	// that wxTreeItemData's are destroyed automatically by the tree and, as this
	67	// class has virtual dtor, it means that the memory will be automatically
	68	// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
	69	// the size of this class is critical: in any real application, each tree leaf
	70	// will have wxTreeItemData associated with it and number of leaves may be
	71	// quite big.
	72	//
	73	// Because the objects of this class are deleted by the tree, they should
	74	// always be allocated on the heap!
	75	// ----------------------------------------------------------------------------
	76
	77	class WXDLLEXPORT wxTreeItemData: public wxClientData
	78	{
	79	friend class WXDLLEXPORT wxTreeCtrl;
	80	friend class WXDLLEXPORT wxGenericTreeCtrl;
	81	public:
	82	// creation/destruction
	83	// --------------------
	84	// default ctor
	85	wxTreeItemData() { }
	86
	87	// default copy ctor/assignment operator are ok
	88
	89	// accessor: get the item associated with us
	90	const wxTreeItemId& GetId() const { return m_pItem; }
	91	void SetId(const wxTreeItemId& id) { m_pItem = id; }
	92
	93	protected:
	94	wxTreeItemId m_pItem;
	95	};
	96
	97	WX_DEFINE_EXPORTED_ARRAY(wxTreeItemId, wxArrayTreeItemIds);
	98
	99	// ----------------------------------------------------------------------------
	100	// constants
	101	// ----------------------------------------------------------------------------
	102
	103	// enum for different images associated with a treectrl item
	104	enum wxTreeItemIcon
	105	{
	106	wxTreeItemIcon_Normal, // not selected, not expanded
	107	wxTreeItemIcon_Selected, // selected, not expanded
	108	wxTreeItemIcon_Expanded, // not selected, expanded
	109	wxTreeItemIcon_SelectedExpanded, // selected, expanded
	110	wxTreeItemIcon_Max
	111	};
	112
618a5e38 RR	113	/*
	114	* wxTreeCtrl flags
	115	*/
	116	// TODO: maybe renumber these?
c6f4913a VS	117	#define wxTR_NO_BUTTONS 0x0000 // for convenience
	118	#define wxTR_HAS_BUTTONS 0x0001 // generates a +/- button
	119	#define wxTR_TWIST_BUTTONS 0x0002 // generates a twister button
	120	#define wxTR_NO_LINES 0x0004 // don't generate level connectors
	121	#define wxTR_LINES_AT_ROOT 0x0008 // connect top-level nodes
	122	#define wxTR_MAC_BUTTONS wxTR_TWIST_BUTTONS // backward compatibility
	123	#define wxTR_AQUA_BUTTONS 0x0010 // used internally
	124
	125	#define wxTR_SINGLE 0x0000 // for convenience
	126	#define wxTR_MULTIPLE 0x0020 // can select multiple items
	127	#define wxTR_EXTENDED 0x0040 // TODO: allow extended selection
	128	#define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horizontal space
	129
	130	#define wxTR_EDIT_LABELS 0x0200 // can edit item labels
	131	#define wxTR_ROW_LINES 0x0400 // put border around items
	132	#define wxTR_HIDE_ROOT 0x0800 // don't display root node
	133	#define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says
618a5e38 RR	134
	135	// TODO: different default styles for wxGTK, wxMotif, whatever?
	136	#ifdef __WXMAC__
	137	#define wxTR_DEFAULT_STYLE (wxTR_TWIST_BUTTONS\|wxTR_NO_LINES\|wxTR_ROW_LINES)
	138	#else
	139	#define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS\|wxTR_LINES_AT_ROOT)
	140	#endif
484523cf JS	141
	142	// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
	143	// where exactly the specified point is situated:
	144
	145	static const int wxTREE_HITTEST_ABOVE = 0x0001;
	146	static const int wxTREE_HITTEST_BELOW = 0x0002;
	147	static const int wxTREE_HITTEST_NOWHERE = 0x0004;
	148	// on the button associated with an item.
	149	static const int wxTREE_HITTEST_ONITEMBUTTON = 0x0008;
	150	// on the bitmap associated with an item.
	151	static const int wxTREE_HITTEST_ONITEMICON = 0x0010;
	152	// on the indent associated with an item.
	153	static const int wxTREE_HITTEST_ONITEMINDENT = 0x0020;
	154	// on the label (string) associated with an item.
	155	static const int wxTREE_HITTEST_ONITEMLABEL = 0x0040;
	156	// on the right of the label associated with an item.
	157	static const int wxTREE_HITTEST_ONITEMRIGHT = 0x0080;
	158	// on the label (string) associated with an item.
	159	static const int wxTREE_HITTEST_ONITEMSTATEICON = 0x0100;
	160	// on the left of the wxTreeCtrl.
	161	static const int wxTREE_HITTEST_TOLEFT = 0x0200;
	162	// on the right of the wxTreeCtrl.
	163	static const int wxTREE_HITTEST_TORIGHT = 0x0400;
	164	// on the upper part (first half) of the item.
	165	static const int wxTREE_HITTEST_ONITEMUPPERPART = 0x0800;
	166	// on the lower part (second half) of the item.
	167	static const int wxTREE_HITTEST_ONITEMLOWERPART = 0x1000;
	168
	169	// anywhere on the item
	170	static const int wxTREE_HITTEST_ONITEM = wxTREE_HITTEST_ONITEMICON \|
	171	wxTREE_HITTEST_ONITEMLABEL;
	172
	173	// tree ctrl default name
161f4f73	174	WXDLLEXPORT_DATA(extern const wxChar*) wxTreeCtrlNameStr;
484523cf JS	175
	176	// ----------------------------------------------------------------------------
	177	// wxTreeItemAttr: a structure containing the visual attributes of an item
	178	// ----------------------------------------------------------------------------
	179
	180	class WXDLLEXPORT wxTreeItemAttr
	181	{
	182	public:
	183	// ctors
	184	wxTreeItemAttr() { }
	185	wxTreeItemAttr(const wxColour& colText,
	186	const wxColour& colBack,
	187	const wxFont& font)
	188	: m_colText(colText), m_colBack(colBack), m_font(font) { }
	189
	190	// setters
	191	void SetTextColour(const wxColour& colText) { m_colText = colText; }
	192	void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
	193	void SetFont(const wxFont& font) { m_font = font; }
	194
	195	// accessors
	196	bool HasTextColour() const { return m_colText.Ok(); }
	197	bool HasBackgroundColour() const { return m_colBack.Ok(); }
	198	bool HasFont() const { return m_font.Ok(); }
	199
	200	const wxColour& GetTextColour() const { return m_colText; }
	201	const wxColour& GetBackgroundColour() const { return m_colBack; }
	202	const wxFont& GetFont() const { return m_font; }
	203
	204	private:
	205	wxColour m_colText,
	206	m_colBack;
	207	wxFont m_font;
	208	};
	209
	210	// ----------------------------------------------------------------------------
	211	// wxTreeEvent is a special class for all events associated with tree controls
	212	//
	213	// NB: note that not all accessors make sense for all events, see the event
	214	// descriptions below
	215	// ----------------------------------------------------------------------------
	216
	217	class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
	218	{
484523cf JS	219	public:
	220	wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
	221
	222	// accessors
	223	// get the item on which the operation was performed or the newly
	224	// selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
	225	wxTreeItemId GetItem() const { return m_item; }
	226
	227	// for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
	228	// selected item
	229	wxTreeItemId GetOldItem() const { return m_itemOld; }
	230
	231	// the point where the mouse was when the drag operation started (for
33737618	232	// wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only) or click position
484523cf JS	233	wxPoint GetPoint() const { return m_pointDrag; }
484523cf JS	234
b09bda68 VZ	235	// keyboard data (for wxEVT_COMMAND_TREE_KEY_DOWN only)
	236	const wxKeyEvent& GetKeyEvent() const { return m_evtKey; }
	237	int GetCode() const { return m_evtKey.GetKeyCode(); }
484523cf JS	238
	239	// label (for EVT_TREE_{BEGIN\|END}_LABEL_EDIT only)
	240	const wxString& GetLabel() const { return m_label; }
	241
	242	private:
b09bda68 VZ	243	// not all of the members are used (or initialized) for all events
b09bda68 VZ	244	wxKeyEvent m_evtKey;
484523cf JS	245	wxTreeItemId m_item,
	246	m_itemOld;
	247	wxPoint m_pointDrag;
	248	wxString m_label;
b09bda68 VZ	249
	250	friend class WXDLLEXPORT wxTreeCtrl;
	251	friend class WXDLLEXPORT wxGenericTreeCtrl;
	252
	253	DECLARE_DYNAMIC_CLASS(wxTreeEvent);
484523cf JS	254	};
	255
	256	typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
	257
	258	// ----------------------------------------------------------------------------
2e4df4bf	259	// tree control events and macros for handling them
484523cf JS	260	// ----------------------------------------------------------------------------
484523cf JS	261
2e4df4bf VZ	262	BEGIN_DECLARE_EVENT_TYPES()
	263	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600)
	264	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601)
	265	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602)
	266	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603)
	267	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604)
	268	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605)
	269	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606)
	270	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607)
	271	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608)
	272	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609)
	273	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610)
	274	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611)
	275	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612)
	276	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613)
	277	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614)
	278	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615)
	279	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616)
	280	DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617)
	281	END_DECLARE_EVENT_TYPES()
	282
484523cf JS	283	// GetItem() returns the item being dragged, GetPoint() the mouse coords
	284	//
	285	// if you call event.Allow(), the drag operation will start and a
	286	// EVT_TREE_END_DRAG event will be sent when the drag is over.
2e4df4bf VZ	287	#define EVT_TREE_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
2e4df4bf VZ	288	#define EVT_TREE_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
484523cf JS	289
	290	// GetItem() is the item on which the drop occured (if any) and GetPoint() the
	291	// current mouse coords
2e4df4bf	292	#define EVT_TREE_END_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
484523cf JS	293
	294	// GetItem() returns the itme whose label is being edited, GetLabel() returns
	295	// the current item label for BEGIN and the would be new one for END.
	296	//
	297	// Vetoing BEGIN event means that label editing won't happen at all,
	298	// vetoing END means that the new value is discarded and the old one kept
2e4df4bf VZ	299	#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
2e4df4bf VZ	300	#define EVT_TREE_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
484523cf JS	301
484523cf JS	302	// provide/update information about GetItem() item
2e4df4bf VZ	303	#define EVT_TREE_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
2e4df4bf VZ	304	#define EVT_TREE_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
484523cf JS	305
484523cf JS	306	// GetItem() is the item being expanded/collapsed, the "ING" versions can use
2e4df4bf VZ	307	#define EVT_TREE_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
	308	#define EVT_TREE_ITEM_EXPANDING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
	309	#define EVT_TREE_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
	310	#define EVT_TREE_ITEM_COLLAPSING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
484523cf JS	311
	312	// GetOldItem() is the item which had the selection previously, GetItem() is
	313	// the item which acquires selection
2e4df4bf VZ	314	#define EVT_TREE_SEL_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
2e4df4bf VZ	315	#define EVT_TREE_SEL_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
484523cf JS	316
	317	// GetCode() returns the key code
	318	// NB: this is the only message for which GetItem() is invalid (you may get the
	319	// item from GetSelection())
2e4df4bf	320	#define EVT_TREE_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
484523cf JS	321
	322	// GetItem() returns the item being deleted, the associated data (if any) will
	323	// be deleted just after the return of this event handler (if any)
2e4df4bf	324	#define EVT_TREE_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL ),
484523cf JS	325
484523cf JS	326	// GetItem() returns the item that was activated (double click, enter, space)
2e4df4bf	327	#define EVT_TREE_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
484523cf JS	328
484523cf JS	329	// GetItem() returns the item that was clicked on
2e4df4bf VZ	330	#define EVT_TREE_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
2e4df4bf VZ	331	#define EVT_TREE_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL ),
484523cf	332
1e6feb95	333	#endif // wxUSE_TREECTRL
33737618	334
618a5e38	335	#endif // _WX_TREEBASE_H_
484523cf	336