git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2334 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
		
			
				
	
	
		
			495 lines
		
	
	
		
			21 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			495 lines
		
	
	
		
			21 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
/////////////////////////////////////////////////////////////////////////////
 | 
						|
// Name:        treectrl.h
 | 
						|
// Purpose:     wxTreeCtrl class
 | 
						|
// Author:      Robert Roebling
 | 
						|
// Modified by:
 | 
						|
// Created:     01/02/97
 | 
						|
// RCS-ID:      $Id$
 | 
						|
// Copyright:   (c) 1997,1998 Robert Roebling
 | 
						|
// Licence:     wxWindows license
 | 
						|
/////////////////////////////////////////////////////////////////////////////
 | 
						|
 | 
						|
#ifndef _GENERIC_TREECTRL_H_
 | 
						|
#define _GENERIC_TREECTRL_H_
 | 
						|
 | 
						|
#ifdef __GNUG__
 | 
						|
    #pragma interface "treectrl.h"
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef __WXMSW__
 | 
						|
WXDLLEXPORT_DATA(extern const char*) wxTreeCtrlNameStr;
 | 
						|
#else
 | 
						|
#define wxTreeCtrlNameStr "wxTreeCtrl"
 | 
						|
#endif
 | 
						|
 | 
						|
#include "wx/defs.h"
 | 
						|
#include "wx/string.h"
 | 
						|
#include "wx/object.h"
 | 
						|
#include "wx/event.h"
 | 
						|
#include "wx/scrolwin.h"
 | 
						|
#include "wx/textctrl.h"
 | 
						|
#include "wx/pen.h"
 | 
						|
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
// constants
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
 | 
						|
// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
 | 
						|
// where exactly the specified point is situated:
 | 
						|
static const int wxTREE_HITTEST_NOWHERE          = 0x0004;
 | 
						|
    // on the bitmap associated with an item.
 | 
						|
static const int wxTREE_HITTEST_ONITEMICON       = 0x0020;
 | 
						|
    // on the label (string) associated with an item.
 | 
						|
static const int wxTREE_HITTEST_ONITEMLABEL      = 0x0080;
 | 
						|
    // anywhere on the item
 | 
						|
static const int wxTREE_HITTEST_ONITEM  = wxTREE_HITTEST_ONITEMICON |
 | 
						|
                                          wxTREE_HITTEST_ONITEMLABEL;
 | 
						|
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
// forward declaration
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
 | 
						|
class wxImageList;
 | 
						|
class wxGenericTreeItem;
 | 
						|
 | 
						|
class wxTreeItemData;
 | 
						|
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
// wxTreeItemId - unique identifier of a tree element
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
 | 
						|
class WXDLLEXPORT wxTreeItemId
 | 
						|
{
 | 
						|
friend class wxTreeCtrl;
 | 
						|
friend class wxTreeEvent;
 | 
						|
public:
 | 
						|
    // ctors
 | 
						|
        // 0 is invalid value for HTREEITEM
 | 
						|
    wxTreeItemId() { m_pItem = 0; }
 | 
						|
 | 
						|
        // 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
 | 
						|
    wxTreeItemId(long itemId) { m_pItem = (wxGenericTreeItem *)itemId; }
 | 
						|
    operator long() const { return (long)m_pItem; }
 | 
						|
 | 
						|
//protected: // not for gcc
 | 
						|
    // for wxTreeCtrl usage only
 | 
						|
    wxTreeItemId(wxGenericTreeItem *pItem) { m_pItem = pItem; }
 | 
						|
 | 
						|
    wxGenericTreeItem *m_pItem;
 | 
						|
};
 | 
						|
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
// wxTreeItemData is some (arbitrary) user class associated with some item.
 | 
						|
//
 | 
						|
// 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 wxTreeCtrl;
 | 
						|
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;
 | 
						|
};
 | 
						|
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
// wxTreeEvent - the event generated by the tree control
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent
 | 
						|
{
 | 
						|
friend class 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; }
 | 
						|
 | 
						|
        // for implementation usage only
 | 
						|
    bool WasVetoed() const { return m_code; }
 | 
						|
 | 
						|
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 },
 | 
						|
 | 
						|
// GetItem() returns the item that was activated (double click, enter, space)
 | 
						|
#define EVT_TREE_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_TREE_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
 | 
						|
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
// wxTreeCtrl - the tree control
 | 
						|
// -----------------------------------------------------------------------------
 | 
						|
 | 
						|
class WXDLLEXPORT wxTreeCtrl : public wxScrolledWindow
 | 
						|
{
 | 
						|
public:
 | 
						|
    // creation
 | 
						|
    // --------
 | 
						|
    wxTreeCtrl() { Init(); }
 | 
						|
 | 
						|
    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 = wxTreeCtrlNameStr)
 | 
						|
    {
 | 
						|
        Create(parent, id, pos, size, style, validator, name);
 | 
						|
    }
 | 
						|
 | 
						|
    virtual ~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 = wxTreeCtrlNameStr);
 | 
						|
 | 
						|
    // accessors
 | 
						|
    // ---------
 | 
						|
 | 
						|
        // get the total number of items in the control
 | 
						|
    size_t GetCount() const;
 | 
						|
 | 
						|
        // indent is the number of pixels the children are indented relative to
 | 
						|
        // the parents position. SetIndent() also redraws the control
 | 
						|
        // immediately.
 | 
						|
    unsigned int GetIndent() const { return m_indent; }
 | 
						|
    void SetIndent(unsigned int indent);
 | 
						|
 | 
						|
    	// spacing is the number of pixels between the start and the Text
 | 
						|
    unsigned int GetSpacing() const { return m_spacing; }
 | 
						|
    void SetSpacing(unsigned int spacing);
 | 
						|
    
 | 
						|
        // image list: these functions allow to associate an image list with
 | 
						|
        // the control and retrieve it. Note that the control does _not_ delete
 | 
						|
        // the associated image list when it's deleted in order to allow image
 | 
						|
        // lists to be shared between different controls.
 | 
						|
        //
 | 
						|
        // The normal image list is for the icons which correspond to the
 | 
						|
        // normal tree item state (whether it is selected or not).
 | 
						|
        // Additionally, the application might choose to show a state icon
 | 
						|
        // which corresponds to an app-defined item state (for example,
 | 
						|
        // checked/unchecked) which are taken from the state image list.
 | 
						|
    wxImageList *GetImageList() const;
 | 
						|
    wxImageList *GetStateImageList() const;
 | 
						|
 | 
						|
    void SetImageList(wxImageList *imageList);
 | 
						|
    void SetStateImageList(wxImageList *imageList);
 | 
						|
 | 
						|
    // Functions to work with tree ctrl items.
 | 
						|
 | 
						|
    // accessors
 | 
						|
    // ---------
 | 
						|
 | 
						|
        // retrieve items label
 | 
						|
    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;
 | 
						|
 | 
						|
    // modifiers
 | 
						|
    // ---------
 | 
						|
 | 
						|
        // set items label
 | 
						|
    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);
 | 
						|
 | 
						|
        // force appearance of [+] button near the item. This is useful to
 | 
						|
        // 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);
 | 
						|
 | 
						|
        // the item will be shown in bold
 | 
						|
    void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
 | 
						|
 | 
						|
    // item status inquiries
 | 
						|
    // ---------------------
 | 
						|
 | 
						|
        // is the item visible (it might be outside the view or not expanded)?
 | 
						|
    bool IsVisible(const wxTreeItemId& item) const;
 | 
						|
        // does the item has any children?
 | 
						|
    bool HasChildren(const wxTreeItemId& item) const
 | 
						|
      { return ItemHasChildren(item); }
 | 
						|
    bool ItemHasChildren(const wxTreeItemId& item) const;
 | 
						|
        // is the item expanded (only makes sense if HasChildren())?
 | 
						|
    bool IsExpanded(const wxTreeItemId& item) const;
 | 
						|
        // is this item currently selected (the same as has focus)?
 | 
						|
    bool IsSelected(const wxTreeItemId& item) const;
 | 
						|
        // is item text in bold font?
 | 
						|
    bool IsBold(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
 | 
						|
    // ----------
 | 
						|
 | 
						|
    // wxTreeItemId.IsOk() will return FALSE if there is no such item
 | 
						|
 | 
						|
        // get the root tree item
 | 
						|
    wxTreeItemId GetRootItem() const { return m_anchor; }
 | 
						|
 | 
						|
        // get the item currently selected (may return NULL if no selection)
 | 
						|
    wxTreeItemId GetSelection() const { return m_current; }
 | 
						|
 | 
						|
        // get the parent of this item (may return NULL if root)
 | 
						|
    wxTreeItemId GetParent(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
 | 
						|
        // to make these functions reentrant (i.e. allow more than one
 | 
						|
        // enumeration on one and the same object simultaneously). Of course,
 | 
						|
        // 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
 | 
						|
    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 previous sibling
 | 
						|
    wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
 | 
						|
 | 
						|
        // get first visible item
 | 
						|
    wxTreeItemId GetFirstVisibleItem() const;
 | 
						|
        // get the next visible item: item must be visible itself!
 | 
						|
        // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
 | 
						|
    wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
 | 
						|
        // get the previous visible item: item must be visible itself!
 | 
						|
    wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 | 
						|
 | 
						|
    // operations
 | 
						|
    // ----------
 | 
						|
 | 
						|
        // add the root node to the tree
 | 
						|
    wxTreeItemId AddRoot(const wxString& text,
 | 
						|
                         int image = -1, int selectedImage = -1,
 | 
						|
                         wxTreeItemData *data = NULL);
 | 
						|
 | 
						|
        // insert a new item in as the first child of the parent
 | 
						|
    wxTreeItemId PrependItem(const wxTreeItemId& parent,
 | 
						|
                             const wxString& text,
 | 
						|
                             int image = -1, int selectedImage = -1,
 | 
						|
                             wxTreeItemData *data = NULL);
 | 
						|
 | 
						|
        // insert a new item after a given one
 | 
						|
    wxTreeItemId InsertItem(const wxTreeItemId& parent,
 | 
						|
                            const wxTreeItemId& idPrevious,
 | 
						|
                            const wxString& text,
 | 
						|
                            int image = -1, int selectedImage = -1,
 | 
						|
                            wxTreeItemData *data = NULL);
 | 
						|
 | 
						|
        // insert a new item in as the last child of the parent
 | 
						|
    wxTreeItemId AppendItem(const wxTreeItemId& parent,
 | 
						|
                            const wxString& text,
 | 
						|
                            int image = -1, int selectedImage = -1,
 | 
						|
                            wxTreeItemData *data = NULL);
 | 
						|
 | 
						|
        // delete this item and associated data if any
 | 
						|
    void Delete(const wxTreeItemId& item);
 | 
						|
        // delete all children (but don't delete the item itself)
 | 
						|
        // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
 | 
						|
    void DeleteChildren(const wxTreeItemId& item);
 | 
						|
        // delete all items from the tree
 | 
						|
        // NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
 | 
						|
    void DeleteAllItems();
 | 
						|
 | 
						|
        // expand this item
 | 
						|
    void Expand(const wxTreeItemId& item);
 | 
						|
        // collapse the item without removing its children
 | 
						|
    void Collapse(const wxTreeItemId& item);
 | 
						|
        // collapse the item and remove all children
 | 
						|
    void CollapseAndReset(const wxTreeItemId& item);
 | 
						|
        // toggles the current state
 | 
						|
    void Toggle(const wxTreeItemId& item);
 | 
						|
 | 
						|
        // remove the selection from currently selected item (if any)
 | 
						|
    void Unselect();
 | 
						|
        // select this item
 | 
						|
    void SelectItem(const wxTreeItemId& item);
 | 
						|
        // make sure this item is visible (expanding the parent item and/or
 | 
						|
        // scrolling to this item if necessary)
 | 
						|
    void EnsureVisible(const wxTreeItemId& item);
 | 
						|
        // scroll to this item (but don't expand its parent)
 | 
						|
    void ScrollTo(const wxTreeItemId& item);
 | 
						|
 | 
						|
        // The first function is more portable (because easier to implement
 | 
						|
        // on other platforms), but the second one returns some extra info.
 | 
						|
    wxTreeItemId HitTest(const wxPoint& point)
 | 
						|
        { int dummy; return HitTest(point, dummy); }
 | 
						|
    wxTreeItemId HitTest(const wxPoint& point, int& flags);
 | 
						|
 | 
						|
        // start editing the item label: this (temporarily) replaces the item
 | 
						|
        // with a one line edit control. The item will be selected if it hadn't
 | 
						|
        // been before. textCtrlClass parameter allows you to create an edit
 | 
						|
        // control of arbitrary user-defined class deriving from wxTextCtrl.
 | 
						|
    wxTextCtrl* EditLabel(const wxTreeItemId& item,
 | 
						|
                          wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
 | 
						|
        // returns the same pointer as StartEdit() if the item is being edited,
 | 
						|
        // NULL otherwise (it's assumed that no more than one item may be
 | 
						|
        // edited simultaneously)
 | 
						|
    wxTextCtrl* GetEditControl() const;
 | 
						|
        // end editing and accept or discard the changes to item label
 | 
						|
    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
 | 
						|
 | 
						|
    // sorting
 | 
						|
        // this function is called to compare 2 items and should return -1, 0
 | 
						|
        // or +1 if the first item is less than, equal to or greater than the
 | 
						|
        // second one. The base class version performs alphabetic comparaison
 | 
						|
        // of item labels (GetText)
 | 
						|
    virtual int OnCompareItems(const wxTreeItemId& item1,
 | 
						|
                               const wxTreeItemId& item2);
 | 
						|
        // sort the children of this item using OnCompareItems
 | 
						|
        //
 | 
						|
        // NB: this function is not reentrant and not MT-safe (FIXME)!
 | 
						|
    void SortChildren(const wxTreeItemId& item);
 | 
						|
 | 
						|
    // callbacks
 | 
						|
    void OnPaint( wxPaintEvent &event );
 | 
						|
    void OnSetFocus( wxFocusEvent &event );
 | 
						|
    void OnKillFocus( wxFocusEvent &event );
 | 
						|
    void OnChar( wxKeyEvent &event );
 | 
						|
    void OnMouse( wxMouseEvent &event );
 | 
						|
    void OnIdle( wxIdleEvent &event );
 | 
						|
 | 
						|
    // implementation
 | 
						|
    void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
 | 
						|
 | 
						|
protected:
 | 
						|
    wxGenericTreeItem   *m_anchor;
 | 
						|
    wxGenericTreeItem   *m_current;
 | 
						|
    bool                 m_hasFocus;
 | 
						|
    bool                 m_dirty;
 | 
						|
    int                  m_xScroll,m_yScroll;
 | 
						|
    unsigned int         m_indent;
 | 
						|
    unsigned int         m_spacing;
 | 
						|
    int                  m_lineHeight;
 | 
						|
    wxPen                m_dottedPen;
 | 
						|
    wxBrush             *m_hilightBrush;
 | 
						|
    wxImageList         *m_imageListNormal,
 | 
						|
                        *m_imageListState;
 | 
						|
    int                  m_dragCount;
 | 
						|
 | 
						|
    // the common part of all ctors
 | 
						|
    void Init();
 | 
						|
 | 
						|
    // misc helpers
 | 
						|
    wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
 | 
						|
                              size_t previous,
 | 
						|
                              const wxString& text,
 | 
						|
                              int image, int selectedImage,
 | 
						|
                              wxTreeItemData *data);
 | 
						|
 | 
						|
    void AdjustMyScrollbars();
 | 
						|
    void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
 | 
						|
    void PaintItem( wxGenericTreeItem *item, wxDC& dc);
 | 
						|
 | 
						|
    void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
 | 
						|
    void CalculatePositions();
 | 
						|
 | 
						|
    void RefreshSubtree( wxGenericTreeItem *item );
 | 
						|
    void RefreshLine( wxGenericTreeItem *item );
 | 
						|
 | 
						|
private:
 | 
						|
    DECLARE_EVENT_TABLE()
 | 
						|
    DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
 | 
						|
};
 | 
						|
 | 
						|
#endif // _GENERIC_TREECTRL_H_
 | 
						|
 |