X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d90895ac118ad4546eed7ee4c358a3fe644a1ad7..783e0c6d48080587b9d2c52dfe4d442682119a0d:/include/wx/os2/treectrl.h?ds=sidebyside diff --git a/include/wx/os2/treectrl.h b/include/wx/os2/treectrl.h index 03a386c715..ae2fb5a078 100644 --- a/include/wx/os2/treectrl.h +++ b/include/wx/os2/treectrl.h @@ -1,9 +1,9 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: treectrl.h +// Name: wx/os2/treectrl.h // Purpose: wxTreeCtrl class // Author: David Webster // Modified by: -// Created: 10/17/99 +// Created: 01/23/03 // RCS-ID: $Id$ // Copyright: (c) David Webster // Licence: wxWindows licence @@ -12,14 +12,27 @@ #ifndef _WX_TREECTRL_H_ #define _WX_TREECTRL_H_ +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + +#ifdef __GNUG__ + #pragma interface "treectrl.h" +#endif + +#if wxUSE_TREECTRL + #include "wx/textctrl.h" #include "wx/dynarray.h" +#include "wx/treebase.h" +#include "wx/hashmap.h" // the type for "untyped" data typedef long wxDataType; // fwd decl class WXDLLEXPORT wxImageList; +class WXDLLEXPORT wxDragImage; struct WXDLLEXPORT wxTreeViewItem; // a callback function used for sorting tree items, it should return -1 if the @@ -27,116 +40,12 @@ struct WXDLLEXPORT wxTreeViewItem; // they're equivalent class wxTreeItemData; -// ---------------------------------------------------------------------------- -// constants -// ---------------------------------------------------------------------------- - -// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine -// where exactly the specified point is situated: - // above the client area. -static const int wxTREE_HITTEST_ABOVE = 0x0001; - // below the client area. -static const int wxTREE_HITTEST_BELOW = 0x0002; - // in the client area but below the last item. -static const int wxTREE_HITTEST_NOWHERE = 0x0004; - // on the button associated with an item. -static const int wxTREE_HITTEST_ONITEMBUTTON = 0x0010; - // on the bitmap associated with an item. -static const int wxTREE_HITTEST_ONITEMICON = 0x0020; - // in the indentation associated with an item. -static const int wxTREE_HITTEST_ONITEMINDENT = 0x0040; - // on the label (string) associated with an item. -static const int wxTREE_HITTEST_ONITEMLABEL = 0x0080; - // in the area to the right of an item. -static const int wxTREE_HITTEST_ONITEMRIGHT = 0x0100; - // on the state icon for a tree view item that is in a user-defined state. -static const int wxTREE_HITTEST_ONITEMSTATEICON = 0x0200; - // to the right of the client area. -static const int wxTREE_HITTEST_TOLEFT = 0x0400; - // to the left of the client area. -static const int wxTREE_HITTEST_TORIGHT = 0x0800; - // anywhere on the item -static const int wxTREE_HITTEST_ONITEM = wxTREE_HITTEST_ONITEMICON | - wxTREE_HITTEST_ONITEMLABEL | - wxTREE_HITTEST_ONITEMSTATEICON; - -// NB: all the following flags are for compatbility only and will be removed in the -// next versions - -// flags for deprecated `Expand(int action)' -enum -{ - wxTREE_EXPAND_EXPAND, - wxTREE_EXPAND_COLLAPSE, - wxTREE_EXPAND_COLLAPSE_RESET, - wxTREE_EXPAND_TOGGLE -}; - // flags for deprecated InsertItem() variant #define wxTREE_INSERT_FIRST 0xFFFF0001 #define wxTREE_INSERT_LAST 0xFFFF0002 -// ---------------------------------------------------------------------------- -// wxTreeItemId identifies an element of the tree. In this implementation, it's -// just a trivial wrapper around Win32 HTREEITEM. It's opaque for the -// application. -// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTreeItemId -{ -public: - // ctors - // 0 is invalid value for HTREEITEM - wxTreeItemId() { m_itemId = 0; } - - // default copy ctor/assignment operator are ok for us - - // accessors - // is this a valid tree item? - bool IsOk() const { return m_itemId != 0; } - - // conversion to/from either real (system-dependent) tree item id or - // to "long" which used to be the type for tree item ids in previous - // versions of wxWindows - - // for wxTreeCtrl usage only - wxTreeItemId(WXHTREEITEM itemId) { m_itemId = (long)itemId; } - operator WXHTREEITEM() const { return (WXHTREEITEM)m_itemId; } - - void operator=(WXHTREEITEM item) { m_itemId = (long) item; } - -protected: - long m_itemId; -}; - -WX_DEFINE_EXPORTED_ARRAY(wxTreeItemId, wxArrayTreeItemIds); - -// ---------------------------------------------------------------------------- -// wxTreeItemData is some (arbitrary) user class associated with some item. The -// main advantage of having this class (compared to old untyped interface) is -// that wxTreeItemData's are destroyed automatically by the tree and, as this -// class has virtual dtor, it means that the memory will be automatically -// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because -// the size of this class is critical: in any real application, each tree leaf -// will have wxTreeItemData associated with it and number of leaves may be -// quite big. -// -// Because the objects of this class are deleted by the tree, they should -// always be allocated on the heap! -// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTreeItemData : private wxTreeItemId -{ -public: - // default ctor/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() { } - - // accessors: set/get the item associated with this node - void SetId(const wxTreeItemId& id) { m_itemId = id; } - const wxTreeItemId GetId() const { return *this; } -}; +// hash storing attributes for our items +WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr); // ---------------------------------------------------------------------------- // wxTreeCtrl @@ -148,138 +57,233 @@ public: // -------- 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 = "wxTreeCtrl") + wxTreeCtrl( wxWindow* pParent + ,wxWindowID vId = wxID_ANY + ,const wxPoint& rPos = wxDefaultPosition + ,const wxSize& rSize = wxDefaultSize + ,long lStyle = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT + ,const wxValidator& rValidator = wxDefaultValidator + ,const wxString& rsName = wxTreeCtrlNameStr + ) { - Create(parent, id, pos, size, style, validator, name); + Create( pParent + ,vId + ,rPos + ,rSize + ,lStyle + ,rValidator + ,rsName + ); } - 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 = "wxTreeCtrl"); - - // accessors + bool Create( wxWindow* pParent + ,wxWindowID vId = wxID_ANY + ,const wxPoint& rPos = wxDefaultPosition + ,const wxSize& rSize = wxDefaultSize + ,long lStyle = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT + ,const wxValidator& rValidator = wxDefaultValidator + ,const wxString& rsName = 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; - void SetIndent(unsigned int indent); - - // spacing is the number of pixels between the start and the Text - // not implemented under wxMSW - unsigned int GetSpacing() const { return 18; } // return wxGTK default - void SetSpacing(unsigned int WXUNUSED(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); - + // + + // + // Get the total number of items in the control + // + size_t GetCount(void) 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(void) const; + void SetIndent(unsigned int uIndent); + + // + // Spacing is the number of pixels between the start and the Text + // + unsigned int GetSpacing(void) const { return 18; } // return wxGTK default + void SetSpacing(unsigned int uSpacing) { } + + // + // 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. + // + // OS/2 doesn't really use imagelists as MSW does, but since the MSW + // control is the basis for this one, until I decide how to get rid of + // the need for them they are here for now. + // + wxImageList* GetImageList(void) const; + wxImageList* GetStateImageList(void) const; + + void AssignImageList(wxImageList* pImageList); + void AssignStateImageList(wxImageList* pImageList); + void SetImageList(wxImageList* pImageList); + void SetStateImageList(wxImageList* pImageList); + + // // Functions to work with tree ctrl items. Unfortunately, they can _not_ be // member functions of wxTreeItem because they must know the tree the item // belongs to for Windows implementation and storing the pointer to // wxTreeCtrl in each wxTreeItem is just too much waste. - // accessors - // --------- - - // retrieve items label - wxString GetItemText(const wxTreeItemId& item) const; - // get one of the images associated with the item (normal by default) - int GetItemImage(const wxTreeItemId& item, - wxTreeItemIcon which = wxTreeItemIcon_Normal) 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); - // get one of the images associated with the item (normal by default) - void SetItemImage(const wxTreeItemId& item, int image, - wxTreeItemIcon which = wxTreeItemIcon_Normal); - // 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); - - // the item will be shown with a drop highlight - void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = TRUE); - - // item status inquiries + // + // Item's label + // + wxString GetItemText(const wxTreeItemId& rItem) const; + void SetItemText( const wxTreeItemId& rItem + ,const wxString& rsText + ); + + // + // One of the images associated with the item (normal by default) + // + int GetItemImage( const wxTreeItemId& rItem + ,wxTreeItemIcon vWhich = wxTreeItemIcon_Normal + ) const; + void SetItemImage( const wxTreeItemId& rItem + ,int nImage + ,wxTreeItemIcon vWhich = wxTreeItemIcon_Normal + ); + + // + // Data associated with the item + // + wxTreeItemData* GetItemData(const wxTreeItemId& rItem) const; + void SetItemData( const wxTreeItemId& rItem + ,wxTreeItemData* pData + ); + + // + // Item's text colour + // + wxColour GetItemTextColour(const wxTreeItemId& rItem) const; + void SetItemTextColour( const wxTreeItemId& rItem + ,const wxColour& rColor + ); + + // + // Item's background colour + // + wxColour GetItemBackgroundColour(const wxTreeItemId& rItem) const; + void SetItemBackgroundColour( const wxTreeItemId& rItem + ,const wxColour& rColour + ); + + // + // Item's font + // + wxFont GetItemFont(const wxTreeItemId& rItem) const; + void SetItemFont( const wxTreeItemId& rItem + ,const wxFont& rFont + ); + + // + // 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& rItem + ,bool bHas = true + ); + + // + // The item will be shown in bold + // + void SetItemBold( const wxTreeItemId& rItem + ,bool bBold = true + ); + + // + // The item will be shown with a drop highlight + // + void SetItemDropHighlight( const wxTreeItemId& rItem + ,bool bHighlight = 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; - // is item text in bold font? - bool IsBold(const wxTreeItemId& item) const; - - // number of children + // + + // + // Is the item visible (it might be outside the view or not expanded)? + // + bool IsVisible(const wxTreeItemId& rItem) const; + + // + // Does the item has any children? + // + bool ItemHasChildren(const wxTreeItemId& rItem) const; + + // + // Is the item expanded (only makes sense if HasChildren())? + // + bool IsExpanded(const wxTreeItemId& rItem) const; + + // + // Is this item currently selected (the same as has focus)? + // + bool IsSelected(const wxTreeItemId& rItem) const; + + // + // Is item text in bold font? + // + bool IsBold(const wxTreeItemId& rItem) 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) const; - - // navigation + // + + // + // If 'bRecursively' is false, only immediate children count, otherwise + // the returned number is the number of all items in this branch + // + size_t GetChildrenCount( const wxTreeItemId& rItem + ,bool bRecursively = true + ) const; + + // + // Navigation // ---------- + // - // wxTreeItemId.IsOk() will return FALSE if there is no such item + // + // Get the root tree item + // + wxTreeItemId GetRootItem(void) const; - // get the root tree item - wxTreeItemId GetRootItem() const; + // + // Get the item currently selected (may return NULL if no selection) + // + wxTreeItemId GetSelection(void) const; - // get the item currently selected (may return NULL if no selection) - wxTreeItemId GetSelection() const; + // + // Get the items currently selected, return the number of such item + // + size_t GetSelections(wxArrayTreeItemIds& rSelections) const; - // get the items currently selected, return the number of such item - // - // NB: this operation is expensive and can take a long time for a - // control with a lot of items (~ O(number of items)). - size_t GetSelections(wxArrayTreeItemIds& selections) const; + // + // Get the parent of this item (may return NULL if root) + // + wxTreeItemId GetItemParent(const wxTreeItemId& rItem) const; - // get the parent of this item (may return NULL if root) - wxTreeItemId GetParent(const wxTreeItemId& item) const; +#if WXWIN_COMPATIBILITY_2_2 + // deprecated: Use GetItemParent instead. + wxDEPRECATED( wxTreeItemId GetParent(const wxTreeItemId& item) const); + + // Expose the base class method hidden by the one above. Not deprecatable. + wxWindow *GetParent() const { return wxControl::GetParent(); } +#endif // WXWIN_COMPATIBILITY_2_2 // for this enumeration function you must pass in a "cookie" parameter // which is opaque for the application but is necessary for the library @@ -289,209 +293,415 @@ public: // the same! // get the first child of this item - wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& _cookie) const; + wxTreeItemId GetFirstChild(const wxTreeItemId& item, + wxTreeItemIdValue& 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 + wxTreeItemId GetNextChild(const wxTreeItemId& item, + wxTreeItemIdValue& cookie) const; + + // + // Get the last child of this item - this method doesn't use cookies + // + wxTreeItemId GetLastChild(const wxTreeItemId& rItem) const; + + // + // Get the next sibling of this item + // + wxTreeItemId GetNextSibling(const wxTreeItemId& rItem) const; + + // + // Get the previous sibling + // + wxTreeItemId GetPrevSibling(const wxTreeItemId& rItem) const; + + // + // Get first visible item + // + wxTreeItemId GetFirstVisibleItem(void) const; + + // + // Get the next visible item: item must be visible itself! + // see IsVisible() and wxTreeCtrl::GetFirstVisibleItem() + // + wxTreeItemId GetNextVisible(const wxTreeItemId& rItem) const; + + // + // Get the previous visible item: item must be visible itself! + // + wxTreeItemId GetPrevVisible(const wxTreeItemId& rItem) 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(); - // unselect all items (only makes sense for multiple selection control) - void UnselectAll(); - // 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); - - // 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); - - // helpers + // + + // + // Add the root node to the tree + // + wxTreeItemId AddRoot( const wxString& rsText + ,int nImage = -1 + ,int nSelectedImage = -1 + ,wxTreeItemData* pData = NULL + ); + + // + // Insert a new item in as the first child of the parent + // + wxTreeItemId PrependItem( const wxTreeItemId& rParent + ,const wxString& rsText + ,int nImage = -1 + ,int nSelectedImage = -1 + ,wxTreeItemData* pData = NULL + ); + + // + // Insert a new item after a given one + // + wxTreeItemId InsertItem( const wxTreeItemId& rParent + ,const wxTreeItemId& rIdPrevious + ,const wxString& rsText + ,int nImage = -1 + ,int nSelectedImage = -1 + ,wxTreeItemData* pData = NULL + ); + + // + // Insert a new item before the one with the given index + // + wxTreeItemId InsertItem( const wxTreeItemId& pParent + ,size_t nIndex + ,const wxString& rsText + ,int nImage = -1 + ,int nSelectedImage = -1 + ,wxTreeItemData* pData = NULL + ); + + // + // Insert a new item in as the last child of the parent + // + wxTreeItemId AppendItem( const wxTreeItemId& rParent + ,const wxString& rsText + ,int nImage = -1 + ,int nSelectedImage = -1 + ,wxTreeItemData* pData = NULL + ); + + // + // Delete this item and associated data if any + // + void Delete(const wxTreeItemId& rItem); + + // + // Delete all children (but don't delete the item itself) + // + void DeleteChildren(const wxTreeItemId& rItem); + + // + // Delete all items from the tree + // + void DeleteAllItems(void); + + // + // Expand this item + // + void Expand(const wxTreeItemId& rItem); + + // + // Collapse the item without removing its children + // + void Collapse(const wxTreeItemId& rItem); + + // + // Collapse the item and remove all children + // + void CollapseAndReset(const wxTreeItemId& rItem); + + // + // Toggles the current state + // + void Toggle(const wxTreeItemId& rItem); + + // + // Remove the selection from currently selected item (if any) + // + void Unselect(void); + + // + // Unselect all items (only makes sense for multiple selection control) + // + void UnselectAll(void); + + // + // Select this item + // + void SelectItem(const wxTreeItemId& rItem); + + // + // Make sure this item is visible (expanding the parent item and/or + // scrolling to this item if necessary) + // + void EnsureVisible(const wxTreeItemId& rItem); + + // + // Scroll to this item (but don't expand its parent) + // + void ScrollTo(const wxTreeItemId& rItem); + + // + // OS/2 does not use a separate edit field for editting text. Here for + // interface compatibility, only. + // + wxTextCtrl* EditLabel( const wxTreeItemId& rItem + ,wxClassInfo* pTextCtrlClass = CLASSINFO(wxTextCtrl) + ); + + // + // returns NULL for OS/2 in ALL cases + // + wxTextCtrl* GetEditControl(void) const {return (wxTextCtrl*)NULL;} + + // + // End editing and accept or discard the changes to item label + // + void EndEditLabel( const wxTreeItemId& rItem + ,bool bDiscardChanges = false + ); + + // + // Sorting // ------- - - // determine to which item (if any) belongs the given point (the - // coordinates specified are relative to the client area of tree ctrl) - // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx - // constants. - // - // 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); - - // get the bounding rectangle of the item (or of its label only) - bool GetBoundingRect(const wxTreeItemId& item, - wxRect& rect, - bool textOnly = FALSE) const; - - // deprecated + // + + // + // 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& rItem1 + ,const wxTreeItemId& rItem2 + ); + + // + // Sort the children of this item using OnCompareItems + // + void SortChildren(const wxTreeItemId& rItem); + + // + // Helpers + // ------- + // + + // + // Determine to which item (if any) belongs the given point (the + // coordinates specified are relative to the client area of tree ctrl) + // and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx + // constants. + + // + // 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& rPoint) + { int nDummy = 0; return HitTest(rPoint, nDummy); } + wxTreeItemId HitTest( const wxPoint& rPoint + ,int& rFlags + ); + + // + // Get the bounding rectangle of the item (or of its label only) + // + bool GetBoundingRect( const wxTreeItemId& rItem + ,wxRect& rRect + ,bool bTextOnly = false + ) const; + + // + // Deprecated // ---------- - // these methods are deprecated and will be removed in future versions of - // wxWindows, they're here for compatibility only, don't use them in new +#if WXWIN_COMPATIBILITY_2_4 + // These methods are deprecated and will be removed in future versions of + // wxWidgets, they're here for compatibility only, don't use them in new // code (the comments indicate why these methods are now useless and how to // replace them) - - // use Expand, Collapse, CollapseAndReset or Toggle - void ExpandItem(const wxTreeItemId& item, int action); - - // use AddRoot, PrependItem or AppendItem - wxTreeItemId InsertItem(const wxTreeItemId& parent, - const wxString& text, - int image = -1, int selImage = -1, - long insertAfter = wxTREE_INSERT_LAST); - - // use Set/GetImageList and Set/GetStateImageList - wxImageList *GetImageList(int) const - { return GetImageList(); } - void SetImageList(wxImageList *imageList, int) - { SetImageList(imageList); } - - // use Set/GetItemImage directly - // get the selected item image - int GetItemSelectedImage(const wxTreeItemId& item) const - { return GetItemImage(item, wxTreeItemIcon_Selected); } - // set the selected item image - void SetItemSelectedImage(const wxTreeItemId& item, int image) - { SetItemImage(item, image, wxTreeItemIcon_Selected); } - - // implementation + // + + // + // Use Expand, Collapse, CollapseAndReset or Toggle + // + wxDEPRECATED( void ExpandItem( const wxTreeItemId& rItem + ,int nAction + ) ); + + // + // Use AddRoot, PrependItem or AppendItem + // + wxDEPRECATED( wxTreeItemId InsertItem( const wxTreeItemId& pParent + ,const wxString& rsText + ,int nImage = -1 + ,int nSelImage = -1 + ,long lInsertAfter = wxTREE_INSERT_LAST + ) ); + + // + // Use Set/GetImageList and Set/GetStateImageList + // + wxDEPRECATED( wxImageList* GetImageList(int nVal) const ); + wxDEPRECATED( void SetImageList(wxImageList* pImageList, int nVal) ); + + // + // Use Set/GetItemImage directly + // + wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& rItem) const ); + wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& rItem, int nImage) ); + + // + // 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 + // + wxDEPRECATED( wxTreeItemId GetFirstChild( const wxTreeItemId& rItem + ,long& rCookie + ) const ); + + // + // Get the next child + // + wxDEPRECATED( wxTreeItemId GetNextChild( const wxTreeItemId& rItem + ,long& rCookie + ) const ); +#endif // WXWIN_COMPATIBILITY_2_4 + + // + // Implementation // -------------- - virtual bool OS2Command(WXUINT param, WXWORD id); - virtual bool OS2OnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); - - // get/set the check state for the item (only for wxTR_MULTIPLE) - bool IsItemChecked(const wxTreeItemId& item) const; - void SetItemCheck(const wxTreeItemId& item, bool check = TRUE); + // + + virtual MRESULT OS2WindowProc( WXUINT uMsg + ,WXWPARAM wParam + ,WXLPARAM lParam + ); + virtual bool OS2Command( WXUINT uParam + ,WXWORD wId + ); +// virtual bool OMSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); + + // + // Override some base class virtuals + // + virtual bool SetBackgroundColour(const wxColour& rColour); + virtual bool SetForegroundColour(const wxColour& rColour); + + // + // Get/set the check state for the item (only for wxTR_MULTIPLE) + // + bool IsItemChecked(const wxTreeItemId& rItem) const; + void SetItemCheck( const wxTreeItemId& rItem + ,bool bCheck = true + ); protected: + // // SetImageList helper - void SetAnyImageList(wxImageList *imageList, int which); + // + void SetAnyImageList( wxImageList* pImageList + ,int nWhich + ); - wxTextCtrl *m_textCtrl; // used while editing the item label - wxImageList *m_imageListNormal, // images for tree elements - *m_imageListState; // special images for app defined states - -private: - // the common part of all ctors - void Init(); + // + // Refresh a single item + // + void RefreshItem(const wxTreeItemId& rItem); - // helper functions - inline bool DoGetItem(wxTreeViewItem *tvItem) const; - inline void DoSetItem(wxTreeViewItem *tvItem); + wxImageList* m_pImageListNormal; // images for tree elements + wxImageList* m_pImageListState; // special images for app defined states + bool m_bOwnsImageListNormal; + bool m_bOwnsImageListState; - inline void DoExpand(const wxTreeItemId& item, int flag); - - wxTreeItemId DoInsertItem(const wxTreeItemId& parent, - wxTreeItemId hInsertAfter, - const wxString& text, - int image, int selectedImage, - wxTreeItemData *data); - - int DoGetItemImageFromData(const wxTreeItemId& item, - wxTreeItemIcon which) const; - void DoSetItemImageFromData(const wxTreeItemId& item, - int image, - wxTreeItemIcon which) const; - void DoSetItemImages(const wxTreeItemId& item, int image, int imageSel); - - void DeleteTextCtrl(); +private: - // support for additional item images + // + // The common part of all ctors + // + void Init(void); + + // + // Helper functions + // + inline bool DoGetItem(wxTreeViewItem* pTvItem) const; + inline void DoSetItem(wxTreeViewItem* pTvItem); + + inline void DoExpand( const wxTreeItemId& rItem + ,int nFlag + ); + wxTreeItemId DoInsertItem( const wxTreeItemId& pParent + ,wxTreeItemId hInsertAfter + ,const wxString& rsText + ,int nImage + ,int nSelectedImage + ,wxTreeItemData* pData + ); + int DoGetItemImageFromData( const wxTreeItemId& rItem + ,wxTreeItemIcon vWhich + ) const; + void DoSetItemImageFromData( const wxTreeItemId& rItem + ,int nImage + ,wxTreeItemIcon vWhich + ) const; + void DoSetItemImages( const wxTreeItemId& rItem + ,int nImage + ,int nImageSel + ); + void DeleteTextCtrl() { }; + + // + // support for additional item images which we implement using + // wxTreeItemIndirectData technique - see the comments in msw/treectrl.cpp + // + void SetIndirectItemData( const wxTreeItemId& rItem + ,class wxTreeItemIndirectData* pData + ); + bool HasIndirectData(const wxTreeItemId& rItem) const; + bool IsDataIndirect(wxTreeItemData* pData) const + { return pData && pData->GetId().m_pItem == 0; } + + // + // The hash storing the items attributes (indexed by items ids) + // + wxMapTreeAttr m_vAttrs; + + // + // true if the hash above is not empty + // + bool m_bHasAnyAttr; + + // + // Used for dragging + // + wxDragImage* m_pDragImage; + + // Virtual root item, if wxTR_HIDE_ROOT is set. +// void* m_pVirtualRoot; + + // the starting item for selection with Shift +// WXHTREEITEM m_htSelStart; +// friend class wxTreeItemIndirectData; - void SetIndirectItemData(const wxTreeItemId& item, - wxTreeItemIndirectData *data); - bool HasIndirectData(const wxTreeItemId& item) const; - - wxArrayTreeItemIds m_itemsWithIndirectData; + friend class wxTreeSortHelper; DECLARE_DYNAMIC_CLASS(wxTreeCtrl) -}; + DECLARE_NO_COPY_CLASS(wxTreeCtrl) +}; // end of CLASS wxTreeCtrl + +#endif // wxUSE_TREECTRL #endif // _WX_TREECTRL_H_