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
,
187 #ifndef NO_MULTIPLE_SELECTION
190 #ifndef NO_VARIABLE_HEIGHT
191 wxTR_HAS_VARIABLE_ROW_HEIGHT
|
194 wxTextCtrl
*textCtrl
= new wxTextCtrl(this, -1, "",
195 wxDefaultPosition
, wxDefaultSize
,
196 wxTE_MULTILINE
| wxSUNKEN_BORDER
);
198 wxLayoutConstraints
*c
= new wxLayoutConstraints
;
199 c
->top
.SameAs(this, wxTop
);
200 c
->left
.SameAs(this, wxLeft
);
201 c
->right
.SameAs(this, wxRight
);
202 c
->height
.PercentOf(this, wxHeight
, 66);
203 m_treeCtrl
->SetConstraints(c
);
205 c
= new wxLayoutConstraints
;
206 c
->top
.Below(m_treeCtrl
);
207 c
->left
.SameAs(this, wxLeft
);
208 c
->right
.SameAs(this, wxRight
);
209 c
->bottom
.SameAs(this, wxBottom
);
210 textCtrl
->SetConstraints(c
);
213 // create a status bar with 3 panes
215 SetStatusText("", 0);
218 // For some reason, we get a memcpy crash in wxLogStream::DoLogStream
219 // on gcc/wxMotif, if we use wxLogTextCtl. Maybe it's just gcc?
220 delete wxLog::SetActiveTarget(new wxLogStderr
);
222 // set our text control as the log target
223 wxLogTextCtrl
*logWindow
= new wxLogTextCtrl(textCtrl
);
224 delete wxLog::SetActiveTarget(logWindow
);
230 delete wxLog::SetActiveTarget(NULL
);
233 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
238 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
240 wxMessageBox("Tree test sample\n"
241 "(c) Julian Smart 1997, Vadim Zeitlin 1998",
243 wxOK
| wxICON_INFORMATION
, this);
246 void MyFrame::OnRename(wxCommandEvent
& WXUNUSED(event
))
248 wxTreeItemId item
= m_treeCtrl
->GetSelection();
252 // old code - now we edit in place
254 static wxString s_text
;
255 s_text
= wxGetTextFromUser("New name: ", "Tree sample question",
257 if ( !s_text
.IsEmpty() )
259 m_treeCtrl
->SetItemText(item
, s_text
);
263 // TODO demonstrate creating a custom edit control...
264 (void)m_treeCtrl
->EditLabel(item
);
267 void MyFrame::DoSort(bool reverse
)
269 wxTreeItemId item
= m_treeCtrl
->GetSelection();
273 m_treeCtrl
->DoSortChildren(item
, reverse
);
276 void MyFrame::OnDump(wxCommandEvent
& WXUNUSED(event
))
278 wxTreeItemId root
= m_treeCtrl
->GetSelection();
282 m_treeCtrl
->GetItemsRecursively(root
, -1);
285 #ifndef NO_MULTIPLE_SELECTION
287 void MyFrame::OnDumpSelected(wxCommandEvent
& WXUNUSED(event
))
289 wxArrayTreeItemIds array
;
291 size_t count
= m_treeCtrl
->GetSelections(array
);
292 wxLogMessage(_T("%u items selected"), count
);
294 for ( size_t n
= 0; n
< count
; n
++ )
296 wxLogMessage("\t%s", m_treeCtrl
->GetItemText(array
.Item(n
)).c_str());
300 void MyFrame::OnSelect(wxCommandEvent
& event
)
302 m_treeCtrl
->SelectItem(m_treeCtrl
->GetSelection());
305 void MyFrame::OnUnselect(wxCommandEvent
& event
)
307 m_treeCtrl
->UnselectAll();
310 #endif // NO_MULTIPLE_SELECTION
312 void MyFrame::DoSetBold(bool bold
)
314 wxTreeItemId item
= m_treeCtrl
->GetSelection();
318 m_treeCtrl
->SetItemBold(item
, bold
);
321 void MyFrame::OnDelete(wxCommandEvent
& WXUNUSED(event
))
323 wxTreeItemId item
= m_treeCtrl
->GetSelection();
327 m_treeCtrl
->Delete(item
);
330 void MyFrame::OnDeleteChildren(wxCommandEvent
& WXUNUSED(event
))
332 wxTreeItemId item
= m_treeCtrl
->GetSelection();
336 m_treeCtrl
->DeleteChildren(item
);
339 void MyFrame::OnDeleteAll(wxCommandEvent
& WXUNUSED(event
))
341 m_treeCtrl
->DeleteAllItems();
344 void MyFrame::OnRecreate(wxCommandEvent
& event
)
347 m_treeCtrl
->AddTestItemsToTree(3, 2);
350 void MyFrame::OnCollapseAndReset(wxCommandEvent
& event
)
352 m_treeCtrl
->CollapseAndReset(m_treeCtrl
->GetRootItem());
355 void MyFrame::OnEnsureVisible(wxCommandEvent
& event
)
357 m_treeCtrl
->DoEnsureVisible();
360 void MyFrame::OnAddItem(wxCommandEvent
& WXUNUSED(event
))
362 static int s_num
= 0;
365 text
.Printf("Item #%d", ++s_num
);
367 m_treeCtrl
->AppendItem(m_treeCtrl
->GetRootItem(),
369 MyTreeCtrl::TreeCtrlIcon_File */ );
372 void MyFrame::OnIncIndent(wxCommandEvent
& WXUNUSED(event
))
374 unsigned int indent
= m_treeCtrl
->GetIndent();
376 m_treeCtrl
->SetIndent( indent
+5 );
379 void MyFrame::OnDecIndent(wxCommandEvent
& WXUNUSED(event
))
381 unsigned int indent
= m_treeCtrl
->GetIndent();
383 m_treeCtrl
->SetIndent( indent
-5 );
386 void MyFrame::OnIncSpacing(wxCommandEvent
& WXUNUSED(event
))
388 unsigned int indent
= m_treeCtrl
->GetSpacing();
390 m_treeCtrl
->SetSpacing( indent
+5 );
393 void MyFrame::OnDecSpacing(wxCommandEvent
& WXUNUSED(event
))
395 unsigned int indent
= m_treeCtrl
->GetSpacing();
397 m_treeCtrl
->SetSpacing( indent
-5 );
400 void MyFrame::OnToggleIcon(wxCommandEvent
& WXUNUSED(event
))
402 wxTreeItemId item
= m_treeCtrl
->GetSelection();
406 m_treeCtrl
->DoToggleIcon(item
);
409 // MyTreeCtrl implementation
410 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl
, wxTreeCtrl
)
412 MyTreeCtrl::MyTreeCtrl(wxWindow
*parent
, const wxWindowID id
,
413 const wxPoint
& pos
, const wxSize
& size
,
415 : wxTreeCtrl(parent
, id
, pos
, size
, style
)
417 #if (USE_TR_HAS_VARIABLE_ROW_HIGHT && wxUSE_LIBJPEG)
418 wxImage::AddHandler(new wxJPEGHandler
);
421 image
.LoadFile(wxString("horse.jpg"), wxBITMAP_TYPE_JPEG
);
424 m_reverseSort
= FALSE
;
426 // Make an image list containing small icons
427 m_imageListNormal
= new wxImageList(16, 16, TRUE
);
429 // should correspond to TreeCtrlIcon_xxx enum
430 #if defined(__WXMSW__) && defined(__WIN16__)
431 // This is required in 16-bit Windows mode only because we can't load a specific (16x16)
432 // icon image, so it comes out stretched
433 # if USE_TR_HAS_VARIABLE_ROW_HIGHT
434 m_imageListNormal
->Add(image
.ConvertToBitmap());
436 m_imageListNormal
->Add(wxBitmap("bitmap1", wxBITMAP_TYPE_BMP_RESOURCE
));
438 m_imageListNormal
->Add(wxBitmap("bitmap2", wxBITMAP_TYPE_BMP_RESOURCE
));
440 # if USE_TR_HAS_VARIABLE_ROW_HIGHT
441 m_imageListNormal
->Add(image
.ConvertToBitmap());
443 m_imageListNormal
->Add(wxICON(icon1
));
445 m_imageListNormal
->Add(wxICON(icon2
));
448 SetImageList(m_imageListNormal
);
450 // Add some items to the tree
451 AddTestItemsToTree(3, 2);
454 MyTreeCtrl::~MyTreeCtrl()
456 delete m_imageListNormal
;
459 int MyTreeCtrl::OnCompareItems(const wxTreeItemId
& item1
,
460 const wxTreeItemId
& item2
)
464 // just exchange 1st and 2nd items
465 return wxTreeCtrl::OnCompareItems(item2
, item1
);
469 return wxTreeCtrl::OnCompareItems(item1
, item2
);
473 void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId
& idParent
,
481 for ( size_t n
= 0; n
< numChildren
; n
++ )
483 // at depth 1 elements won't have any more children
485 str
.Printf("%s child %d.%d", "File", folder
, n
+ 1);
487 str
.Printf("%s child %d", "Folder", n
+ 1);
489 int image
= depth
== 1 ? TreeCtrlIcon_File
: TreeCtrlIcon_Folder
;
490 wxTreeItemId id
= AppendItem(idParent
, str
, image
, image
,
491 new MyTreeItemData(str
));
493 // remember the last child for OnEnsureVisible()
494 if ( depth
== 1 && n
== numChildren
- 1 )
499 AddItemsRecursively(id
, numChildren
, depth
- 1, n
+ 1);
505 void MyTreeCtrl::AddTestItemsToTree(size_t numChildren
,
508 wxTreeItemId rootId
= AddRoot("Root",
509 TreeCtrlIcon_Folder
, TreeCtrlIcon_Folder
,
510 new MyTreeItemData("Root item"));
512 AddItemsRecursively(rootId
, numChildren
, depth
, 0);
515 void MyTreeCtrl::GetItemsRecursively(const wxTreeItemId
& idParent
, long cookie
)
520 id
= GetFirstChild(idParent
, cookie
);
522 id
= GetNextChild(idParent
, cookie
);
527 wxString text
= GetItemText(id
);
530 if (ItemHasChildren(id
))
531 GetItemsRecursively(id
,-1);
533 GetItemsRecursively(idParent
, cookie
);
536 void MyTreeCtrl::DoToggleIcon(const wxTreeItemId
& item
)
538 int image
= GetItemImage(item
) == TreeCtrlIcon_Folder
? TreeCtrlIcon_File
539 : TreeCtrlIcon_Folder
;
541 SetItemImage(item
, image
);
546 #define TREE_EVENT_HANDLER(name) \
547 void MyTreeCtrl::name(wxTreeEvent& WXUNUSED(event)) \
549 wxLogMessage(#name); \
552 TREE_EVENT_HANDLER(OnBeginDrag
)
553 TREE_EVENT_HANDLER(OnBeginRDrag
)
554 TREE_EVENT_HANDLER(OnDeleteItem
)
555 TREE_EVENT_HANDLER(OnGetInfo
)
556 TREE_EVENT_HANDLER(OnSetInfo
)
557 TREE_EVENT_HANDLER(OnItemExpanded
)
558 TREE_EVENT_HANDLER(OnItemExpanding
)
559 TREE_EVENT_HANDLER(OnItemCollapsed
)
560 TREE_EVENT_HANDLER(OnSelChanged
)
561 TREE_EVENT_HANDLER(OnSelChanging
)
563 #undef TREE_EVENT_HANDLER
565 void MyTreeCtrl::OnBeginLabelEdit(wxTreeEvent
& event
)
567 wxLogMessage("OnBeginLabelEdit");
569 // for testing, prevent this items label editing
570 wxTreeItemId itemId
= event
.GetItem();
571 if ( IsTestItem(itemId
) )
573 wxMessageBox("You can't edit this item.");
579 void MyTreeCtrl::OnEndLabelEdit(wxTreeEvent
& event
)
581 wxLogMessage("OnEndLabelEdit");
583 // don't allow anything except letters in the labels
584 if ( !event
.GetLabel().IsWord() )
586 wxMessageBox("The label should contain only letters.");
592 void MyTreeCtrl::OnItemCollapsing(wxTreeEvent
& event
)
594 wxLogMessage("OnItemCollapsing");
596 // for testing, prevent the user from collapsing the first child folder
597 wxTreeItemId itemId
= event
.GetItem();
598 if ( IsTestItem(itemId
) )
600 wxMessageBox("You can't collapse this item.");
606 void MyTreeCtrl::OnTreeKeyDown(wxTreeEvent
&WXUNUSED(event
))
608 wxLogMessage("OnTreeKeyDown");
611 void MyTreeCtrl::OnItemActivated(wxTreeEvent
&WXUNUSED(event
))
613 // show some info about this item
614 wxTreeItemId itemId
= GetSelection();
615 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(itemId
);
619 item
->ShowInfo(this);
622 wxLogMessage("OnItemActivated");
625 void MyTreeCtrl::OnRMouseDClick(wxMouseEvent
& event
)
627 wxTreeItemId id
= HitTest(event
.GetPosition());
629 wxLogMessage("No item under mouse");
632 MyTreeItemData
*item
= (MyTreeItemData
*)GetItemData(id
);
634 wxLogMessage("Item '%s' under mouse", item
->GetDesc());
638 static inline const char *Bool2String(bool b
)
640 return b
? "" : "not ";
643 void MyTreeItemData::ShowInfo(wxTreeCtrl
*tree
)
645 wxLogMessage("Item '%s': %sselected, %sexpanded, %sbold,\n"
646 "%u children (%u immediately under this item).",
648 Bool2String(tree
->IsSelected(GetId())),
649 Bool2String(tree
->IsExpanded(GetId())),
650 Bool2String(tree
->IsBold(GetId())),
651 tree
->GetChildrenCount(GetId()),
652 tree
->GetChildrenCount(GetId(), FALSE
));