From f135ff73b4b0b7c76a1fa3396f768c44f8dc204f Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 26 Oct 1998 17:11:33 +0000 Subject: [PATCH] final (?) changes to the generic tree ctrl -- seems to work ok git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@919 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/generic/treectrl.h | 688 +++++++++------- samples/treectrl/treetest.cpp | 10 +- samples/treectrl/treetest.h | 11 +- src/generic/treectrl.cpp | 1432 ++++++++++++++++----------------- 4 files changed, 1087 insertions(+), 1054 deletions(-) diff --git a/include/wx/generic/treectrl.h b/include/wx/generic/treectrl.h index f969e3c3c1..31afdb3d16 100644 --- a/include/wx/generic/treectrl.h +++ b/include/wx/generic/treectrl.h @@ -1,351 +1,433 @@ -/* - * Author: Robert Roebling - * - * Copyright: (C) 1997,1998 Robert Roebling - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the wxWindows Licence, which - * you have received with this library (see Licence.htm). - * - */ - -#ifndef __GTKTREECTRLH_G__ -#define __GTKTREECTRLH_G__ +///////////////////////////////////////////////////////////////////////////// +// 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" + #pragma interface "treectrl.h" #endif #include "wx/defs.h" #include "wx/string.h" -#include "wx/list.h" -#include "wx/control.h" +#include "wx/object.h" #include "wx/event.h" -#include "wx/imaglist.h" #include "wx/scrolwin.h" -#include "wx/dcclient.h" +#include "wx/textctrl.h" -//----------------------------------------------------------------------------- -// classes -//----------------------------------------------------------------------------- - -class wxTreeItem; -class wxTreeEvent; +// ----------------------------------------------------------------------------- +// forward declaration +// ----------------------------------------------------------------------------- +class wxImageList; class wxGenericTreeItem; -class wxTreeCtrl; -class wxImageList; +class wxTreeItemData; +typedef int (*wxTreeItemCmpFunc)(wxTreeItemData *item1, wxTreeItemData *item2); -//----------------------------------------------------------------------------- -// constants -//----------------------------------------------------------------------------- - -// WXDLLEXPORT 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. -}; +// ----------------------------------------------------------------------------- +// wxTreeItemId - unique identifier of a tree element +// ----------------------------------------------------------------------------- -// Flags for ExpandItem -enum { - wxTREE_EXPAND_EXPAND, - wxTREE_EXPAND_COLLAPSE, - wxTREE_EXPAND_COLLAPSE_RESET, - wxTREE_EXPAND_TOGGLE -}; +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; } -// Flags for InsertItem -enum { - wxTREE_INSERT_LAST = -1, - wxTREE_INSERT_FIRST = -2, - wxTREE_INSERT_SORT = -3 + // deprecated: only for compatibility + wxTreeItemId(long itemId) { m_pItem = (wxGenericTreeItem *)itemId; } + operator long() const { return (long)m_pItem; } + +protected: + // for wxTreeCtrl usage only + wxTreeItemId(wxGenericTreeItem *pItem) { m_pItem = pItem; } + + wxGenericTreeItem *m_pItem; }; -/* defined in "wx/event.h" - 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_SEL_CHANGED, - wxEVT_COMMAND_TREE_SEL_CHANGING, - wxEVT_COMMAND_TREE_KEY_DOWN -*/ - -//----------------------------------------------------------------------------- -// wxTreeItem -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxTreeItem: public wxObject +// ---------------------------------------------------------------------------- +// 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 { +friend class wxTreeCtrl; 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 GetState(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 SetSelectedImage(int selImage) { m_selectedImage = selImage; } - inline void SetChildren(int children) { m_children = children; } - inline void SetData(long data) { m_data = data; } - - DECLARE_DYNAMIC_CLASS(wxTreeItem) -}; + // creation/destruction + // -------------------- + // default ctor + wxTreeItemData() { } + + // 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() { } -//----------------------------------------------------------------------------- -// wxTreeEvent -//----------------------------------------------------------------------------- + // accessor: get the item associated with us + const wxTreeItemId& GetId() const { return m_pItem; } + void SetId(const wxTreeItemId& id) { m_pItem = id; } -class WXDLLEXPORT wxTreeEvent: public wxCommandEvent +protected: + wxTreeItemId m_pItem; +}; + +// ----------------------------------------------------------------------------- +// wxTreeEvent - the event generated by the tree control +// ----------------------------------------------------------------------------- +class WXDLLEXPORT wxTreeEvent : public wxCommandEvent { - DECLARE_DYNAMIC_CLASS(wxTreeEvent) +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; } - public: - wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0); + // for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously + // selected item + wxTreeItemId GetOldItem() const { return m_itemOld; } - int m_code; - wxTreeItem m_item; - long m_oldItem; - wxPoint m_pointDrag; + // 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; } - inline long GetOldItem() const { return m_oldItem; } - inline wxTreeItem& GetItem() const { return (wxTreeItem&) m_item; } - inline wxPoint GetPoint() const { return m_pointDrag; } - inline void SetCode(int code) { m_code = code; } - inline int GetCode() const { return m_code; } + // 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 }, -#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, 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, (wxObject *) NULL }, -#define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL }, -#define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL }, -#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, 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 }, -//----------------------------------------------------------------------------- -// wxGenericTreeItem -//----------------------------------------------------------------------------- +// 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 }, -class WXDLLEXPORT wxGenericTreeItem: public wxTreeItem -{ - DECLARE_DYNAMIC_CLASS(wxGenericTreeItem) - - public: - bool m_hasChildren, - m_isCollapsed; - - int m_x,m_y; - int m_height,m_width; - int m_xCross,m_yCross; - int m_level; - wxList m_children; - wxGenericTreeItem *m_parent; - bool m_hasHilight; - - wxGenericTreeItem() {}; - wxGenericTreeItem( wxGenericTreeItem *parent ); - wxGenericTreeItem( wxGenericTreeItem *parent, const wxTreeItem& item, wxDC *dc ); - void SetItem( const wxTreeItem &item, wxDC *dc ); - void SetText( const wxString &text, wxDC *dc ); - void Reset(); - void GetItem( wxTreeItem &item ) const; - void AddChild( const wxTreeItem &item ); - bool HasChildren(); - bool HasPlus(); - int NumberOfVisibleDescendents(); - int NumberOfVisibleChildren(); - wxGenericTreeItem *FindItem( long itemId ) const; - void AddChild( wxGenericTreeItem *child ); - void SetCross( int x, int y ); - void GetSize( int &x, int &y ); - long HitTest( const wxPoint& point, int &flags ); - void PrepareEvent( wxTreeEvent &event ); - void SendKeyDown( wxWindow *target ); - void SendSelected( wxWindow *target ); - void SendDelete( wxWindow *target ); - void SendExpand( wxWindow *target ); - void SendCollapse( wxWindow *target ); - void SetHilight( bool set = TRUE ); - bool HasHilight(); - bool IsExpanded() const { return !m_isCollapsed; } -}; +// 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 }, -//----------------------------------------------------------------------------- -// wxTreeCtrl -//----------------------------------------------------------------------------- +// 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 }, + +// ----------------------------------------------------------------------------- +// wxTreeCtrl - the tree control +// ----------------------------------------------------------------------------- -class wxTreeCtrl: public wxScrolledWindow +class WXDLLEXPORT wxTreeCtrl : public wxScrolledWindow { public: - wxTreeCtrl(); - wxTreeCtrl(wxWindow *parent, const wxWindowID id = -1, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxTR_HAS_BUTTONS, - const wxString& name = "wxTreeCtrl" ); - ~wxTreeCtrl(); - bool Create(wxWindow *parent, const wxWindowID id = -1, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxTR_HAS_BUTTONS, - const wxString& name = "wxTreeCtrl"); - - int GetCount() const; - long InsertItem( long parent, const wxString& label, int image = -1, - int selImage = -1, long insertAfter = wxTREE_INSERT_LAST ); - long InsertItem( long parent, wxTreeItem &info, - long insertAfter = wxTREE_INSERT_LAST ); - void DeleteItem( long item ); - void DeleteChildren( long item ); - bool DeleteAllItems(); - 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); } - bool ExpandItem( long item, int action ); - - // is the item expanded now? - bool IsItemExpanded(long item) - { - wxGenericTreeItem *pItem = FindItem(item); - return pItem && (pItem->GetState() & wxTREE_STATE_EXPANDED); - } - - bool GetItem( wxTreeItem &info ) const; - long GetItemData( long item ) const; - wxString GetItemText( long item ) const; - int GetItemImage(long item) const; - long GetParent( long item ) const; - long GetRootItem() const; - long GetChild(long item) const; - long GetNextItem(long item, int code) const; - long GetSelection() const; - bool SelectItem( long item ); - bool ItemHasChildren( long item ) const; - void SetIndent( int indent ); - int GetIndent() const; - bool SetItem( wxTreeItem &info ); - bool SetItemData( long item, long data ); - bool SetItemText( long item, const wxString &text ); - void SetItemImage(long item, int image, int imageSel) const; - long HitTest( const wxPoint& point, int &flags ); - - int GetItemState(long item, long stateMask) const; - bool SetItemState(long item, long state, long stateMask); - - void AdjustMyScrollbars(); - void PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y ); - void OnPaint( const wxPaintEvent &event ); - void OnSetFocus( const wxFocusEvent &event ); - void OnKillFocus( const wxFocusEvent &event ); - void OnChar( wxKeyEvent &event ); - void OnMouse( const wxMouseEvent &event ); - - wxImageList *GetImageList(int which = wxIMAGE_LIST_NORMAL) const; - void SetImageList(wxImageList *imageList, int which = wxIMAGE_LIST_NORMAL); + // 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 wxString& name = "wxTreeCtrl") + { + Create(parent, id, pos, size, style, 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 wxString& name = "wxTreeCtrl"); + + // 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); + + // 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); + + // 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 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; + + // 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 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 items from the tree + 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); + + // 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); + + // 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 + // alphabetical comparaison is performed. + // + // NB: this function is not reentrant! + void SortChildren(const wxTreeItemId& item, + wxTreeItemCmpFunc *cmpFunction = NULL); + + // implementation + // -------------- + // wxWindows callbacks + void OnPaint( const wxPaintEvent &event ); + void OnSetFocus( const wxFocusEvent &event ); + void OnKillFocus( const wxFocusEvent &event ); + void OnChar( wxKeyEvent &event ); + void OnMouse( const wxMouseEvent &event ); + +protected: + wxGenericTreeItem *m_anchor; + wxGenericTreeItem *m_current; + bool m_hasFocus; + int m_xScroll,m_yScroll; + unsigned int m_indent; + int m_lineHeight; + wxPen m_dottedPen; + wxBrush *m_hilightBrush; + wxImageList *m_imageListNormal, + *m_imageListState; + + // 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 CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y ); + void CalculatePositions(); + + void RefreshSubtree( wxGenericTreeItem *item ); + void RefreshLine( wxGenericTreeItem *item ); private: - // set the selection to the specified item generating appropriate event(s) - void SelectItem(wxGenericTreeItem *item); - - wxGenericTreeItem *m_anchor; - wxGenericTreeItem *m_current; - bool m_hasFocus; - int m_xScroll,m_yScroll; - int m_indent; - long m_lastId; - int m_lineHeight; - wxPen m_dottedPen; - bool m_isCreated; - wxBrush *m_hilightBrush; - wxImageList *m_imageList; - wxImageList *m_smallImageList; - - void CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y ); - void CalculatePositions(); - wxGenericTreeItem *FindItem( long itemId ) const; - void RefreshLine( wxGenericTreeItem *item ); - - DECLARE_EVENT_TABLE() - DECLARE_DYNAMIC_CLASS(wxTreeCtrl) + DECLARE_EVENT_TABLE() + DECLARE_DYNAMIC_CLASS(wxTreeCtrl) }; -#endif - // __GTKTREECTRLH_G__ +#endif // _GENERIC_TREECTRL_H_ + diff --git a/samples/treectrl/treetest.cpp b/samples/treectrl/treetest.cpp index ccebf8749e..8c3e7ba0fa 100644 --- a/samples/treectrl/treetest.cpp +++ b/samples/treectrl/treetest.cpp @@ -182,7 +182,7 @@ void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId& idParent, for ( size_t n = 0; n < numChildren; n++ ) { // at depth 1 elements won't have any more children - str.Printf("%s child %d", depth == 1 ? "File" : "Folder", n); + str.Printf("%s child %d", depth == 1 ? "File" : "Folder", n + 1); int image = depth == 1 ? TreeCtrlIcon_File : TreeCtrlIcon_Folder; wxTreeItemId id = AppendItem(idParent, str, image, image, new MyTreeItemData(str)); @@ -226,11 +226,13 @@ TREE_EVENT_HANDLER(OnSelChanging) void MyTreeCtrl::OnItemCollapsing(wxTreeEvent& event) { + wxLogMessage("OnItemCollapsing"); + // for testing, prevent the user from collapsing the root item wxTreeItemId itemId = event.GetItem(); if ( !GetParent(itemId).IsOk() ) { - wxMessageBox("Root item shouldn't collapse"); + wxMessageBox("You can't collapse the root item."); event.Veto(); } @@ -259,6 +261,6 @@ void MyTreeItemData::ShowInfo(wxTreeCtrl *tree) { wxLogMessage("Item '%s': %sselected, %sexpanded.", m_desc.c_str(), - Bool2String(tree->IsExpanded(m_itemId)), - Bool2String(tree->IsSelected(m_itemId))); + Bool2String(tree->IsSelected(GetId())), + Bool2String(tree->IsExpanded(GetId()))); } diff --git a/samples/treectrl/treetest.h b/samples/treectrl/treetest.h index d90770be84..a72ee5fa51 100644 --- a/samples/treectrl/treetest.h +++ b/samples/treectrl/treetest.h @@ -69,7 +69,12 @@ class MyFrame: public wxFrame class MyTreeItemData : public wxTreeItemData { public: + MyTreeItemData(const wxString& desc) : m_desc(desc) { } + void ShowInfo(wxTreeCtrl *tree); + +private: + wxString m_desc; }; // ID for the menu quit command @@ -78,4 +83,8 @@ public: #define TREE_CTRL 1000 - +enum +{ + TreeCtrlIcon_File, + TreeCtrlIcon_Folder +}; diff --git a/src/generic/treectrl.cpp b/src/generic/treectrl.cpp index c7862e8099..992939ca8a 100644 --- a/src/generic/treectrl.cpp +++ b/src/generic/treectrl.cpp @@ -1,193 +1,221 @@ ///////////////////////////////////////////////////////////////////////////// // Name: treectrl.cpp -// Purpose: +// Purpose: generic tree control implementation // Author: Robert Roebling // Created: 01/02/97 +// Modified: 22/10/98 - almost total rewrite, simpler interface (VZ) // Id: $Id$ // Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// ============================================================================= +// declarations +// ============================================================================= + +// ----------------------------------------------------------------------------- +// headers +// ----------------------------------------------------------------------------- + #ifdef __GNUG__ -#pragma implementation "treectrl.h" + #pragma implementation "treectrl.h" #endif #include "wx/treectrl.h" #include "wx/settings.h" #include "wx/log.h" -#include +#include "wx/intl.h" +#include "wx/dynarray.h" +#include "wx/dcclient.h" -//----------------------------------------------------------------------------- -// wxTreeItem -//----------------------------------------------------------------------------- +// ----------------------------------------------------------------------------- +// array types +// ----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxTreeItem, wxObject) +WX_DEFINE_ARRAY(wxGenericTreeItem *, wxArrayTreeItems); -wxTreeItem::wxTreeItem() +// ----------------------------------------------------------------------------- +// private classes +// ----------------------------------------------------------------------------- + +// a tree item +class WXDLLEXPORT wxGenericTreeItem { - m_mask = 0; - m_itemId = 0; - m_state = 0; - m_stateMask = 0; - m_image = -1; - m_selectedImage = -1; - m_children = 0; - m_data = 0; -} +public: + // ctors & dtor + wxGenericTreeItem() { m_data = NULL; } + wxGenericTreeItem( wxGenericTreeItem *parent, + const wxString& text, + wxDC& dc, + int image, int selImage, + wxTreeItemData *data ); + + inline ~wxGenericTreeItem(); + + // trivial accessors + wxArrayTreeItems& GetChildren() { return m_children; } + + const wxString& GetText() const { return m_text; } + int GetImage() const { return m_image; } + int GetSelectedImage() const { return m_selImage; } + wxTreeItemData *GetData() const { return m_data; } + + void SetText( const wxString &text, wxDC& dc ); + void SetImage(int image) { m_image = image; } + void SetSelectedImage(int image) { m_selImage = image; } + void SetData(wxTreeItemData *data) { m_data = data; } + + void SetHasPlus(bool has = TRUE) { m_hasPlus = has; } + + int GetX() const { return m_x; } + int GetY() const { return m_y; } + + void SetHeight(int h) { m_height = h; } + + void SetX(int x) { m_x = x; } + void SetY(int y) { m_y = y; } + + wxGenericTreeItem *GetParent() const { return m_parent; } -//----------------------------------------------------------------------------- + // operations + void Reset(); + + // get count of all children (and grand children and ...) of this item + size_t GetTotalNumberOfChildren() const; + + void Insert(wxGenericTreeItem *child, size_t index) + { m_children.Insert(child, index); } + + void SetCross( int x, int y ); + void GetSize( int &x, int &y ); + + // return the item at given position (or NULL if no item), onButton is TRUE + // if the point belongs to the item's button, otherwise it lies on the + // button's label + wxGenericTreeItem *HitTest( const wxPoint& point, bool &onButton ); + + void Expand() { m_isCollapsed = FALSE; } + void Collapse() { m_isCollapsed = TRUE; } + + void SetHilight( bool set = TRUE ) { m_hasHilight = set; } + + // status inquiries + bool HasChildren() const { return !m_children.IsEmpty(); } + bool HasHilight() const { return m_hasHilight; } + bool IsExpanded() const { return !m_isCollapsed; } + bool HasPlus() const { return m_hasPlus || HasChildren(); } + +private: + wxString m_text; + + int m_image, + m_selImage; + + wxTreeItemData *m_data; + + // @@ probably should use bitfields to save size + bool m_isCollapsed, + m_hasHilight, // same as focused + m_hasPlus; // used for item which doesn't have + // children but still has a [+] button + + int m_x, m_y; + long m_height, m_width; + int m_xCross, m_yCross; + int m_level; + wxArrayTreeItems m_children; + wxGenericTreeItem *m_parent; +}; + +// ============================================================================= +// implementation +// ============================================================================= + +// ----------------------------------------------------------------------------- // wxTreeEvent -//----------------------------------------------------------------------------- +// ----------------------------------------------------------------------------- -IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent,wxCommandEvent) +IMPLEMENT_DYNAMIC_CLASS(wxTreeEvent, wxCommandEvent) -wxTreeEvent::wxTreeEvent( wxEventType commandType, int id ) : - wxCommandEvent( commandType, id ) +wxTreeEvent::wxTreeEvent( wxEventType commandType, int id ) + : wxCommandEvent( commandType, id ) { m_code = 0; - m_oldItem = 0; + m_itemOld = (wxGenericTreeItem *)NULL; } -//----------------------------------------------------------------------------- +// ----------------------------------------------------------------------------- // wxGenericTreeItem -//----------------------------------------------------------------------------- - -IMPLEMENT_DYNAMIC_CLASS(wxGenericTreeItem,wxObject) +// ----------------------------------------------------------------------------- -wxGenericTreeItem::wxGenericTreeItem( wxGenericTreeItem *parent ) +wxGenericTreeItem::wxGenericTreeItem(wxGenericTreeItem *parent, + const wxString& text, + wxDC& dc, + int image, int selImage, + wxTreeItemData *data) + : m_text(text) { - Reset(); - m_parent = parent; + m_image = image; + m_selImage = selImage; + m_data = data; + m_x = m_y = 0; + m_xCross = m_yCross = 0; + + m_level = 0; + + m_isCollapsed = TRUE; m_hasHilight = FALSE; -} -wxGenericTreeItem::wxGenericTreeItem( wxGenericTreeItem *parent, const wxTreeItem& item, wxDC *dc ) -{ - Reset(); - SetItem( item, dc ); m_parent = parent; - m_hasHilight = FALSE; + + dc.GetTextExtent( m_text, &m_width, &m_height ); } -void wxGenericTreeItem::SetItem( const wxTreeItem &item, wxDC *dc ) +wxGenericTreeItem::~wxGenericTreeItem() { - if ((item.m_mask & wxTREE_MASK_HANDLE) == wxTREE_MASK_HANDLE) - m_itemId = item.m_itemId; - if ((item.m_mask & wxTREE_MASK_STATE) == wxTREE_MASK_STATE) - m_state = item.m_state; - if ((item.m_mask & wxTREE_MASK_TEXT) == wxTREE_MASK_TEXT) - m_text = item.m_text; - if ((item.m_mask & wxTREE_MASK_IMAGE) == wxTREE_MASK_IMAGE) - m_image = item.m_image; - if ((item.m_mask & wxTREE_MASK_SELECTED_IMAGE) == wxTREE_MASK_SELECTED_IMAGE) - m_selectedImage = item.m_selectedImage; - if ((item.m_mask & wxTREE_MASK_CHILDREN) == wxTREE_MASK_CHILDREN) - m_hasChildren = (item.m_children > 0); - if ((item.m_mask & wxTREE_MASK_DATA) == wxTREE_MASK_DATA) - m_data = item.m_data; - long lw = 0; - long lh = 0; - dc->GetTextExtent( m_text, &lw, &lh ); - m_width = lw; - m_height = lh; + delete m_data; + + size_t count = m_children.Count(); + for ( size_t n = 0; n < count; n++ ) + delete m_children[n]; } -void wxGenericTreeItem::SetText( const wxString &text, wxDC *dc ) +void wxGenericTreeItem::SetText( const wxString &text, wxDC& dc ) { m_text = text; - long lw = 0; - long lh = 0; - dc->GetTextExtent( m_text, &lw, &lh ); - m_width = lw; - m_height = lh; + + dc.GetTextExtent( m_text, &m_width, &m_height ); } void wxGenericTreeItem::Reset() { - m_itemId = -1; - m_state = 0; - m_text = ""; - m_image = -1; - m_selectedImage = -1; -// m_children = 0; - m_hasChildren = FALSE; - m_data = 0; - m_x = 0; - m_y = 0; - m_height = 0; - m_width = 0; - m_xCross = 0; + m_text.Empty(); + m_image = + m_selImage = -1; + m_data = NULL; + m_x = m_y = + m_height = m_width = 0; + m_xCross = m_yCross = 0; - m_level = 0; - m_children.DeleteContents( TRUE ); - m_isCollapsed = TRUE; - m_parent = (wxGenericTreeItem *) NULL; -} - -void wxGenericTreeItem::GetItem( wxTreeItem &item ) const -{ - if ((item.m_mask & wxTREE_MASK_STATE) == wxTREE_MASK_STATE) - item.m_state = m_state; - if ((item.m_mask & wxTREE_MASK_TEXT) == wxTREE_MASK_TEXT) - item.m_text = m_text; - if ((item.m_mask & wxTREE_MASK_IMAGE) == wxTREE_MASK_IMAGE) - item.m_image = m_image; - if ((item.m_mask & wxTREE_MASK_SELECTED_IMAGE) == wxTREE_MASK_SELECTED_IMAGE) - item.m_selectedImage = m_selectedImage; - if ((item.m_mask & wxTREE_MASK_CHILDREN) == wxTREE_MASK_CHILDREN) - item.m_children = (int)m_hasChildren; - if ((item.m_mask & wxTREE_MASK_DATA) == wxTREE_MASK_DATA) - item.m_data = m_data; -} - -bool wxGenericTreeItem::HasChildren() -{ - return m_hasChildren; -} - -bool wxGenericTreeItem::HasPlus() -{ - if ( !HasChildren() ) - return FALSE; - return !IsExpanded(); -} + m_level = 0; -int wxGenericTreeItem::NumberOfVisibleDescendents() -{ - int ret = m_children.Number(); - wxNode *node = m_children.First(); - while (node) - { - wxGenericTreeItem *item = (wxGenericTreeItem*)node->Data(); - ret += item->NumberOfVisibleDescendents(); - node = node->Next(); - } - return ret; -} + m_children.Empty(); + m_isCollapsed = TRUE; -int wxGenericTreeItem::NumberOfVisibleChildren() -{ - return m_isCollapsed ? 0 : m_children.Number(); + m_parent = (wxGenericTreeItem *)NULL; } -wxGenericTreeItem *wxGenericTreeItem::FindItem( long itemId ) const +size_t wxGenericTreeItem::GetTotalNumberOfChildren() const { - if (m_itemId == itemId) return (wxGenericTreeItem*)(this); - wxNode *node = m_children.First(); - while (node) + size_t count = m_children.Count(); + size_t total = count; + for ( size_t n = 0; n < count; n++ ) { - wxGenericTreeItem *item = (wxGenericTreeItem*)node->Data(); - wxGenericTreeItem *res = item->FindItem( itemId ); - if (res) return (wxGenericTreeItem*)(res); - node = node->Next(); + total += m_children[n]->GetTotalNumberOfChildren(); } - return (wxGenericTreeItem *) NULL; -} -void wxGenericTreeItem::AddChild( wxGenericTreeItem *child ) -{ - m_children.Append( child ); + return total; } void wxGenericTreeItem::SetCross( int x, int y ) @@ -198,724 +226,610 @@ void wxGenericTreeItem::SetCross( int x, int y ) void wxGenericTreeItem::GetSize( int &x, int &y ) { - if (y < m_y + 10) y = m_y +10; + // FIXME what does this all mean?? + if ( y < m_y + 10 ) y = m_y +10; int width = m_x + m_width; if (width > x) x = width; - wxNode *node = m_children.First(); - while (node) + + size_t count = m_children.Count(); + for ( size_t n = 0; n < count; n++ ) { - wxGenericTreeItem *item = (wxGenericTreeItem*)node->Data(); - item->GetSize( x, y ); - node = node->Next(); + m_children[n]->GetSize( x, y ); } } -long wxGenericTreeItem::HitTest( const wxPoint& point, int &flags ) +wxGenericTreeItem *wxGenericTreeItem::HitTest( const wxPoint& point, + bool &onButton ) { - if ((point.y > m_y) && (point.y < m_y+m_height)) + if ((point.y > m_y) && (point.y < m_y + m_height)) { - if ((point.x > m_xCross-5) && - (point.x < m_xCross+5) && - (point.y > m_yCross-5) && - (point.y < m_yCross+5) && - (m_hasChildren)) + // FIXME why +5? + if ((point.x > m_xCross-5) && (point.x < m_xCross+5) && + (point.y > m_yCross-5) && (point.y < m_yCross+5) && + HasChildren()) { - flags = wxTREE_HITTEST_ONITEMBUTTON; - return m_itemId; + onButton = TRUE; + return this; } + if ((point.x > m_x) && (point.x < m_x+m_width)) { - flags = wxTREE_HITTEST_ONITEMLABEL; - return m_itemId; + onButton = FALSE; + return this; } - if (point.x > m_x) - { - flags = wxTREE_HITTEST_ONITEMRIGHT; - return m_itemId; - } - flags = wxTREE_HITTEST_ONITEMINDENT; - return m_itemId; } else { if (!m_isCollapsed) { - wxNode *node = m_children.First(); - while (node) + size_t count = m_children.Count(); + for ( size_t n = 0; n < count; n++ ) { - wxGenericTreeItem *child = (wxGenericTreeItem*)node->Data(); - long res = child->HitTest( point, flags ); - if (res != -1) return res; - node = node->Next(); + wxGenericTreeItem *res = m_children[n]->HitTest( point, onButton ); + if ( res != NULL ) + return res; } } } - return -1; + + return NULL; } -void wxGenericTreeItem::PrepareEvent( wxTreeEvent &event ) +// ----------------------------------------------------------------------------- +// wxTreeCtrl implementation +// ----------------------------------------------------------------------------- + +IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl, wxScrolledWindow) + +BEGIN_EVENT_TABLE(wxTreeCtrl,wxScrolledWindow) + EVT_PAINT (wxTreeCtrl::OnPaint) + EVT_MOUSE_EVENTS (wxTreeCtrl::OnMouse) + EVT_CHAR (wxTreeCtrl::OnChar) + EVT_SET_FOCUS (wxTreeCtrl::OnSetFocus) + EVT_KILL_FOCUS (wxTreeCtrl::OnKillFocus) +END_EVENT_TABLE() + +// ----------------------------------------------------------------------------- +// construction/destruction +// ----------------------------------------------------------------------------- +void wxTreeCtrl::Init() { - event.m_item.m_itemId = m_itemId; - event.m_item.m_state = m_state; - event.m_item.m_text = m_text; - event.m_item.m_image = m_image; - event.m_item.m_selectedImage = m_selectedImage; - event.m_item.m_children = (int)m_hasChildren; - event.m_item.m_data = m_data; - event.m_oldItem = 0; - event.m_code = 0; - event.m_pointDrag.x = 0; - event.m_pointDrag.y = 0; + m_current = + m_anchor = (wxGenericTreeItem *) NULL; + m_hasFocus = FALSE; + + m_xScroll = 0; + m_yScroll = 0; + m_lineHeight = 10; + m_indent = 15; + + m_hilightBrush = new wxBrush + ( + wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT), + wxSOLID + ); + + m_imageListNormal = + m_imageListState = (wxImageList *) NULL; } -void wxGenericTreeItem::SendKeyDown( wxWindow *target ) +bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id, + const wxPoint& pos, const wxSize& size, + long style, const wxString& name ) { - wxTreeEvent event( wxEVT_COMMAND_TREE_KEY_DOWN, target->GetId() ); - PrepareEvent( event ); - event.SetEventObject( target ); - target->ProcessEvent( event ); + Init(); + + wxScrolledWindow::Create( parent, id, pos, size, style, name ); + + SetBackgroundColour( *wxWHITE ); + m_dottedPen = wxPen( *wxBLACK, 0, 0 ); + + return TRUE; } -void wxGenericTreeItem::SendSelected( wxWindow *target ) +wxTreeCtrl::~wxTreeCtrl() { - wxTreeEvent event( wxEVT_COMMAND_TREE_SEL_CHANGED, target->GetId() ); - PrepareEvent( event ); - event.SetEventObject( target ); - target->ProcessEvent( event ); + wxDELETE( m_hilightBrush ); + wxDELETE( m_anchor ); } -void wxGenericTreeItem::SendDelete( wxWindow *target ) +// ----------------------------------------------------------------------------- +// accessors +// ----------------------------------------------------------------------------- + +size_t wxTreeCtrl::GetCount() const { - wxTreeEvent event( wxEVT_COMMAND_TREE_DELETE_ITEM, target->GetId() ); - PrepareEvent( event ); - event.SetEventObject( target ); - target->ProcessEvent( event ); + return m_anchor == NULL ? 0u : m_anchor->GetTotalNumberOfChildren(); } -void wxGenericTreeItem::SendExpand( wxWindow *target ) +void wxTreeCtrl::SetIndent(unsigned int indent) { - m_isCollapsed = FALSE; + m_indent = indent; + Refresh(); +} - wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_EXPANDING, target->GetId() ); - event.SetEventObject( target ); - PrepareEvent( event ); - target->ProcessEvent( event ); +// ----------------------------------------------------------------------------- +// functions to work with tree items +// ----------------------------------------------------------------------------- - event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED); - PrepareEvent( event ); - target->ProcessEvent( event ); +wxString wxTreeCtrl::GetItemText(const wxTreeItemId& item) const +{ + return item.m_pItem->GetText(); } -void wxGenericTreeItem::SendCollapse( wxWindow *target ) +int wxTreeCtrl::GetItemImage(const wxTreeItemId& item) const { - m_isCollapsed = TRUE; - - wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, target->GetId() ); - event.SetEventObject( target ); - PrepareEvent( event ); - target->ProcessEvent( event ); - - event.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED); - PrepareEvent( event ); - target->ProcessEvent( event ); + return item.m_pItem->GetImage(); } -void wxGenericTreeItem::SetHilight( bool set ) +int wxTreeCtrl::GetItemSelectedImage(const wxTreeItemId& item) const { - m_hasHilight = set; + return item.m_pItem->GetSelectedImage(); } -bool wxGenericTreeItem::HasHilight() +wxTreeItemData *wxTreeCtrl::GetItemData(const wxTreeItemId& item) const { - return m_hasHilight; + return item.m_pItem->GetData(); } -//----------------------------------------------------------------------------- -// wxTreeCtrl -//----------------------------------------------------------------------------- - -IMPLEMENT_DYNAMIC_CLASS(wxTreeCtrl,wxScrolledWindow) +void wxTreeCtrl::SetItemText(const wxTreeItemId& item, const wxString& text) +{ + wxClientDC dc(this); + return item.m_pItem->SetText(text, dc); +} -BEGIN_EVENT_TABLE(wxTreeCtrl,wxScrolledWindow) - EVT_PAINT (wxTreeCtrl::OnPaint) - EVT_MOUSE_EVENTS (wxTreeCtrl::OnMouse) - EVT_CHAR (wxTreeCtrl::OnChar) - EVT_SET_FOCUS (wxTreeCtrl::OnSetFocus) - EVT_KILL_FOCUS (wxTreeCtrl::OnKillFocus) -END_EVENT_TABLE() +void wxTreeCtrl::SetItemImage(const wxTreeItemId& item, int image) +{ + return item.m_pItem->SetImage(image); +} -wxTreeCtrl::wxTreeCtrl() +void wxTreeCtrl::SetItemSelectedImage(const wxTreeItemId& item, int image) { - m_current = (wxGenericTreeItem *) NULL; - m_anchor = (wxGenericTreeItem *) NULL; - m_hasFocus = FALSE; - m_xScroll = 0; - m_yScroll = 0; - m_lastId = 0; - m_lineHeight = 10; - m_indent = 15; - m_isCreated = FALSE; - m_hilightBrush = new wxBrush( wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT), wxSOLID ); - m_imageList = (wxImageList *) NULL; - m_smallImageList = (wxImageList *) NULL; + return item.m_pItem->SetSelectedImage(image); } -wxTreeCtrl::wxTreeCtrl(wxWindow *parent, wxWindowID id, - const wxPoint& pos, const wxSize& size, - long style, const wxString& name ) +void wxTreeCtrl::SetItemData(const wxTreeItemId& item, wxTreeItemData *data) { - m_current = (wxGenericTreeItem *) NULL; - m_anchor = (wxGenericTreeItem *) NULL; - m_hasFocus = FALSE; - m_xScroll = 0; - m_yScroll = 0; - m_lastId = 0; - m_lineHeight = 10; - m_indent = 15; - m_isCreated = FALSE; - m_hilightBrush = new wxBrush( wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT), wxSOLID ); - m_imageList = (wxImageList *) NULL; - m_smallImageList = (wxImageList *) NULL; - Create( parent, id, pos, size, style, name ); + return item.m_pItem->SetData(data); } -wxTreeCtrl::~wxTreeCtrl() +void wxTreeCtrl::SetItemHasChildren(const wxTreeItemId& item, bool has) { - if (m_hilightBrush) delete m_hilightBrush; - if (m_anchor) delete m_anchor; + item.m_pItem->SetHasPlus(has); } -bool wxTreeCtrl::Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos, const wxSize& size, - long style, const wxString& name ) +// ----------------------------------------------------------------------------- +// item status inquiries +// ----------------------------------------------------------------------------- + +bool wxTreeCtrl::IsVisible(const wxTreeItemId& item) const { - wxScrolledWindow::Create( parent, id, pos, size, style, name ); - SetBackgroundColour( *wxWHITE ); - m_dottedPen = wxPen( *wxBLACK, 0, 0 ); + wxFAIL_MSG("not implemented"); + return TRUE; } -int wxTreeCtrl::GetCount() const +bool wxTreeCtrl::ItemHasChildren(const wxTreeItemId& item) const { - if (!m_anchor) return 0; - return m_anchor->NumberOfVisibleDescendents(); + return !item.m_pItem->GetChildren().IsEmpty(); } -long wxTreeCtrl::InsertItem( long parent, const wxString& label, int image, - int selImage, long WXUNUSED(insertAfter) ) +bool wxTreeCtrl::IsExpanded(const wxTreeItemId& item) const { - wxGenericTreeItem *p = (wxGenericTreeItem *) NULL; - if (parent == 0) - { - if (m_anchor) return -1; - } - else - { - p = FindItem( parent ); - if (!p) return -1; - } - wxTreeItem item; - m_lastId++; - item.m_mask = wxTREE_MASK_HANDLE; - item.m_itemId = m_lastId; - if (!label.IsNull() || (label == "")) - { - item.m_text = label; - item.m_mask |= wxTREE_MASK_TEXT; - } - if (image >= 0) - { - item.m_image = image; - item.m_mask |= wxTREE_MASK_IMAGE; - } - if (selImage >= 0) - { - item.m_selectedImage = selImage; - item.m_mask |= wxTREE_MASK_SELECTED_IMAGE; - } + return item.m_pItem->IsExpanded(); +} - wxClientDC dc(this); - wxGenericTreeItem *new_child = new wxGenericTreeItem( p, item, &dc ); - if (p) - p->AddChild( new_child ); - else - m_anchor = new_child; +bool wxTreeCtrl::IsSelected(const wxTreeItemId& item) const +{ + return item.m_pItem->HasHilight(); +} - if (p) - { - CalculatePositions(); +// ----------------------------------------------------------------------------- +// navigation +// ----------------------------------------------------------------------------- - if (!p->HasChildren()) p->m_hasChildren = TRUE; +wxTreeItemId wxTreeCtrl::GetParent(const wxTreeItemId& item) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); - int cw = 0, ch = 0; - GetClientSize( &cw, &ch ); + return item.m_pItem->GetParent(); +} - PrepareDC( dc ); - - wxRectangle rect; - rect.x = dc.LogicalToDeviceX( 0 ); - rect.y = 0; - rect.width = 10000; - rect.height = ch; +wxTreeItemId wxTreeCtrl::GetFirstChild(const wxTreeItemId& item, long& cookie) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); - if (p->m_children.Number() == 1) - { - rect.y = dc.LogicalToDeviceY( p->m_y ); - } - else - { - wxNode *node = p->m_children.Member( new_child )->Previous(); - wxGenericTreeItem* last_child = (wxGenericTreeItem*)node->Data(); - rect.y = dc.LogicalToDeviceY( last_child->m_y ); - } + cookie = 0; + return GetNextChild(item, cookie); +} - AdjustMyScrollbars(); +wxTreeItemId wxTreeCtrl::GetNextChild(const wxTreeItemId& item, long& cookie) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); - if (rect.height > 0) Refresh( FALSE, &rect); - } - else - { - AdjustMyScrollbars(); + return item.m_pItem->GetChildren().Item(cookie++); +} - Refresh(); +wxTreeItemId wxTreeCtrl::GetNextSibling(const wxTreeItemId& item) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); + + wxGenericTreeItem *i = item.m_pItem; + wxGenericTreeItem *parent = i->GetParent(); + if ( parent == NULL ) + { + // root item doesn't have any siblings + return NULL; } + + wxArrayTreeItems& siblings = parent->GetChildren(); + int index = siblings.Index(i); + wxASSERT( index != NOT_FOUND ); // I'm not a child of my parent? - return m_lastId; + size_t n = (size_t)(index + 1); + return n == siblings.Count() ? NULL : siblings[n]; } -long wxTreeCtrl::InsertItem( long parent, wxTreeItem &info, long WXUNUSED(insertAfter) ) +wxTreeItemId wxTreeCtrl::GetPrevSibling(const wxTreeItemId& item) const { - int oldMask = info.m_mask; - wxGenericTreeItem *p = (wxGenericTreeItem *) NULL; - if (parent == 0) - { - if (m_anchor) return -1; - } - else - { - p = FindItem( parent ); - if (!p) - { - printf( "TreeItem not found.\n" ); - return -1; - } - } - long ret = 0; - if ((info.m_mask & wxTREE_MASK_HANDLE) == 0) - { - m_lastId++; - info.m_itemId = m_lastId; - info.m_mask |= wxTREE_MASK_HANDLE; - ret = m_lastId; - } - else + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); + + wxGenericTreeItem *i = item.m_pItem; + wxGenericTreeItem *parent = i->GetParent(); + if ( parent == NULL ) { - ret = info.m_itemId; + // root item doesn't have any siblings + return NULL; } + + wxArrayTreeItems& siblings = parent->GetChildren(); + int index = siblings.Index(i); + wxASSERT( index != NOT_FOUND ); // I'm not a child of my parent? - wxClientDC dc(this); - wxGenericTreeItem *new_child = new wxGenericTreeItem( p, info, &dc ); - if (p) - p->AddChild( new_child ); - else - m_anchor = new_child; - - if (p) - { - CalculatePositions(); + return index == 0 ? NULL : siblings[(size_t)(index - 1)]; +} - if (!p->HasChildren()) p->m_hasChildren = TRUE; +wxTreeItemId wxTreeCtrl::GetFirstVisibleItem() const +{ + wxFAIL_MSG("not implemented"); - int ch = 0; - GetClientSize( (int *) NULL, &ch ); + return NULL; +} - PrepareDC( dc ); - - wxRectangle rect; - rect.x = dc.LogicalToDeviceX( 0 ); - rect.y = 0; - rect.width = 10000; - rect.height = ch; +wxTreeItemId wxTreeCtrl::GetNextVisible(const wxTreeItemId& item) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); - if (p->m_children.Number() == 1) - { - rect.y = dc.LogicalToDeviceY( p->m_y ); - } - else - { - wxNode *node = p->m_children.Member( new_child )->Previous(); - wxGenericTreeItem* last_child = (wxGenericTreeItem*)node->Data(); - rect.y = dc.LogicalToDeviceY( last_child->m_y ); - } + wxFAIL_MSG("not implemented"); - AdjustMyScrollbars(); + return NULL; +} - if (rect.height > 0) Refresh( FALSE, &rect); - } - else - { - AdjustMyScrollbars(); +wxTreeItemId wxTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const +{ + wxCHECK_MSG( item.IsOk(), NULL, "invalid tree item" ); - Refresh(); - } + wxFAIL_MSG("not implemented"); - info.m_mask = oldMask; - return ret; + return NULL; } -bool wxTreeCtrl::ExpandItem( long item, int action ) +// ----------------------------------------------------------------------------- +// operations +// ----------------------------------------------------------------------------- + +wxTreeItemId wxTreeCtrl::DoInsertItem(const wxTreeItemId& parentId, + size_t previous, + const wxString& text, + int image, int selImage, + wxTreeItemData *data) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) - return FALSE; + wxGenericTreeItem *parent = parentId.m_pItem; + if ( !parent ) + { + // should we give a warning here? + return AddRoot(text, image, selImage, data); + } + + wxClientDC dc(this); + wxGenericTreeItem *item = new wxGenericTreeItem(parent, + text, dc, + image, selImage, + data); - switch (action) + if ( data != NULL ) { - case wxTREE_EXPAND_EXPAND: - { - i->SendExpand( this ); - break; - } + data->m_pItem = item; + } - case wxTREE_EXPAND_COLLAPSE_RESET: - case wxTREE_EXPAND_COLLAPSE: - { - wxNode *node = i->m_children.First(); - while (node) - { - wxGenericTreeItem *child = (wxGenericTreeItem*)node->Data(); - if ( child->IsExpanded() ) - ExpandItem( child->m_itemId, wxTREE_EXPAND_COLLAPSE ); - node = node->Next(); - } + parent->Insert( item, previous ); - CalculatePositions(); + CalculatePositions(); - i->SendCollapse( this ); - break; - } + int cw, ch; + GetClientSize( &cw, &ch ); - case wxTREE_EXPAND_TOGGLE: - { - if ( i->IsExpanded() ) - ExpandItem( item, wxTREE_EXPAND_COLLAPSE ); - else - ExpandItem( item, wxTREE_EXPAND_EXPAND ); - return TRUE; - } - } + PrepareDC( dc ); - wxClientDC dc(this); - PrepareDC(dc); - - int cw = 0; - int ch = 0; - GetClientSize( &cw, &ch ); - - wxRect rect; - rect.x = dc.LogicalToDeviceX( 0 ); - rect.width = cw; - rect.y = dc.LogicalToDeviceY( i->m_y ); + wxRectangle rect; + rect.x = dc.LogicalToDeviceX( 0 ); + rect.y = 0; + rect.width = 10000; // @@@ not very elegant... rect.height = ch; - Refresh( TRUE, &rect ); - - AdjustMyScrollbars(); - return TRUE; -} + if ( previous != 0 ) + { + rect.y = dc.LogicalToDeviceY( parent->GetChildren().Item(previous)->GetY() ); + } + else // it's the 1st child + { + rect.y = dc.LogicalToDeviceY( parent->GetY() ); + } -void wxTreeCtrl::DeleteItem( long item ) -{ - wxGenericTreeItem *pItem = FindItem( item ); - wxCHECK_RET( pItem != NULL, _("wxTreeCtrl::DeleteItem: no such pItem.") ); + AdjustMyScrollbars(); - pItem->m_parent->m_children.DeleteObject(pItem); + if ( rect.height > 0 ) + Refresh( FALSE, &rect ); - Refresh(); + return item; } -void wxTreeCtrl::DeleteChildren( long item ) +wxTreeItemId wxTreeCtrl::AddRoot(const wxString& text, + int image, int selImage, + wxTreeItemData *data) { - wxGenericTreeItem *pItem = FindItem( item ); - wxCHECK_RET( pItem != NULL, _("wxTreeCtrl::DeleteChildren: no such pItem.") ); + wxCHECK_MSG( !m_anchor, NULL, "tree can have only one root" ); - pItem->m_children.Clear(); + wxClientDC dc(this); + m_anchor = new wxGenericTreeItem((wxGenericTreeItem *)NULL, text, dc, + image, selImage, data); + if ( data != NULL ) + { + data->m_pItem = m_anchor; + } + AdjustMyScrollbars(); Refresh(); -} -bool wxTreeCtrl::DeleteAllItems() -{ - delete m_anchor; - m_anchor = (wxGenericTreeItem *) NULL; - Refresh(); - return TRUE; + return m_anchor; } -bool wxTreeCtrl::GetItem( wxTreeItem &info ) const +wxTreeItemId wxTreeCtrl::PrependItem(const wxTreeItemId& parent, + const wxString& text, + int image, int selImage, + wxTreeItemData *data) { - wxGenericTreeItem *i = FindItem( info.m_itemId ); - if (!i) return FALSE; - i->GetItem( info ); - return TRUE; + return DoInsertItem(parent, 0u, text, image, selImage, data); } -long wxTreeCtrl::GetItemData( long item ) const +wxTreeItemId wxTreeCtrl::InsertItem(const wxTreeItemId& parentId, + const wxTreeItemId& idPrevious, + const wxString& text, + int image, int selImage, + wxTreeItemData *data) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return 0; - return i->m_data; -} + wxGenericTreeItem *parent = parentId.m_pItem; + if ( !parent ) + { + // should we give a warning here? + return AddRoot(text, image, selImage, data); + } -wxString wxTreeCtrl::GetItemText( long item ) const -{ - wxGenericTreeItem *i = FindItem( item ); - if (!i) return ""; - return i->m_text; + int index = parent->GetChildren().Index(idPrevious.m_pItem); + wxASSERT_MSG( index != NOT_FOUND, + "previous item in wxTreeCtrl::InsertItem() is not a sibling" ); + return DoInsertItem(parentId, (size_t)index, text, image, selImage, data); } -int wxTreeCtrl::GetItemImage(long item) const +wxTreeItemId wxTreeCtrl::AppendItem(const wxTreeItemId& parentId, + const wxString& text, + int image, int selImage, + wxTreeItemData *data) { - wxGenericTreeItem *i = FindItem( item ); - return i == 0 ? -1 : i->GetImage(); + wxGenericTreeItem *parent = parentId.m_pItem; + if ( !parent ) + { + // should we give a warning here? + return AddRoot(text, image, selImage, data); + } + + return DoInsertItem(parent, parent->GetChildren().Count(), text, + image, selImage, data); } -long wxTreeCtrl::GetParent( long item ) const +void wxTreeCtrl::Delete(const wxTreeItemId& itemId) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return -1; - i = i->m_parent; - if (!i) return -1; - return i->m_parent->m_itemId; + wxGenericTreeItem *item = itemId.m_pItem; + + delete item; + + Refresh(); } -long wxTreeCtrl::GetRootItem() const +void wxTreeCtrl::DeleteAllItems() { - if (m_anchor) return m_anchor->m_itemId; - return -1; + if ( m_anchor ) + { + delete m_anchor; + m_anchor = NULL; + + Refresh(); + } } -long wxTreeCtrl::GetChild( long item ) const +void wxTreeCtrl::Expand(const wxTreeItemId& itemId) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return -1; - if (!i->HasChildren()) return -1; - wxNode *node = i->m_children.First(); - i = (wxGenericTreeItem *)node->Data(); - return i->m_itemId; + wxGenericTreeItem *item = itemId.m_pItem; + + if ( item->IsExpanded() ) + return; + + wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_EXPANDING, GetId() ); + event.m_item = item; + event.SetEventObject( this ); + if ( ProcessEvent( event ) && event.m_code ) + { + // cancelled by program + return; + } + + item->Expand(); + + RefreshSubtree(item); + + event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED); + ProcessEvent( event ); } -long wxTreeCtrl::GetNextItem( long item, int code ) const +void wxTreeCtrl::Collapse(const wxTreeItemId& itemId) { - switch (code) + wxGenericTreeItem *item = itemId.m_pItem; + + if ( !item->IsExpanded() ) + return; + + wxTreeEvent event( wxEVT_COMMAND_TREE_ITEM_COLLAPSING, GetId() ); + event.m_item = item; + event.SetEventObject( this ); + if ( ProcessEvent( event ) && event.m_code ) { - case wxTREE_NEXT_CARET: return GetSelection(); - case wxTREE_NEXT_CHILD: return GetChild( item ); - case wxTREE_NEXT_ROOT: return GetRootItem(); - case wxTREE_NEXT_PARENT: return GetParent( item ); - case wxTREE_NEXT_NEXT: - { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return -1; - if (i->m_parent) - { - wxNode *node = i->m_parent->m_children.Member( i ); - if (!node) return -1; - node = node->Next(); - if (!node) return -1; - i = (wxGenericTreeItem *)node->Data(); - return i->m_itemId; - } - break; - } - case wxTREE_NEXT_PREVIOUS: - { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return -1; - if (i->m_parent) - { - wxNode *node = i->m_parent->m_children.Member( i ); - if (!node) return -1; - node = node->Previous(); - if (!node) return -1; - i = (wxGenericTreeItem *)node->Data(); - return i->m_itemId; - } - break; - } + // cancelled by program + return; + } + + item->Collapse(); + + wxArrayTreeItems& children = item->GetChildren(); + size_t count = children.Count(); + for ( size_t n = 0; n < count; n++ ) + { + Collapse(children[n]); } - return -1; + + CalculatePositions(); + + RefreshSubtree(item); + + event.SetEventType(wxEVT_COMMAND_TREE_ITEM_COLLAPSED); + ProcessEvent( event ); } -long wxTreeCtrl::GetSelection() const +void wxTreeCtrl::CollapseAndReset(const wxTreeItemId& item) { - return m_current ? m_current->GetItemId() : -1; + Collapse(item); + Delete(item); } -bool wxTreeCtrl::SelectItem( long itemId ) +void wxTreeCtrl::Toggle(const wxTreeItemId& itemId) { - wxGenericTreeItem *pItem = FindItem(itemId); - if ( !pItem ) { - wxLogDebug(_("Can't select an item %d which doesn't exist."), itemId); + wxGenericTreeItem *item = itemId.m_pItem; - return FALSE; - } - - SelectItem(pItem); + if ( item->IsExpanded() ) + Collapse(itemId); + else + Expand(itemId); +} - return TRUE; +void wxTreeCtrl::Unselect() +{ + if ( m_current ) + { + m_current->SetHilight( FALSE ); + RefreshLine( m_current ); + } } -void wxTreeCtrl::SelectItem(wxGenericTreeItem *item) +void wxTreeCtrl::SelectItem(const wxTreeItemId& itemId) { - if (m_current != item) + wxGenericTreeItem *item = itemId.m_pItem; + + if ( m_current != item ) { - if (m_current) + wxTreeEvent event( wxEVT_COMMAND_TREE_SEL_CHANGING, GetId() ); + event.m_item = item; + event.m_itemOld = m_current; + event.SetEventObject( this ); + if ( ProcessEvent( event ) && event.WasVetoed() ) + return; + + if ( m_current ) { m_current->SetHilight( FALSE ); RefreshLine( m_current ); } + m_current = item; m_current->SetHilight( TRUE ); RefreshLine( m_current ); - m_current->SendSelected( this ); + event.SetEventType(wxEVT_COMMAND_TREE_SEL_CHANGED); + ProcessEvent( event ); } } -bool wxTreeCtrl::ItemHasChildren( long item ) const +void wxTreeCtrl::EnsureVisible(const wxTreeItemId& item) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return FALSE; - return i->m_hasChildren; + wxFAIL_MSG("not implemented"); } -void wxTreeCtrl::SetIndent( int indent ) +void wxTreeCtrl::ScrollTo(const wxTreeItemId& item) { - m_indent = indent; - Refresh(); + wxFAIL_MSG("not implemented"); } -int wxTreeCtrl::GetIndent() const +wxTextCtrl *wxTreeCtrl::EditLabel(const wxTreeItemId& item, + wxClassInfo* textCtrlClass) { - return m_indent; -} + wxFAIL_MSG("not implemented"); -bool wxTreeCtrl::SetItem( wxTreeItem &info ) -{ - wxGenericTreeItem *i = FindItem( info.m_itemId ); - if (!i) return FALSE; - wxClientDC dc(this); - i->SetItem( info, &dc ); - Refresh(); - return TRUE; + return NULL; } -bool wxTreeCtrl::SetItemData( long item, long data ) +wxTextCtrl *wxTreeCtrl::GetEditControl() const { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return FALSE; - i->m_data = data; - return TRUE; -} + wxFAIL_MSG("not implemented"); -bool wxTreeCtrl::SetItemText( long item, const wxString &text ) -{ - wxGenericTreeItem *i = FindItem( item ); - if (!i) return FALSE; - wxClientDC dc(this); - i->SetText( text, &dc ); - return TRUE; + return NULL; } -void wxTreeCtrl::SetItemImage(long item, int image, int imageSel) const +void wxTreeCtrl::EndEditLabel(const wxTreeItemId& item, bool discardChanges) { - wxGenericTreeItem *i = FindItem( item ); - if ( i != 0 ) - { - i->SetImage(image); - i->SetSelectedImage(imageSel); - } + wxFAIL_MSG("not implemented"); } -int wxTreeCtrl::GetItemState( long item, long stateMask ) const +void wxTreeCtrl::SortChildren(const wxTreeItemId& item, + wxTreeItemCmpFunc *cmpFunction) { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return 0; - int ret = 0; - - // Currently, an item is always selected _and_ focussed in wxGTK - - if (stateMask & wxTREE_STATE_FOCUSED) - if (m_current == i) - ret += wxTREE_STATE_FOCUSED; - - if (stateMask & wxTREE_STATE_SELECTED) - if (m_current == i) - ret += wxTREE_STATE_SELECTED; - - if (stateMask & wxTREE_STATE_EXPANDED) - if (i->IsExpanded()) - ret += wxTREE_STATE_EXPANDED; - - return ret; + wxFAIL_MSG("not implemented"); } -bool wxTreeCtrl::SetItemState( long item, long state, long stateMask ) +// ----------------------------------------------------------------------------- +// images are not currently supported, but we still provide stubs for these +// functions +// ----------------------------------------------------------------------------- +wxImageList *wxTreeCtrl::GetImageList() const { - wxGenericTreeItem *i = FindItem( item ); - if (!i) return FALSE; - - if (stateMask & wxTREE_STATE_FOCUSED) - { - if (state & wxTREE_STATE_FOCUSED) - SelectItem( i ); - } - - if (stateMask & wxTREE_STATE_SELECTED) - { - if (state & wxTREE_STATE_SELECTED) - SelectItem( i ); - } - - if (stateMask & wxTREE_STATE_EXPANDED) - { - if (state & wxTREE_STATE_EXPANDED) - ExpandItem( i->m_itemId, wxTREE_EXPAND_EXPAND ); - else - ExpandItem( i->m_itemId, wxTREE_EXPAND_COLLAPSE ); - } - - return TRUE; + return m_imageListNormal; } -long wxTreeCtrl::HitTest( const wxPoint& point, int &flags ) +wxImageList *wxTreeCtrl::GetStateImageList() const { - flags = 0; - if (!m_anchor) return -1; - return m_anchor->HitTest( point, flags ); + return m_imageListState; } -wxImageList *wxTreeCtrl::GetImageList( int which ) const +void wxTreeCtrl::SetImageList(wxImageList *imageList) { - if (which == wxIMAGE_LIST_NORMAL) return m_imageList; - return m_smallImageList; + m_imageListNormal = imageList; } -void wxTreeCtrl::SetImageList( wxImageList *imageList, int which ) +void wxTreeCtrl::SetStateImageList(wxImageList *imageList) { - if (which == wxIMAGE_LIST_NORMAL) - { - if (m_imageList) delete m_imageList; - m_imageList = imageList; - } - else - { - if (m_smallImageList) delete m_smallImageList; - m_smallImageList = imageList; - } + m_imageListState = imageList; } +// ----------------------------------------------------------------------------- +// helpers +// ----------------------------------------------------------------------------- void wxTreeCtrl::AdjustMyScrollbars() { if (m_anchor) @@ -938,16 +852,16 @@ void wxTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int & { int horizX = level*m_indent; - item->m_x = horizX+33; - item->m_y = y-m_lineHeight/3; - item->m_height = m_lineHeight; + item->SetX( horizX+33 ); + item->SetY( y-m_lineHeight/3 ); + item->SetHeight( m_lineHeight ); item->SetCross( horizX+15, y ); int oldY = y; int exposed_x = dc.LogicalToDeviceX( 0 ); - int exposed_y = dc.LogicalToDeviceY( item->m_y-2 ); + int exposed_y = dc.LogicalToDeviceY( item->GetY()-2 ); if (IsExposed( exposed_x, exposed_y, 1000, m_lineHeight+4 )) { @@ -958,74 +872,78 @@ void wxTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level, int & dc.DrawLine( startX, y, endX, y ); - if (item->HasChildren()) - { - dc.DrawLine( horizX+20, y, horizX+30, y ); - dc.SetPen( *wxGREY_PEN ); - dc.DrawRectangle( horizX+10, y-4, 11, 9 ); - dc.SetPen( *wxBLACK_PEN ); - dc.DrawLine( horizX+13, y, horizX+18, y ); - if (item->HasPlus()) - dc.DrawLine( horizX+15, y-2, horizX+15, y+3 ); - } + if (item->HasPlus()) + { + dc.DrawLine( horizX+20, y, horizX+30, y ); + dc.SetPen( *wxGREY_PEN ); + dc.DrawRectangle( horizX+10, y-4, 11, 9 ); + dc.SetPen( *wxBLACK_PEN ); + dc.DrawLine( horizX+13, y, horizX+18, y ); + + if (!item->IsExpanded()) + dc.DrawLine( horizX+15, y-2, horizX+15, y+3 ); + } - if (item->HasHilight()) + if (item->HasHilight()) + { + dc.SetTextForeground( wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT ) ); + dc.SetBrush( *m_hilightBrush ); + long tw, th; + dc.GetTextExtent( item->GetText(), &tw, &th ); + if (m_hasFocus) { - dc.SetTextForeground( wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT ) ); - dc.SetBrush( *m_hilightBrush ); - long tw, th; - dc.GetTextExtent( item->m_text, &tw, &th ); - if (m_hasFocus) - { - dc.SetPen( *wxBLACK_PEN ); - dc.DrawRectangle( item->m_x-2, item->m_y-2, tw+4, th+4 ); - } - else - { - dc.SetPen( *wxTRANSPARENT_PEN ); - dc.DrawRectangle( item->m_x-2, item->m_y-2, tw+4, th+4 ); - } - dc.DrawText( item->m_text, item->m_x, item->m_y ); - dc.SetPen( *wxBLACK_PEN ); - dc.SetTextForeground( *wxBLACK ); - dc.SetBrush( *wxWHITE_BRUSH ); + dc.DrawRectangle( item->GetX()-2, item->GetY()-2, tw+4, th+4 ); } else { - dc.SetBrush( *wxWHITE_BRUSH ); dc.SetPen( *wxTRANSPARENT_PEN ); - long tw, th; - dc.GetTextExtent( item->m_text, &tw, &th ); - dc.DrawRectangle( item->m_x-2, item->m_y-2, tw+4, th+4 ); - dc.DrawText( item->m_text, item->m_x, item->m_y ); - dc.SetPen( *wxBLACK_PEN ); + dc.DrawRectangle( item->GetX()-2, item->GetY()-2, tw+4, th+4 ); } + dc.DrawText( item->GetText(), item->GetX(), item->GetY() ); + + dc.SetPen( *wxBLACK_PEN ); + dc.SetTextForeground( *wxBLACK ); + dc.SetBrush( *wxWHITE_BRUSH ); + } + else + { + dc.SetBrush( *wxWHITE_BRUSH ); + dc.SetPen( *wxTRANSPARENT_PEN ); + long tw, th; + dc.GetTextExtent( item->GetText(), &tw, &th ); + dc.DrawRectangle( item->GetX()-2, item->GetY()-2, tw+4, th+4 ); + dc.DrawText( item->GetText(), item->GetX(), item->GetY() ); + dc.SetPen( *wxBLACK_PEN ); + } } - if (item->NumberOfVisibleChildren() == 0) return; + if ( !item->IsExpanded() ) + return; int semiOldY = y; - wxNode *node = item->m_children.First(); - while (node) + wxArrayTreeItems& children = item->GetChildren(); + size_t count = children.Count(); + for ( size_t n = 0; n < count; n++ ) { - wxGenericTreeItem *child = (wxGenericTreeItem *)node->Data(); - y += m_lineHeight; semiOldY = y; - PaintLevel( child, dc, level+1, y ); - - node = node->Next(); + PaintLevel( children[n], dc, level+1, y ); } dc.DrawLine( horizX+15, oldY+5, horizX+15, semiOldY ); } +// ----------------------------------------------------------------------------- +// wxWindows callbacks +// ----------------------------------------------------------------------------- + void wxTreeCtrl::OnPaint( const wxPaintEvent &WXUNUSED(event) ) { - if (!m_anchor) return; + if ( !m_anchor ) + return; wxPaintDC dc(this); PrepareDC( dc ); @@ -1042,77 +960,86 @@ void wxTreeCtrl::OnPaint( const wxPaintEvent &WXUNUSED(event) ) void wxTreeCtrl::OnSetFocus( const wxFocusEvent &WXUNUSED(event) ) { m_hasFocus = TRUE; - if (m_current) RefreshLine( m_current ); + if ( m_current ) + RefreshLine( m_current ); } void wxTreeCtrl::OnKillFocus( const wxFocusEvent &WXUNUSED(event) ) { m_hasFocus = FALSE; - if (m_current) RefreshLine( m_current ); + if ( m_current ) + RefreshLine( m_current ); } void wxTreeCtrl::OnChar( wxKeyEvent &event ) { + // TODO process '+', '-' (expand/collapse branch) and cursor keys event.Skip(); } void wxTreeCtrl::OnMouse( const wxMouseEvent &event ) { - if (!event.LeftDown() && - !event.LeftDClick()) return; + if ( !(event.LeftDown() || event.LeftDClick()) ) + return; + + if ( !m_anchor ) + return; wxClientDC dc(this); PrepareDC(dc); long x = dc.DeviceToLogicalX( (long)event.GetX() ); long y = dc.DeviceToLogicalY( (long)event.GetY() ); - int flag = 0; - long id = HitTest( wxPoint(x,y), flag ); - if (id == -1) + bool onButton = FALSE; + wxGenericTreeItem *item = m_anchor->HitTest( wxPoint(x,y), onButton ); + if ( item == NULL ) return; - wxGenericTreeItem *item = FindItem( id ); - - if (!item) return; - if ((flag != wxTREE_HITTEST_ONITEMBUTTON) && - (flag != wxTREE_HITTEST_ONITEMLABEL)) return; SelectItem(item); - if (event.LeftDClick()) - m_current->SendKeyDown( this ); + if ( event.LeftDClick() ) + { + wxTreeEvent event( wxEVT_COMMAND_TREE_KEY_DOWN, GetId() ); + event.m_item = item; + event.m_code = 0; + event.SetEventObject( this ); + ProcessEvent( event ); + } - if (flag == wxTREE_HITTEST_ONITEMBUTTON) + if ( onButton ) { - ExpandItem( item->m_itemId, wxTREE_EXPAND_TOGGLE ); - return; + Toggle( item ); } } -void wxTreeCtrl::CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y ) +// ----------------------------------------------------------------------------- +// ----------------------------------------------------------------------------- +void wxTreeCtrl::CalculateLevel( wxGenericTreeItem *item, + wxDC &dc, + int level, + int &y ) { int horizX = level*m_indent; - item->m_x = horizX+33; - item->m_y = y-m_lineHeight/3-2; - item->m_height = m_lineHeight; + item->SetX( horizX+33 ); + item->SetY( y-m_lineHeight/3-2 ); + item->SetHeight( m_lineHeight ); - if (item->NumberOfVisibleChildren() == 0) return; + if ( item->IsExpanded() ) + return; - wxNode *node = item->m_children.First(); - while (node) + wxArrayTreeItems& children = item->GetChildren(); + size_t count = children.Count(); + for ( size_t n = 0; n < count; n++ ) { - wxGenericTreeItem *child = (wxGenericTreeItem *)node->Data(); - y += m_lineHeight; - CalculateLevel( child, dc, level+1, y ); - - node = node->Next(); + CalculateLevel( children[n], dc, level+1, y ); } } void wxTreeCtrl::CalculatePositions() { - if (!m_anchor) + if ( !m_anchor ) return; wxClientDC dc(this); @@ -1127,24 +1054,37 @@ void wxTreeCtrl::CalculatePositions() CalculateLevel( m_anchor, dc, 0, y ); } -wxGenericTreeItem *wxTreeCtrl::FindItem( long itemId ) const +void wxTreeCtrl::RefreshSubtree(wxGenericTreeItem *item) { - if (!m_anchor) return (wxGenericTreeItem *) NULL; - return m_anchor->FindItem( itemId ); + wxClientDC dc(this); + PrepareDC(dc); + + int cw = 0; + int ch = 0; + GetClientSize( &cw, &ch ); + + wxRect rect; + rect.x = dc.LogicalToDeviceX( 0 ); + rect.width = cw; + rect.y = dc.LogicalToDeviceY( item->GetY() ); + rect.height = ch; + + Refresh( TRUE, &rect ); + + AdjustMyScrollbars(); } void wxTreeCtrl::RefreshLine( wxGenericTreeItem *item ) { - if (!item) return; wxClientDC dc(this); PrepareDC( dc ); + wxRect rect; - rect.x = dc.LogicalToDeviceX( item->m_x-2 ); - rect.y = dc.LogicalToDeviceY( item->m_y-2 ); + rect.x = dc.LogicalToDeviceX( item->GetX() - 2 ); + rect.y = dc.LogicalToDeviceY( item->GetY() - 2 ); rect.width = 1000; - rect.height = dc.GetCharHeight()+6; + rect.height = dc.GetCharHeight() + 6; + Refresh( TRUE, &rect ); } - - -- 2.45.2