1/////////////////////////////////////////////////////////////////////////////
2// Name:        wx/msw/treectrl.h
3// Purpose:     wxTreeCtrl class
4// Author:      Julian Smart
5// Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
6// Created:     01/02/97
7// RCS-ID:      $Id: treectrl.h 49563 2007-10-31 20:46:21Z VZ $
8// Copyright:   (c) Julian Smart
9// Licence:     wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_MSW_TREECTRL_H_
13#define _WX_MSW_TREECTRL_H_
14
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#if wxUSE_TREECTRL
20
21#include "wx/textctrl.h"
22#include "wx/dynarray.h"
23#include "wx/treebase.h"
24#include "wx/hashmap.h"
25
26#ifdef __GNUWIN32__
27    // Cygwin windows.h defines these identifiers
28    #undef GetFirstChild
29    #undef GetNextSibling
30#endif // Cygwin
31
32// fwd decl
33class  WXDLLIMPEXP_FWD_CORE wxImageList;
34class  WXDLLIMPEXP_FWD_CORE wxDragImage;
35struct WXDLLIMPEXP_FWD_CORE wxTreeViewItem;
36
37#if WXWIN_COMPATIBILITY_2_6
38    // NB: all the following flags are for compatbility only and will be removed in the
39    //     next versions
40    // flags for deprecated InsertItem() variant (their values are the same as of
41    // TVI_FIRST and TVI_LAST)
42    #define wxTREE_INSERT_FIRST 0xFFFF0001
43    #define wxTREE_INSERT_LAST  0xFFFF0002
44#endif
45
46// hash storing attributes for our items
47WX_DECLARE_EXPORTED_VOIDPTR_HASH_MAP(wxTreeItemAttr *, wxMapTreeAttr);
48
49// ----------------------------------------------------------------------------
50// wxTreeCtrl
51// ----------------------------------------------------------------------------
52
53class WXDLLEXPORT wxTreeCtrl : public wxTreeCtrlBase
54{
55public:
56    // creation
57    // --------
58    wxTreeCtrl() { Init(); }
59
60    wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
61               const wxPoint& pos = wxDefaultPosition,
62               const wxSize& size = wxDefaultSize,
63               long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
64               const wxValidator& validator = wxDefaultValidator,
65               const wxString& name = wxTreeCtrlNameStr)
66    {
67        Create(parent, id, pos, size, style, validator, name);
68    }
69
70    virtual ~wxTreeCtrl();
71
72    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
73                const wxPoint& pos = wxDefaultPosition,
74                const wxSize& size = wxDefaultSize,
75                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
76                const wxValidator& validator = wxDefaultValidator,
77                const wxString& name = wxTreeCtrlNameStr);
78
79    // implement base class pure virtuals
80    // ----------------------------------
81
82    virtual unsigned int GetCount() const;
83
84    virtual unsigned int GetIndent() const;
85    virtual void SetIndent(unsigned int indent);
86
87    virtual void SetImageList(wxImageList *imageList);
88    virtual void SetStateImageList(wxImageList *imageList);
89
90    virtual wxString GetItemText(const wxTreeItemId& item) const;
91    virtual int GetItemImage(const wxTreeItemId& item,
92                        wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
93    virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
94    virtual wxColour GetItemTextColour(const wxTreeItemId& item) const;
95    virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
96    virtual wxFont GetItemFont(const wxTreeItemId& item) const;
97
98    virtual void SetItemText(const wxTreeItemId& item, const wxString& text);
99    virtual void SetItemImage(const wxTreeItemId& item, int image,
100                      wxTreeItemIcon which = wxTreeItemIcon_Normal);
101    virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
102    virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
103    virtual void SetItemBold(const wxTreeItemId& item, bool bold = true);
104    virtual void SetItemDropHighlight(const wxTreeItemId& item,
105                                      bool highlight = true);
106    virtual void SetItemTextColour(const wxTreeItemId& item,
107                                   const wxColour& col);
108    virtual void SetItemBackgroundColour(const wxTreeItemId& item,
109                                         const wxColour& col);
110    virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font);
111
112    // item status inquiries
113    // ---------------------
114
115    virtual bool IsVisible(const wxTreeItemId& item) const;
116    virtual bool ItemHasChildren(const wxTreeItemId& item) const;
117    virtual bool IsExpanded(const wxTreeItemId& item) const;
118    virtual bool IsSelected(const wxTreeItemId& item) const;
119    virtual bool IsBold(const wxTreeItemId& item) const;
120
121    virtual size_t GetChildrenCount(const wxTreeItemId& item,
122                                    bool recursively = true) const;
123
124    // navigation
125    // ----------
126
127    virtual wxTreeItemId GetRootItem() const;
128    virtual wxTreeItemId GetSelection() const;
129    virtual size_t GetSelections(wxArrayTreeItemIds& selections) const;
130
131    virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
132    virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
133                                       wxTreeItemIdValue& cookie) const;
134    virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
135                                      wxTreeItemIdValue& cookie) const;
136    virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
137
138    virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
139    virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
140
141    virtual wxTreeItemId GetFirstVisibleItem() const;
142    virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
143    virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
144
145    // operations
146    // ----------
147
148    virtual wxTreeItemId AddRoot(const wxString& text,
149                         int image = -1, int selectedImage = -1,
150                         wxTreeItemData *data = NULL);
151
152    virtual void Delete(const wxTreeItemId& item);
153    virtual void DeleteChildren(const wxTreeItemId& item);
154    virtual void DeleteAllItems();
155
156    virtual void Expand(const wxTreeItemId& item);
157    virtual void Collapse(const wxTreeItemId& item);
158    virtual void CollapseAndReset(const wxTreeItemId& item);
159    virtual void Toggle(const wxTreeItemId& item);
160
161    virtual void Unselect();
162    virtual void UnselectAll();
163    virtual void SelectItem(const wxTreeItemId& item, bool select = true);
164
165    virtual void EnsureVisible(const wxTreeItemId& item);
166    virtual void ScrollTo(const wxTreeItemId& item);
167
168    virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
169                          wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
170    virtual wxTextCtrl *GetEditControl() const;
171    virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
172                              bool discardChanges = false)
173    {
174        DoEndEditLabel(discardChanges);
175    }
176
177    virtual void SortChildren(const wxTreeItemId& item);
178
179    virtual bool GetBoundingRect(const wxTreeItemId& item,
180                                 wxRect& rect,
181                                 bool textOnly = false) const;
182
183    // deprecated
184    // ----------
185
186#if WXWIN_COMPATIBILITY_2_4
187    // these methods are deprecated and will be removed in future versions of
188    // wxWidgets, they're here for compatibility only, don't use them in new
189    // code (the comments indicate why these methods are now useless and how to
190    // replace them)
191
192        // use Expand, Collapse, CollapseAndReset or Toggle
193    wxDEPRECATED( void ExpandItem(const wxTreeItemId& item, int action) );
194
195        // use Set/GetImageList and Set/GetStateImageList
196        // Use base class GetImageList()
197    wxDEPRECATED( void SetImageList(wxImageList *imageList, int) );
198
199        // use Set/GetItemImage directly
200    wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const );
201    wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) );
202
203    // use the versions taking wxTreeItemIdValue cookies
204    wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
205                                             long& cookie) const );
206    wxDEPRECATED( wxTreeItemId GetNextChild(const wxTreeItemId& item,
207                                            long& cookie) const );
208#endif // WXWIN_COMPATIBILITY_2_4
209
210
211    // implementation
212    // --------------
213
214    virtual wxVisualAttributes GetDefaultAttributes() const
215    {
216        return GetClassDefaultAttributes(GetWindowVariant());
217    }
218
219    static wxVisualAttributes
220    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
221
222
223    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
224    virtual WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
225    virtual bool MSWCommand(WXUINT param, WXWORD id);
226    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
227    virtual bool MSWShouldPreProcessMessage(WXMSG* msg);
228
229    // override some base class virtuals
230    virtual bool SetBackgroundColour(const wxColour &colour);
231    virtual bool SetForegroundColour(const wxColour &colour);
232
233    // get/set the check state for the item (only for wxTR_MULTIPLE)
234    bool IsItemChecked(const wxTreeItemId& item) const;
235    void SetItemCheck(const wxTreeItemId& item, bool check = true);
236
237    // set/get the item state.image (state == -1 means cycle to the next one)
238    void SetState(const wxTreeItemId& node, int state);
239    int GetState(const wxTreeItemId& node);
240
241protected:
242    // SetImageList helper
243    void SetAnyImageList(wxImageList *imageList, int which);
244
245    // refresh a single item
246    void RefreshItem(const wxTreeItemId& item);
247
248    // end edit label
249    void DoEndEditLabel(bool discardChanges = false);
250
251    virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
252                                      size_t pos,
253                                      const wxString& text,
254                                      int image, int selectedImage,
255                                      wxTreeItemData *data);
256    virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
257                                       const wxTreeItemId& idPrevious,
258                                       const wxString& text,
259                                       int image = -1, int selImage = -1,
260                                       wxTreeItemData *data = NULL);
261    virtual wxTreeItemId DoTreeHitTest(const wxPoint& point, int& flags) const;
262
263    // obtain the user data for the lParam member of TV_ITEM
264    class wxTreeItemParam *GetItemParam(const wxTreeItemId& item) const;
265
266
267    // data used only while editing the item label:
268    wxTextCtrl  *m_textCtrl;        // text control in which it is edited
269    wxTreeItemId m_idEdited;        // the item being edited
270
271private:
272    // the common part of all ctors
273    void Init();
274
275    // helper functions
276    bool DoGetItem(wxTreeViewItem *tvItem) const;
277    void DoSetItem(wxTreeViewItem *tvItem);
278
279    void DoExpand(const wxTreeItemId& item, int flag);
280
281    void DeleteTextCtrl();
282
283    // return true if the item is the hidden root one (i.e. it's the root item
284    // and the tree has wxTR_HIDE_ROOT style)
285    bool IsHiddenRoot(const wxTreeItemId& item) const;
286
287
288    // the hash storing the items attributes (indexed by item ids)
289    wxMapTreeAttr m_attrs;
290
291    // true if the hash above is not empty
292    bool m_hasAnyAttr;
293
294#if wxUSE_DRAGIMAGE
295    // used for dragging
296    wxDragImage *m_dragImage;
297#endif
298
299    // Virtual root item, if wxTR_HIDE_ROOT is set.
300    void* m_pVirtualRoot;
301
302    // the starting item for selection with Shift
303    wxTreeItemId m_htSelStart, m_htClickedItem;
304    wxPoint m_ptClick;
305
306    friend class wxTreeItemIndirectData;
307    friend class wxTreeSortHelper;
308
309    DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
310    DECLARE_NO_COPY_CLASS(wxTreeCtrl)
311};
312
313#endif // wxUSE_TREECTRL
314
315#endif // _WX_MSW_TREECTRL_H_
316