1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTreeCtrl sample
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation
17 // For compilers that support precompilation, includes "wx/wx.h".
18 #include "wx/wxprec.h"
31 #include "wx/imaglist.h"
32 #include "wx/treectrl.h"
37 //#define NO_MULTIPLE_SELECTION
38 #define NO_VARIABLE_HEIGHT
43 // under Windows the icons are in the .rc file
47 #include "mondrian.xpm"
50 // verify that the item is ok and insult the user if it is not
51 #define CHECK_ITEM( item ) if ( !item.IsOk() ) { \
52 wxMessageBox("Please select some item first!", \
53 "Tree sample error", \
54 wxOK | wxICON_EXCLAMATION, \
59 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
60 EVT_MENU(TreeTest_Quit
, MyFrame::OnQuit
)
61 EVT_MENU(TreeTest_About
, MyFrame::OnAbout
)
62 EVT_MENU(TreeTest_Dump
, MyFrame::OnDump
)
63 #ifndef NO_MULTIPLE_SELECTION
64 EVT_MENU(TreeTest_DumpSelected
, MyFrame::OnDumpSelected
)
65 EVT_MENU(TreeTest_Select
, MyFrame::OnSelect
)
66 EVT_MENU(TreeTest_Unselect
, MyFrame::OnUnselect
)
67 #endif // NO_MULTIPLE_SELECTION
68 EVT_MENU(TreeTest_Rename
, MyFrame::OnRename
)
69 EVT_MENU(TreeTest_Sort
, MyFrame::OnSort
)
70 EVT_MENU(TreeTest_SortRev
, MyFrame::OnSortRev
)
71 EVT_MENU(TreeTest_Bold
, MyFrame::OnSetBold
)
72 EVT_MENU(TreeTest_UnBold
, MyFrame::OnClearBold
)
73 EVT_MENU(TreeTest_Delete
, MyFrame::OnDelete
)
74 EVT_MENU(TreeTest_DeleteChildren
, MyFrame::OnDeleteChildren
)
75 EVT_MENU(TreeTest_DeleteAll
, MyFrame::OnDeleteAll
)
76 EVT_MENU(TreeTest_Recreate
, MyFrame::OnRecreate
)
77 EVT_MENU(TreeTest_CollapseAndReset
, MyFrame::OnCollapseAndReset
)
78 EVT_MENU(TreeTest_EnsureVisible
, MyFrame::OnEnsureVisible
)
79 EVT_MENU(TreeTest_AddItem
, MyFrame::OnAddItem
)
80 EVT_MENU(TreeTest_IncIndent
, MyFrame::OnIncIndent
)
81 EVT_MENU(TreeTest_DecIndent
, MyFrame::OnDecIndent
)
82 EVT_MENU(TreeTest_IncSpacing
, MyFrame::OnIncSpacing
)
83 EVT_MENU(TreeTest_DecSpacing
, MyFrame::OnDecSpacing
)
84 EVT_MENU(TreeTest_ToggleIcon
, MyFrame::OnToggleIcon
)
87 BEGIN_EVENT_TABLE(MyTreeCtrl
, wxTreeCtrl
)
88 EVT_TREE_BEGIN_DRAG(TreeTest_Ctrl
, MyTreeCtrl::OnBeginDrag
)
89 EVT_TREE_BEGIN_RDRAG(TreeTest_Ctrl
, MyTreeCtrl::OnBeginRDrag
)
90 EVT_TREE_BEGIN_LABEL_EDIT(TreeTest_Ctrl
, MyTreeCtrl::OnBeginLabelEdit
)
91 EVT_TREE_END_LABEL_EDIT(TreeTest_Ctrl
, MyTreeCtrl::OnEndLabelEdit
)
92 EVT_TREE_DELETE_ITEM(TreeTest_Ctrl
, MyTreeCtrl::OnDeleteItem
)
93 EVT_TREE_GET_INFO(TreeTest_Ctrl
, MyTreeCtrl::OnGetInfo
)
94 EVT_TREE_SET_INFO(TreeTest_Ctrl
, MyTreeCtrl::OnSetInfo
)
95 EVT_TREE_ITEM_EXPANDED(TreeTest_Ctrl
, MyTreeCtrl::OnItemExpanded
)
96 EVT_TREE_ITEM_EXPANDING(TreeTest_Ctrl
, MyTreeCtrl::OnItemExpanding
)
97 EVT_TREE_ITEM_COLLAPSED(TreeTest_Ctrl
, MyTreeCtrl::OnItemCollapsed
)
98 EVT_TREE_ITEM_COLLAPSING(TreeTest_Ctrl
, MyTreeCtrl::OnItemCollapsing
)
99 EVT_TREE_SEL_CHANGED(TreeTest_Ctrl
, MyTreeCtrl::OnSelChanged
)
100 EVT_TREE_SEL_CHANGING(TreeTest_Ctrl
, MyTreeCtrl::OnSelChanging
)
101 EVT_TREE_KEY_DOWN(TreeTest_Ctrl
, MyTreeCtrl::OnTreeKeyDown
)
102 EVT_TREE_ITEM_ACTIVATED(TreeTest_Ctrl
, MyTreeCtrl::OnItemActivated
)
103 EVT_RIGHT_DCLICK(MyTreeCtrl::OnRMouseDClick
)
110 // Create the main frame window
111 MyFrame
*frame
= new MyFrame("wxTreeCtrl Test", 50, 50, 450, 340);
121 // My frame constructor
122 MyFrame::MyFrame(const wxString
& title
, int x
, int y
, int w
, int h
)
123 : wxFrame((wxFrame
*)NULL
, -1, title
, wxPoint(x
, y
), wxSize(w
, h
))
125 // This reduces flicker effects - even better would be to define
126 // OnEraseBackground to do nothing. When the tree control's scrollbars are
127 // show or hidden, the frame is sent a background erase event.
128 SetBackgroundColour(wxColour(255, 255, 255));
131 SetIcon(wxICON(mondrian
));
134 wxMenu
*file_menu
= new wxMenu
,
135 *tree_menu
= new wxMenu
,
136 *item_menu
= new wxMenu
;
138 file_menu
->Append(TreeTest_About
, "&About...");
139 file_menu
->AppendSeparator();
140 file_menu
->Append(TreeTest_Quit
, "E&xit");
142 tree_menu
->Append(TreeTest_Recreate
, "&Recreate the tree");
143 tree_menu
->Append(TreeTest_CollapseAndReset
, "C&ollapse and reset");
144 tree_menu
->AppendSeparator();
145 tree_menu
->Append(TreeTest_AddItem
, "Append a &new item");
146 tree_menu
->Append(TreeTest_Delete
, "&Delete this item");
147 tree_menu
->Append(TreeTest_DeleteChildren
, "Delete &children");
148 tree_menu
->Append(TreeTest_DeleteAll
, "Delete &all items");
149 tree_menu
->AppendSeparator();
150 tree_menu
->Append(TreeTest_Sort
, "Sort children of current item");
151 tree_menu
->Append(TreeTest_SortRev
, "Sort in reversed order");
152 tree_menu
->AppendSeparator();
153 tree_menu
->Append(TreeTest_EnsureVisible
, "Make the last item &visible");
154 tree_menu
->AppendSeparator();
155 tree_menu
->Append(TreeTest_IncIndent
, "Add 5 points to indentation\tAlt-I");
156 tree_menu
->Append(TreeTest_DecIndent
, "Reduce indentation by 5 points\tAlt-R");
157 tree_menu
->AppendSeparator();
158 tree_menu
->Append(TreeTest_IncSpacing
, "Add 5 points to spacing\tCtrl-I");
159 tree_menu
->Append(TreeTest_DecSpacing
, "Reduce spacing by 5 points\tCtrl-R");
161 item_menu
->Append(TreeTest_Dump
, "&Dump item children");
162 item_menu
->Append(TreeTest_Rename
, "&Rename item...");
164 item_menu
->AppendSeparator();
165 item_menu
->Append(TreeTest_Bold
, "Make item &bold");
166 item_menu
->Append(TreeTest_UnBold
, "Make item ¬ bold");
167 item_menu
->AppendSeparator();
168 item_menu
->Append(TreeTest_ToggleIcon
, "Toggle the items &icon");
170 #ifndef NO_MULTIPLE_SELECTION
171 item_menu
->AppendSeparator();
172 item_menu
->Append(TreeTest_DumpSelected
, "Dump selected items\tAlt-D");
173 item_menu
->Append(TreeTest_Select
, "Select current item\tAlt-S");
174 item_menu
->Append(TreeTest_Unselect
, "Unselect everything\tAlt-U");
177 wxMenuBar
*menu_bar
= new wxMenuBar
;
178 menu_bar
->Append(file_menu
, "&File");
179 menu_bar
->Append(tree_menu
, "&Tree");
180 menu_bar
->Append(item_menu
, "&Item");
181 SetMenuBar(menu_bar
);
183 m_treeCtrl
= new MyTreeCtrl(this, TreeTest_Ctrl
,
184 wxDefaultPosition
, wxDefaultSize
,
188 wxTR_HAS_VARIABLE_ROW_HEIGHT
|
190 wxTextCtrl
*textCtrl
= new wxTextCtrl(this, -1, "",
191 wxDefaultPosition
, wxDefaultSize
,
192 wxTE_MULTILINE
| wxSUNKEN_BORDER
);
194 wxLayoutConstraints
*c
= new wxLayoutConstraints
;
195 c
->top
.SameAs(this, wxTop
);
196 c
->left
.SameAs(this, wxLeft
);
197 c
->right
.SameAs(this, wxRight
);
198 c
->height
.PercentOf(this, wxHeight
, 66);
199 m_treeCtrl
->SetConstraints(c
);
201 c
= new wxLayoutConstraints
;
202 c
->top
.Below(m_treeCtrl
);
203 c
->left
.SameAs(this, wxLeft
);
204 c
->right
.SameAs(this, wxRight
);
205 c
->bottom
.SameAs(this, wxBottom
);
206 textCtrl
->SetConstraints(c
);
209 // create a status bar with 3 panes
211 SetStatusText("", 0);
214 // For some reason, we get a memcpy crash in wxLogStream::DoLogStream
215 // on gcc/wxMotif, if we use wxLogTextCtl. Maybe it's just gcc?
216 delete wxLog::SetActiveTarget(new wxLogStderr
);
218 // set our text control as the log target
219 wxLogTextCtrl
*logWindow
= new wxLogTextCtrl(textCtrl
);
220 delete wxLog::SetActiveTarget(logWindow
);
226 delete wxLog::SetActiveTarget(NULL
);
229 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
234 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
236 wxMessageBox("Tree test sample\n"
237 "(c) Julian Smart 1997, Vadim Zeitlin 1998",
239 wxOK
| wxICON_INFORMATION
, this);
242 void MyFrame::OnRename(wxCommandEvent
& WXUNUSED(event
))
244 wxTreeItemId item
= m_treeCtrl
->GetSelection();
248 // old code - now we edit in place
250 static wxString s_text
;
251 s_text
= wxGetTextFromUser("New name: ", "Tree sample question",
253 if ( !s_text
.IsEmpty() )
255 m_treeCtrl
->SetItemText(item
, s_text
);
259 // TODO demonstrate creating a custom edit control...
260 (void)m_treeCtrl
->EditLabel(item
);
263 void MyFrame::DoSort(bool reverse
)
265 wxTreeItemId item
= m_treeCtrl
->GetSelection();
269 m_treeCtrl
->DoSortChildren(item
, reverse
);
272 void MyFrame::OnDump(wxCommandEvent
& WXUNUSED(event
))
274 wxTreeItemId root
= m_treeCtrl
->GetSelection();
278 m_treeCtrl
->GetItemsRecursively(root
, -1);
281 #ifndef NO_MULTIPLE_SELECTION
283 void MyFrame::OnDumpSelected(wxCommandEvent
& WXUNUSED(event
))
285 wxArrayTreeItemIds array
;
287 size_t count
= m_treeCtrl
->GetSelections(array
);
288 wxLogMessage(_T("%u items selected"), count
);
290 for ( size_t n
= 0; n
< count
; n
++ )
292 wxLogMessage("\t%s", m_treeCtrl
->GetItemText(array
.Item(n
)).c_str());
296 void MyFrame::OnSelect(wxCommandEvent
& event
)
298 m_treeCtrl
->SelectItem(m_treeCtrl
->GetSelection());
301 void MyFrame::OnUnselect(wxCommandEvent
& event
)
303 m_treeCtrl
->UnselectAll();
306 #endif // NO_MULTIPLE_SELECTION
308 void MyFrame::DoSetBold(bool bold
)
310 wxTreeItemId item
= m_treeCtrl
->GetSelection();
314 m_treeCtrl
->SetItemBold(item
, bold
);
317 void MyFrame::OnDelete(wxCommandEvent
& WXUNUSED(event
))
319 wxTreeItemId item
= m_treeCtrl
->GetSelection();
323 m_treeCtrl
->Delete(item
);
326 void MyFrame::OnDeleteChildren(wxCommandEvent
& WXUNUSED(event
))
328 wxTreeItemId item
= m_treeCtrl
->GetSelection();
332 m_treeCtrl
->DeleteChildren(item
);
335 void MyFrame::OnDeleteAll(wxCommandEvent
& WXUNUSED(event
))
337 m_treeCtrl
->DeleteAllItems();
340 void MyFrame::OnRecreate(wxCommandEvent
& event
)
343 m_treeCtrl
->AddTestItemsToTree(3, 2);
346 void MyFrame::OnCollapseAndReset(wxCommandEvent
& event
)
348 m_treeCtrl
->CollapseAndReset(m_treeCtrl
->GetRootItem());
351 void MyFrame::OnEnsureVisible(wxCommandEvent
& event
)
353 m_treeCtrl
->DoEnsureVisible();
356 void MyFrame::OnAddItem(wxCommandEvent
& WXUNUSED(event
))
358 static int s_num
= 0;
361 text
.Printf("Item #%d", ++s_num
);
363 m_treeCtrl
->AppendItem(m_treeCtrl
->GetRootItem(),
365 MyTreeCtrl::TreeCtrlIcon_File */ );
368 void MyFrame::OnIncIndent(wxCommandEvent
& WXUNUSED(event
))
370 unsigned int indent
= m_treeCtrl
->GetIndent();
372 m_treeCtrl
->SetIndent( indent
+5 );
375 void MyFrame::OnDecIndent(wxCommandEvent
& WXUNUSED(event
))
377 unsigned int indent
= m_treeCtrl
->GetIndent();
379 m_treeCtrl
->SetIndent( indent
-5 );
382 void MyFrame::OnIncSpacing(wxCommandEvent
& WXUNUSED(event
))
384 unsigned int indent
= m_treeCtrl
->GetSpacing();
386 m_treeCtrl
->SetSpacing( indent
+5 );
389 void MyFrame::OnDecSpacing(wxCommandEvent
& WXUNUSED(event
))
391 unsigned int indent
= m_treeCtrl
->GetSpacing();
393 m_treeCtrl
->SetSpacing( indent
-5 );
396 void MyFrame::OnToggleIcon(wxCommandEvent
& WXUNUSED(event
))
398 wxTreeItemId item
= m_treeCtrl
->GetSelection();
402 m_treeCtrl
->DoToggleIcon(item
);
405 // MyTreeCtrl implementation
406 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl
, wxTreeCtrl
)
408 MyTreeCtrl::MyTreeCtrl(wxWindow
*parent
, const wxWindowID id
,
409 const wxPoint
& pos
, const wxSize
& size
,
411 : wxTreeCtrl(parent
, id
, pos
, size
, style
)
413 #if (USE_TR_HAS_VARIABLE_ROW_HIGHT && wxUSE_LIBJPEG)
414 wxImage::AddHandler(new wxJPEGHandler
);
417 image
.LoadFile(wxString("horse.jpg"), wxBITMAP_TYPE_JPEG
);
420 m_reverseSort
= FALSE
;
422 // Make an image list containing small icons
423 m_imageListNormal
= new wxImageList(16, 16, TRUE
);
425 // should correspond to TreeCtrlIcon_xxx enum
426 #if defined(__WXMSW__) && defined(__WIN16__)
427 // This is required in 16-bit Windows mode only because we can't load a specific (16x16)
428 // icon image, so it comes out stretched
429 # if USE_TR_HAS_VARIABLE_ROW_HIGHT
430 m_imageListNormal
->Add(image
.ConvertToBitmap());
432 m_imageListNormal
->Add(wxBitmap("bitmap1", wxBITMAP_TYPE_BMP_RESOURCE
));
434 m_imageListNormal
->Add(wxBitmap("bitmap2", wxBITMAP_TYPE_BMP_RESOURCE
));
436 # if USE_TR_HAS_VARIABLE_ROW_HIGHT
437 m_imageListNormal
->Add(image
.ConvertToBitmap());
439 m_imageListNormal
->Add(wxICON(icon1
));
441 m_imageListNormal
->Add(wxICON(icon2
));
444 SetImageList(m_imageListNormal
);
446 // Add some items to the tree
447 AddTestItemsToTree(3, 2);
450 MyTreeCtrl::~MyTreeCtrl()
452 delete m_imageListNormal
;
455 int MyTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
456 const wxTreeItemId
& item2
)
460 // just exchange 1st and 2nd items
461 return wxTreeCtrl::OnCompareItems(item2
, item1
);
465 return wxTreeCtrl::OnCompareItems(item1
, item2
);
469 void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId
& idParent
,
477 for ( size_t n
= 0; n
< numChildren
; n
++ )
479 // at depth 1 elements won't have any more children
481 str
.Printf("%s child %d.%d", "File", folder
, n
+ 1);
483 str
.Printf("%s child %d", "Folder", n
+ 1);
485 int image
= depth
== 1 ? TreeCtrlIcon_File
: TreeCtrlIcon_Folder
;
486 wxTreeItemId id
= AppendItem(idParent
, str
, image
, image
,
487 new MyTreeItemData(str
));
489 // remember the last child for OnEnsureVisible()
490 if ( depth
== 1 && n
== numChildren
- 1 )
495 AddItemsRecursively(id
, numChildren
, depth
- 1, n
+ 1);
501 void MyTreeCtrl::AddTestItemsToTree(size_t numChildren
,
504 wxTreeItemId rootId
= AddRoot("Root",
505 TreeCtrlIcon_Folder
, TreeCtrlIcon_Folder
,
506 new MyTreeItemData("Root item"));
508 AddItemsRecursively(rootId
, numChildren
, depth
, 0);
511 void MyTreeCtrl::GetItemsRecursively(const wxTreeItemId
& idParent
, long cookie
)
516 id
= GetFirstChild(idParent
, cookie
);
518 id
= GetNextChild(idParent
, cookie
);
523 wxString text
= GetItemText(id
);
526 if (ItemHasChildren(id
))
527 GetItemsRecursively(id
,-1);
529 GetItemsRecursively(idParent
, cookie
);
532 void MyTreeCtrl::DoToggleIcon(const wxTreeItemId
& item
)
534 int image
= GetItemImage(item
) == TreeCtrlIcon_Folder
? TreeCtrlIcon_File
535 : TreeCtrlIcon_Folder
;
537 SetItemImage(item
, image
);
542 #define TREE_EVENT_HANDLER(name) \
543 void MyTreeCtrl::name(wxTreeEvent& WXUNUSED(event)) \
545 wxLogMessage(#name); \
548 TREE_EVENT_HANDLER(OnBeginDrag
)
549 TREE_EVENT_HANDLER(OnBeginRDrag
)
550 TREE_EVENT_HANDLER(OnDeleteItem
)
551 TREE_EVENT_HANDLER(OnGetInfo
)
552 TREE_EVENT_HANDLER(OnSetInfo
)
553 TREE_EVENT_HANDLER(OnItemExpanded
)
554 TREE_EVENT_HANDLER(OnItemExpanding
)
555 TREE_EVENT_HANDLER(OnItemCollapsed
)
556 TREE_EVENT_HANDLER(OnSelChanged
)
557 TREE_EVENT_HANDLER(OnSelChanging
)
559 #undef TREE_EVENT_HANDLER
561 void MyTreeCtrl::OnBeginLabelEdit(wxTreeEvent
& event
)
563 wxLogMessage("OnBeginLabelEdit");
565 // for testing, prevent this items label editing
566 wxTreeItemId itemId
= event
.GetItem();
567 if ( IsTestItem(itemId
) )
569 wxMessageBox("You can't edit this item.");
575 void MyTreeCtrl::OnEndLabelEdit(wxTreeEvent
& event
)
577 wxLogMessage("OnEndLabelEdit");
579 // don't allow anything except letters in the labels
580 if ( !event
.GetLabel().IsWord() )
582 wxMessageBox("The label should contain only letters.");
588 void MyTreeCtrl::OnItemCollapsing(wxTreeEvent
& event
)
590 wxLogMessage("OnItemCollapsing");
592 // for testing, prevent the user from collapsing the first child folder
593 wxTreeItemId itemId
= event
.GetItem();
594 if ( IsTestItem(itemId
) )
596 wxMessageBox("You can't collapse this item.");
602 void MyTreeCtrl::OnTreeKeyDown(wxTreeEvent
&WXUNUSED(event
))
604 wxLogMessage("OnTreeKeyDown");
607 void MyTreeCtrl::OnItemActivated(wxTreeEvent
&WXUNUSED(event
))
609 // show some info about this item
610 wxTreeItemId itemId
= GetSelection();
611 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(itemId
);
615 item
->ShowInfo(this);
618 wxLogMessage("OnItemActivated");
621 void MyTreeCtrl::OnRMouseDClick(wxMouseEvent
& event
)
623 wxTreeItemId id
= HitTest(event
.GetPosition());
625 wxLogMessage("No item under mouse");
628 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(id
);
630 wxLogMessage("Item '%s' under mouse", item
->GetDesc());
634 static inline const char *Bool2String(bool b
)
636 return b
? "" : "not ";
639 void MyTreeItemData::ShowInfo(wxTreeCtrl
*tree
)
641 wxLogMessage("Item '%s': %sselected, %sexpanded, %sbold,\n"
642 "%u children (%u immediately under this item).",
644 Bool2String(tree
->IsSelected(GetId())),
645 Bool2String(tree
->IsExpanded(GetId())),
646 Bool2String(tree
->IsBold(GetId())),
647 tree
->GetChildrenCount(GetId()),
648 tree
->GetChildrenCount(GetId(), FALSE
));