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 // comment out this line to test multiple selection even under MSW (where
38 // it looks ugly - but works)
39 #define NO_MULTIPLE_SELECTION
42 #define NO_VARIABLE_HEIGHT
46 // under Windows the icons are in the .rc file
53 #include "mondrian.xpm"
56 // verify that the item is ok and insult the user if it is not
57 #define CHECK_ITEM( item ) if ( !item.IsOk() ) { \
58 wxMessageBox("Please select some item first!", \
59 "Tree sample error", \
60 wxOK | wxICON_EXCLAMATION, \
65 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
66 EVT_MENU(TreeTest_Quit
, MyFrame::OnQuit
)
67 EVT_MENU(TreeTest_About
, MyFrame::OnAbout
)
68 EVT_MENU(TreeTest_Dump
, MyFrame::OnDump
)
69 #ifndef NO_MULTIPLE_SELECTION
70 EVT_MENU(TreeTest_DumpSelected
, MyFrame::OnDumpSelected
)
71 EVT_MENU(TreeTest_Select
, MyFrame::OnSelect
)
72 EVT_MENU(TreeTest_Unselect
, MyFrame::OnUnselect
)
73 #endif // NO_MULTIPLE_SELECTION
74 EVT_MENU(TreeTest_Rename
, MyFrame::OnRename
)
75 EVT_MENU(TreeTest_Sort
, MyFrame::OnSort
)
76 EVT_MENU(TreeTest_SortRev
, MyFrame::OnSortRev
)
77 EVT_MENU(TreeTest_Bold
, MyFrame::OnSetBold
)
78 EVT_MENU(TreeTest_UnBold
, MyFrame::OnClearBold
)
79 EVT_MENU(TreeTest_Delete
, MyFrame::OnDelete
)
80 EVT_MENU(TreeTest_DeleteChildren
, MyFrame::OnDeleteChildren
)
81 EVT_MENU(TreeTest_DeleteAll
, MyFrame::OnDeleteAll
)
82 EVT_MENU(TreeTest_Recreate
, MyFrame::OnRecreate
)
83 EVT_MENU(TreeTest_CollapseAndReset
, MyFrame::OnCollapseAndReset
)
84 EVT_MENU(TreeTest_EnsureVisible
, MyFrame::OnEnsureVisible
)
85 EVT_MENU(TreeTest_AddItem
, MyFrame::OnAddItem
)
86 EVT_MENU(TreeTest_IncIndent
, MyFrame::OnIncIndent
)
87 EVT_MENU(TreeTest_DecIndent
, MyFrame::OnDecIndent
)
88 EVT_MENU(TreeTest_IncSpacing
, MyFrame::OnIncSpacing
)
89 EVT_MENU(TreeTest_DecSpacing
, MyFrame::OnDecSpacing
)
90 EVT_MENU(TreeTest_ToggleIcon
, MyFrame::OnToggleIcon
)
93 BEGIN_EVENT_TABLE(MyTreeCtrl
, wxTreeCtrl
)
94 EVT_TREE_BEGIN_DRAG(TreeTest_Ctrl
, MyTreeCtrl::OnBeginDrag
)
95 EVT_TREE_BEGIN_RDRAG(TreeTest_Ctrl
, MyTreeCtrl::OnBeginRDrag
)
96 EVT_TREE_BEGIN_LABEL_EDIT(TreeTest_Ctrl
, MyTreeCtrl::OnBeginLabelEdit
)
97 EVT_TREE_END_LABEL_EDIT(TreeTest_Ctrl
, MyTreeCtrl::OnEndLabelEdit
)
98 EVT_TREE_DELETE_ITEM(TreeTest_Ctrl
, MyTreeCtrl::OnDeleteItem
)
99 #if 0 // there are so many of those that logging them causes flicker
100 EVT_TREE_GET_INFO(TreeTest_Ctrl
, MyTreeCtrl::OnGetInfo
)
102 EVT_TREE_SET_INFO(TreeTest_Ctrl
, MyTreeCtrl::OnSetInfo
)
103 EVT_TREE_ITEM_EXPANDED(TreeTest_Ctrl
, MyTreeCtrl::OnItemExpanded
)
104 EVT_TREE_ITEM_EXPANDING(TreeTest_Ctrl
, MyTreeCtrl::OnItemExpanding
)
105 EVT_TREE_ITEM_COLLAPSED(TreeTest_Ctrl
, MyTreeCtrl::OnItemCollapsed
)
106 EVT_TREE_ITEM_COLLAPSING(TreeTest_Ctrl
, MyTreeCtrl::OnItemCollapsing
)
107 EVT_TREE_SEL_CHANGED(TreeTest_Ctrl
, MyTreeCtrl::OnSelChanged
)
108 EVT_TREE_SEL_CHANGING(TreeTest_Ctrl
, MyTreeCtrl::OnSelChanging
)
109 EVT_TREE_KEY_DOWN(TreeTest_Ctrl
, MyTreeCtrl::OnTreeKeyDown
)
110 EVT_TREE_ITEM_ACTIVATED(TreeTest_Ctrl
, MyTreeCtrl::OnItemActivated
)
111 EVT_RIGHT_DCLICK(MyTreeCtrl::OnRMouseDClick
)
118 // Create the main frame window
119 MyFrame
*frame
= new MyFrame("wxTreeCtrl Test", 50, 50, 450, 340);
129 // My frame constructor
130 MyFrame::MyFrame(const wxString
& title
, int x
, int y
, int w
, int h
)
131 : wxFrame((wxFrame
*)NULL
, -1, title
, wxPoint(x
, y
), wxSize(w
, h
))
133 // This reduces flicker effects - even better would be to define
134 // OnEraseBackground to do nothing. When the tree control's scrollbars are
135 // show or hidden, the frame is sent a background erase event.
136 SetBackgroundColour(wxColour(255, 255, 255));
139 SetIcon(wxICON(mondrian
));
142 wxMenu
*file_menu
= new wxMenu
,
143 *tree_menu
= new wxMenu
,
144 *item_menu
= new wxMenu
;
146 file_menu
->Append(TreeTest_About
, "&About...");
147 file_menu
->AppendSeparator();
148 file_menu
->Append(TreeTest_Quit
, "E&xit");
150 tree_menu
->Append(TreeTest_Recreate
, "&Recreate the tree");
151 tree_menu
->Append(TreeTest_CollapseAndReset
, "C&ollapse and reset");
152 tree_menu
->AppendSeparator();
153 tree_menu
->Append(TreeTest_AddItem
, "Append a &new item");
154 tree_menu
->Append(TreeTest_Delete
, "&Delete this item");
155 tree_menu
->Append(TreeTest_DeleteChildren
, "Delete &children");
156 tree_menu
->Append(TreeTest_DeleteAll
, "Delete &all items");
157 tree_menu
->AppendSeparator();
158 tree_menu
->Append(TreeTest_Sort
, "Sort children of current item");
159 tree_menu
->Append(TreeTest_SortRev
, "Sort in reversed order");
160 tree_menu
->AppendSeparator();
161 tree_menu
->Append(TreeTest_EnsureVisible
, "Make the last item &visible");
162 tree_menu
->AppendSeparator();
163 tree_menu
->Append(TreeTest_IncIndent
, "Add 5 points to indentation\tAlt-I");
164 tree_menu
->Append(TreeTest_DecIndent
, "Reduce indentation by 5 points\tAlt-R");
165 tree_menu
->AppendSeparator();
166 tree_menu
->Append(TreeTest_IncSpacing
, "Add 5 points to spacing\tCtrl-I");
167 tree_menu
->Append(TreeTest_DecSpacing
, "Reduce spacing by 5 points\tCtrl-R");
169 item_menu
->Append(TreeTest_Dump
, "&Dump item children");
170 item_menu
->Append(TreeTest_Rename
, "&Rename item...");
172 item_menu
->AppendSeparator();
173 item_menu
->Append(TreeTest_Bold
, "Make item &bold");
174 item_menu
->Append(TreeTest_UnBold
, "Make item ¬ bold");
175 item_menu
->AppendSeparator();
176 item_menu
->Append(TreeTest_ToggleIcon
, "Toggle the items &icon");
178 #ifndef NO_MULTIPLE_SELECTION
179 item_menu
->AppendSeparator();
180 item_menu
->Append(TreeTest_DumpSelected
, "Dump selected items\tAlt-D");
181 item_menu
->Append(TreeTest_Select
, "Select current item\tAlt-S");
182 item_menu
->Append(TreeTest_Unselect
, "Unselect everything\tAlt-U");
185 wxMenuBar
*menu_bar
= new wxMenuBar
;
186 menu_bar
->Append(file_menu
, "&File");
187 menu_bar
->Append(tree_menu
, "&Tree");
188 menu_bar
->Append(item_menu
, "&Item");
189 SetMenuBar(menu_bar
);
191 m_treeCtrl
= new MyTreeCtrl(this, TreeTest_Ctrl
,
192 wxDefaultPosition
, wxDefaultSize
,
195 #ifndef NO_MULTIPLE_SELECTION
198 #ifndef NO_VARIABLE_HEIGHT
199 wxTR_HAS_VARIABLE_ROW_HEIGHT
|
202 wxTextCtrl
*textCtrl
= new wxTextCtrl(this, -1, "",
203 wxDefaultPosition
, wxDefaultSize
,
204 wxTE_MULTILINE
| wxSUNKEN_BORDER
);
206 wxLayoutConstraints
*c
= new wxLayoutConstraints
;
207 c
->top
.SameAs(this, wxTop
);
208 c
->left
.SameAs(this, wxLeft
);
209 c
->right
.SameAs(this, wxRight
);
210 c
->height
.PercentOf(this, wxHeight
, 66);
211 m_treeCtrl
->SetConstraints(c
);
213 c
= new wxLayoutConstraints
;
214 c
->top
.Below(m_treeCtrl
);
215 c
->left
.SameAs(this, wxLeft
);
216 c
->right
.SameAs(this, wxRight
);
217 c
->bottom
.SameAs(this, wxBottom
);
218 textCtrl
->SetConstraints(c
);
221 // create a status bar with 3 panes
223 SetStatusText("", 0);
226 // For some reason, we get a memcpy crash in wxLogStream::DoLogStream
227 // on gcc/wxMotif, if we use wxLogTextCtl. Maybe it's just gcc?
228 delete wxLog::SetActiveTarget(new wxLogStderr
);
230 // set our text control as the log target
231 wxLogTextCtrl
*logWindow
= new wxLogTextCtrl(textCtrl
);
232 delete wxLog::SetActiveTarget(logWindow
);
238 delete wxLog::SetActiveTarget(NULL
);
241 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
246 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
248 wxMessageBox("Tree test sample\n"
249 "(c) Julian Smart 1997, Vadim Zeitlin 1998",
251 wxOK
| wxICON_INFORMATION
, this);
254 void MyFrame::OnRename(wxCommandEvent
& WXUNUSED(event
))
256 wxTreeItemId item
= m_treeCtrl
->GetSelection();
260 // old code - now we edit in place
262 static wxString s_text
;
263 s_text
= wxGetTextFromUser("New name: ", "Tree sample question",
265 if ( !s_text
.IsEmpty() )
267 m_treeCtrl
->SetItemText(item
, s_text
);
271 // TODO demonstrate creating a custom edit control...
272 (void)m_treeCtrl
->EditLabel(item
);
275 void MyFrame::DoSort(bool reverse
)
277 wxTreeItemId item
= m_treeCtrl
->GetSelection();
281 m_treeCtrl
->DoSortChildren(item
, reverse
);
284 void MyFrame::OnDump(wxCommandEvent
& WXUNUSED(event
))
286 wxTreeItemId root
= m_treeCtrl
->GetSelection();
290 m_treeCtrl
->GetItemsRecursively(root
, -1);
293 #ifndef NO_MULTIPLE_SELECTION
295 void MyFrame::OnDumpSelected(wxCommandEvent
& WXUNUSED(event
))
297 wxArrayTreeItemIds array
;
299 size_t count
= m_treeCtrl
->GetSelections(array
);
300 wxLogMessage(_T("%u items selected"), count
);
302 for ( size_t n
= 0; n
< count
; n
++ )
304 wxLogMessage("\t%s", m_treeCtrl
->GetItemText(array
.Item(n
)).c_str());
308 void MyFrame::OnSelect(wxCommandEvent
& event
)
310 m_treeCtrl
->SelectItem(m_treeCtrl
->GetSelection());
313 void MyFrame::OnUnselect(wxCommandEvent
& event
)
315 m_treeCtrl
->UnselectAll();
318 #endif // NO_MULTIPLE_SELECTION
320 void MyFrame::DoSetBold(bool bold
)
322 wxTreeItemId item
= m_treeCtrl
->GetSelection();
326 m_treeCtrl
->SetItemBold(item
, bold
);
329 void MyFrame::OnDelete(wxCommandEvent
& WXUNUSED(event
))
331 wxTreeItemId item
= m_treeCtrl
->GetSelection();
335 m_treeCtrl
->Delete(item
);
338 void MyFrame::OnDeleteChildren(wxCommandEvent
& WXUNUSED(event
))
340 wxTreeItemId item
= m_treeCtrl
->GetSelection();
344 m_treeCtrl
->DeleteChildren(item
);
347 void MyFrame::OnDeleteAll(wxCommandEvent
& WXUNUSED(event
))
349 m_treeCtrl
->DeleteAllItems();
352 void MyFrame::OnRecreate(wxCommandEvent
& event
)
355 m_treeCtrl
->AddTestItemsToTree(3, 2);
358 void MyFrame::OnCollapseAndReset(wxCommandEvent
& event
)
360 m_treeCtrl
->CollapseAndReset(m_treeCtrl
->GetRootItem());
363 void MyFrame::OnEnsureVisible(wxCommandEvent
& event
)
365 m_treeCtrl
->DoEnsureVisible();
368 void MyFrame::OnAddItem(wxCommandEvent
& WXUNUSED(event
))
370 static int s_num
= 0;
373 text
.Printf("Item #%d", ++s_num
);
375 m_treeCtrl
->AppendItem(m_treeCtrl
->GetRootItem(),
377 MyTreeCtrl::TreeCtrlIcon_File */ );
380 void MyFrame::OnIncIndent(wxCommandEvent
& WXUNUSED(event
))
382 unsigned int indent
= m_treeCtrl
->GetIndent();
384 m_treeCtrl
->SetIndent( indent
+5 );
387 void MyFrame::OnDecIndent(wxCommandEvent
& WXUNUSED(event
))
389 unsigned int indent
= m_treeCtrl
->GetIndent();
391 m_treeCtrl
->SetIndent( indent
-5 );
394 void MyFrame::OnIncSpacing(wxCommandEvent
& WXUNUSED(event
))
396 unsigned int indent
= m_treeCtrl
->GetSpacing();
398 m_treeCtrl
->SetSpacing( indent
+5 );
401 void MyFrame::OnDecSpacing(wxCommandEvent
& WXUNUSED(event
))
403 unsigned int indent
= m_treeCtrl
->GetSpacing();
405 m_treeCtrl
->SetSpacing( indent
-5 );
408 void MyFrame::OnToggleIcon(wxCommandEvent
& WXUNUSED(event
))
410 wxTreeItemId item
= m_treeCtrl
->GetSelection();
414 m_treeCtrl
->DoToggleIcon(item
);
417 // MyTreeCtrl implementation
418 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl
, wxTreeCtrl
)
420 MyTreeCtrl::MyTreeCtrl(wxWindow
*parent
, const wxWindowID id
,
421 const wxPoint
& pos
, const wxSize
& size
,
423 : wxTreeCtrl(parent
, id
, pos
, size
, style
)
425 #ifndef NO_VARIABLE_HEIGHT
427 wxImage::AddHandler(new wxJPEGHandler
);
430 image
.LoadFile(wxString("horse.jpg"), wxBITMAP_TYPE_JPEG
);
434 m_reverseSort
= FALSE
;
436 // Make an image list containing small icons
437 m_imageListNormal
= new wxImageList(16, 16, TRUE
);
439 // should correspond to TreeCtrlIcon_xxx enum
440 #if defined(__WXMSW__) && defined(__WIN16__)
441 // This is required in 16-bit Windows mode only because we can't load a specific (16x16)
442 // icon image, so it comes out stretched
443 # ifndef NO_VARIABLE_HEIGHT
444 m_imageListNormal
->Add(image
.ConvertToBitmap());
446 m_imageListNormal
->Add(wxBitmap("bitmap1", wxBITMAP_TYPE_BMP_RESOURCE
));
448 m_imageListNormal
->Add(wxBitmap("bitmap2", wxBITMAP_TYPE_BMP_RESOURCE
));
449 m_imageListNormal
->Add(wxBitmap("bitmap3", wxBITMAP_TYPE_BMP_RESOURCE
));
450 m_imageListNormal
->Add(wxBitmap("bitmap4", wxBITMAP_TYPE_BMP_RESOURCE
));
451 m_imageListNormal
->Add(wxBitmap("bitmap5", wxBITMAP_TYPE_BMP_RESOURCE
));
453 # ifndef NO_VARIABLE_HEIGHT
454 m_imageListNormal
->Add(image
.ConvertToBitmap());
456 m_imageListNormal
->Add(wxICON(icon1
));
458 m_imageListNormal
->Add(wxICON(icon2
));
459 m_imageListNormal
->Add(wxICON(icon3
));
460 m_imageListNormal
->Add(wxICON(icon4
));
461 m_imageListNormal
->Add(wxICON(icon5
));
464 SetImageList(m_imageListNormal
);
466 // Add some items to the tree
467 AddTestItemsToTree(3, 2);
470 MyTreeCtrl::~MyTreeCtrl()
472 delete m_imageListNormal
;
475 int MyTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
476 const wxTreeItemId
& item2
)
480 // just exchange 1st and 2nd items
481 return wxTreeCtrl::OnCompareItems(item2
, item1
);
485 return wxTreeCtrl::OnCompareItems(item1
, item2
);
489 void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId
& idParent
,
496 bool hasChildren
= depth
> 1;
499 for ( size_t n
= 0; n
< numChildren
; n
++ )
501 // at depth 1 elements won't have any more children
503 str
.Printf("%s child %d", "Folder", n
+ 1);
505 str
.Printf("%s child %d.%d", "File", folder
, n
+ 1);
507 // here we pass to AppendItem() normal and selected item images (we
508 // suppose that selected image follows the normal one in the enum)
509 int image
= depth
== 1 ? TreeCtrlIcon_File
: TreeCtrlIcon_Folder
;
510 wxTreeItemId id
= AppendItem(idParent
, str
, image
, image
+ 1,
511 new MyTreeItemData(str
));
513 // and now we also set the expanded one (only for the folders)
516 SetItemImage(id
, TreeCtrlIcon_FolderOpened
,
517 wxTreeItemIcon_Expanded
);
520 // remember the last child for OnEnsureVisible()
521 if ( !hasChildren
&& n
== numChildren
- 1 )
526 AddItemsRecursively(id
, numChildren
, depth
- 1, n
+ 1);
532 void MyTreeCtrl::AddTestItemsToTree(size_t numChildren
,
535 wxTreeItemId rootId
= AddRoot("Root",
536 TreeCtrlIcon_Folder
, TreeCtrlIcon_Folder
,
537 new MyTreeItemData("Root item"));
538 SetItemImage(rootId
, TreeCtrlIcon_FolderOpened
, wxTreeItemIcon_Expanded
);
540 AddItemsRecursively(rootId
, numChildren
, depth
, 0);
543 void MyTreeCtrl::GetItemsRecursively(const wxTreeItemId
& idParent
, long cookie
)
548 id
= GetFirstChild(idParent
, cookie
);
550 id
= GetNextChild(idParent
, cookie
);
555 wxString text
= GetItemText(id
);
558 if (ItemHasChildren(id
))
559 GetItemsRecursively(id
,-1);
561 GetItemsRecursively(idParent
, cookie
);
564 void MyTreeCtrl::DoToggleIcon(const wxTreeItemId
& item
)
566 int image
= GetItemImage(item
) == TreeCtrlIcon_Folder
? TreeCtrlIcon_File
567 : TreeCtrlIcon_Folder
;
569 SetItemImage(item
, image
);
574 #define TREE_EVENT_HANDLER(name) \
575 void MyTreeCtrl::name(wxTreeEvent& WXUNUSED(event)) \
577 wxLogMessage(#name); \
580 TREE_EVENT_HANDLER(OnBeginDrag
)
581 TREE_EVENT_HANDLER(OnBeginRDrag
)
582 TREE_EVENT_HANDLER(OnDeleteItem
)
583 TREE_EVENT_HANDLER(OnGetInfo
)
584 TREE_EVENT_HANDLER(OnSetInfo
)
585 TREE_EVENT_HANDLER(OnItemExpanded
)
586 TREE_EVENT_HANDLER(OnItemExpanding
)
587 TREE_EVENT_HANDLER(OnItemCollapsed
)
588 TREE_EVENT_HANDLER(OnSelChanged
)
589 TREE_EVENT_HANDLER(OnSelChanging
)
591 #undef TREE_EVENT_HANDLER
593 void MyTreeCtrl::OnBeginLabelEdit(wxTreeEvent
& event
)
595 wxLogMessage("OnBeginLabelEdit");
597 // for testing, prevent this items label editing
598 wxTreeItemId itemId
= event
.GetItem();
599 if ( IsTestItem(itemId
) )
601 wxMessageBox("You can't edit this item.");
607 void MyTreeCtrl::OnEndLabelEdit(wxTreeEvent
& event
)
609 wxLogMessage("OnEndLabelEdit");
611 // don't allow anything except letters in the labels
612 if ( !event
.GetLabel().IsWord() )
614 wxMessageBox("The label should contain only letters.");
620 void MyTreeCtrl::OnItemCollapsing(wxTreeEvent
& event
)
622 wxLogMessage("OnItemCollapsing");
624 // for testing, prevent the user from collapsing the first child folder
625 wxTreeItemId itemId
= event
.GetItem();
626 if ( IsTestItem(itemId
) )
628 wxMessageBox("You can't collapse this item.");
634 void MyTreeCtrl::OnTreeKeyDown(wxTreeEvent
&WXUNUSED(event
))
636 wxLogMessage("OnTreeKeyDown");
639 void MyTreeCtrl::OnItemActivated(wxTreeEvent
&WXUNUSED(event
))
641 // show some info about this item
642 wxTreeItemId itemId
= GetSelection();
643 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(itemId
);
647 item
->ShowInfo(this);
650 wxLogMessage("OnItemActivated");
653 void MyTreeCtrl::OnRMouseDClick(wxMouseEvent
& event
)
655 wxTreeItemId id
= HitTest(event
.GetPosition());
657 wxLogMessage("No item under mouse");
660 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(id
);
662 wxLogMessage("Item '%s' under mouse", item
->GetDesc());
666 static inline const char *Bool2String(bool b
)
668 return b
? "" : "not ";
671 void MyTreeItemData::ShowInfo(wxTreeCtrl
*tree
)
673 wxLogMessage("Item '%s': %sselected, %sexpanded, %sbold,\n"
674 "%u children (%u immediately under this item).",
676 Bool2String(tree
->IsSelected(GetId())),
677 Bool2String(tree
->IsExpanded(GetId())),
678 Bool2String(tree
->IsBold(GetId())),
679 tree
->GetChildrenCount(GetId()),
680 tree
->GetChildrenCount(GetId(), FALSE
));