X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d4864e971beb14110e16450729bf16e733d79fff..63e2147c8b027645682e0e4cd013a3f30bbd3483:/include/wx/msw/treectrl.h diff --git a/include/wx/msw/treectrl.h b/include/wx/msw/treectrl.h index 83b30bcff9..21f4d1b744 100644 --- a/include/wx/msw/treectrl.h +++ b/include/wx/msw/treectrl.h @@ -69,7 +69,7 @@ public: // -------- wxTreeCtrl() { Init(); } - wxTreeCtrl(wxWindow *parent, wxWindowID id = -1, + wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT, @@ -81,7 +81,7 @@ public: virtual ~wxTreeCtrl(); - bool Create(wxWindow *parent, wxWindowID id = -1, + bool Create(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT, @@ -115,13 +115,13 @@ public: // 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; + virtual wxImageList *GetImageList() const; + virtual wxImageList *GetStateImageList() const; - void SetImageList(wxImageList *imageList); - void SetStateImageList(wxImageList *imageList); - void AssignImageList(wxImageList *imageList); - void AssignStateImageList(wxImageList *imageList); + virtual void SetImageList(wxImageList *imageList); + virtual void SetStateImageList(wxImageList *imageList); + virtual void AssignImageList(wxImageList *imageList); + virtual void AssignStateImageList(wxImageList *imageList); // Functions to work with tree ctrl items. Unfortunately, they can _not_ be // member functions of wxTreeItem because they must know the tree the item @@ -134,7 +134,7 @@ public: // 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, + virtual int GetItemImage(const wxTreeItemId& item, wxTreeItemIcon which = wxTreeItemIcon_Normal) const; // get the data associated with the item wxTreeItemData *GetItemData(const wxTreeItemId& item) const; @@ -154,7 +154,7 @@ public: // 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, + virtual void SetItemImage(const wxTreeItemId& item, int image, wxTreeItemIcon which = wxTreeItemIcon_Normal); // associate some data with the item void SetItemData(const wxTreeItemId& item, wxTreeItemData *data); @@ -163,13 +163,13 @@ public: // 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); + void SetItemHasChildren(const wxTreeItemId& item, bool has = true); // the item will be shown in bold - void SetItemBold(const wxTreeItemId& item, bool bold = TRUE); + 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); + void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true); // set the items text colour void SetItemTextColour(const wxTreeItemId& item, const wxColour& col); @@ -197,15 +197,15 @@ public: // number of children // ------------------ - // if 'recursively' is FALSE, only immediate children count, otherwise + // 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; + bool recursively = true) const; // navigation // ---------- - // wxTreeItemId.IsOk() will return FALSE if there is no such item + // wxTreeItemId.IsOk() will return false if there is no such item // get the root tree item wxTreeItemId GetRootItem() const; @@ -224,10 +224,9 @@ public: #if WXWIN_COMPATIBILITY_2_2 // deprecated: Use GetItemParent instead. - wxTreeItemId GetParent(const wxTreeItemId& item) const - { return GetItemParent( item ); } + wxDEPRECATED( wxTreeItemId GetParent(const wxTreeItemId& item) const); - // Expose the base class method hidden by the one above. + // Expose the base class method hidden by the one above. Not deprecatable. wxWindow *GetParent() const { return wxControl::GetParent(); } #endif // WXWIN_COMPATIBILITY_2_2 @@ -264,32 +263,32 @@ public: // ---------- // add the root node to the tree - wxTreeItemId AddRoot(const wxString& text, + virtual 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, + virtual 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, + virtual wxTreeItemId InsertItem(const wxTreeItemId& parent, const wxTreeItemId& idPrevious, const wxString& text, int image = -1, int selectedImage = -1, wxTreeItemData *data = NULL); // insert a new item before the one with the given index - wxTreeItemId InsertItem(const wxTreeItemId& parent, + virtual wxTreeItemId InsertItem(const wxTreeItemId& parent, size_t index, 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, + virtual wxTreeItemId AppendItem(const wxTreeItemId& parent, const wxString& text, int image = -1, int selectedImage = -1, wxTreeItemData *data = NULL); @@ -317,7 +316,12 @@ public: // unselect all items (only makes sense for multiple selection control) void UnselectAll(); // select this item - void SelectItem(const wxTreeItemId& item); + void SelectItem(const wxTreeItemId& item, bool select = true); + // unselect this item + void UnselectItem(const wxTreeItemId& item); + // toggle item selection + void ToggleItemSelection(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); @@ -335,7 +339,11 @@ public: // edited simultaneously) wxTextCtrl* GetEditControl() const; // end editing and accept or discard the changes to item label - void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE); + void EndEditLabel(const wxTreeItemId& WXUNUSED(item), + bool discardChanges = false) + { + DoEndEditLabel(discardChanges); + } // sorting // this function is called to compare 2 items and should return -1, 0 @@ -366,14 +374,14 @@ public: // get the bounding rectangle of the item (or of its label only) bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, - bool textOnly = FALSE) const; + bool textOnly = false) const; // deprecated // ---------- #if WXWIN_COMPATIBILITY_2_4 // 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 + // 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) @@ -387,14 +395,12 @@ public: long insertAfter = wxTREE_INSERT_LAST) ); // use Set/GetImageList and Set/GetStateImageList - wxImageList *GetImageList(int) const { return GetImageList(); } - void SetImageList(wxImageList *imageList, int) { SetImageList(imageList); } + wxDEPRECATED( wxImageList *GetImageList(int) const ); + wxDEPRECATED( void SetImageList(wxImageList *imageList, int) ); // use Set/GetItemImage directly - int GetItemSelectedImage(const wxTreeItemId& item) const - { return GetItemImage(item, wxTreeItemIcon_Selected); } - void SetItemSelectedImage(const wxTreeItemId& item, int image) - { SetItemImage(item, image, wxTreeItemIcon_Selected); } + wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const ); + wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) ); // use the versions taking wxTreeItemIdValue cookies wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item, @@ -403,12 +409,22 @@ public: long& cookie) const ); #endif // WXWIN_COMPATIBILITY_2_4 - virtual bool ShouldInheritColours() const { return false; } // implementation // -------------- - virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); + virtual bool ShouldInheritColours() const { return false; } + + virtual wxVisualAttributes GetDefaultAttributes() const + { + return GetClassDefaultAttributes(GetWindowVariant()); + } + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); + + + virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); virtual bool MSWCommand(WXUINT param, WXWORD id); virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); @@ -418,7 +434,7 @@ public: // 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); + void SetItemCheck(const wxTreeItemId& item, bool check = true); // set/get the item state.image (state == -1 means cycle to the next one) void SetState(const wxTreeItemId& node, int state); @@ -431,10 +447,18 @@ protected: // refresh a single item void RefreshItem(const wxTreeItemId& item); - wxTextCtrl *m_textCtrl; // used while editing the item label + // end edit label + void DoEndEditLabel(bool discardChanges = false); + + + // data used only while editing the item label: + wxTextCtrl *m_textCtrl; // text control in which it is edited + wxTreeItemId m_idEdited; // the item being edited + wxImageList *m_imageListNormal, // images for tree elements *m_imageListState; // special images for app defined states - bool m_ownsImageListNormal, m_ownsImageListState; + bool m_ownsImageListNormal, + m_ownsImageListState; private: // the common part of all ctors @@ -472,7 +496,7 @@ private: // the hash storing the items attributes (indexed by item ids) wxMapTreeAttr m_attrs; - // TRUE if the hash above is not empty + // true if the hash above is not empty bool m_hasAnyAttr; // used for dragging