samples/treectrl/treetest.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treetest.cpp
   3 // Purpose:     wxTreeCtrl sample
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13   #pragma implementation
  14   #pragma interface
  15 #endif
  16
  17 // For compilers that support precompilation, includes "wx/wx.h".
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21   #pragma hdrstop
  22 #endif
  23
  24 #ifndef WX_PRECOMP
  25   #include "wx/wx.h"
  26 #endif
  27
  28 // under Windows the icons are in the .rc file
  29 #ifndef __WXMSW__
  30   #include "icon1.xpm"
  31   #include "icon2.xpm"
  32   #include "mondrian.xpm"
  33 #endif
  34
  35 #include "wx/log.h"
  36
  37 #include "wx/imaglist.h"
  38 #include "wx/treectrl.h"
  39
  40 #include "treetest.h"
  41
  42 // verify that the item is ok and insult the user if it is not
  43 #define CHECK_ITEM( item ) if ( !item.IsOk() ) {                            \
  44                              wxMessageBox("Please select some item first!", \
  45                                           "Tree sample error",              \
  46                                           wxOK | wxICON_EXCLAMATION,        \
  47                                           this);                            \
  48                              return;                                        \
  49                            }
  50
  51 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
  52     EVT_MENU(TreeTest_Quit, MyFrame::OnQuit)
  53     EVT_MENU(TreeTest_About, MyFrame::OnAbout)
  54     EVT_MENU(TreeTest_Dump, MyFrame::OnDump)
  55     EVT_MENU(TreeTest_Rename, MyFrame::OnRename)
  56     EVT_MENU(TreeTest_Sort, MyFrame::OnSort)
  57     EVT_MENU(TreeTest_SortRev, MyFrame::OnSortRev)
  58     EVT_MENU(TreeTest_Bold, MyFrame::OnSetBold)
  59     EVT_MENU(TreeTest_UnBold, MyFrame::OnClearBold)
  60     EVT_MENU(TreeTest_Delete, MyFrame::OnDelete)
  61     EVT_MENU(TreeTest_DeleteChildren, MyFrame::OnDeleteChildren)
  62     EVT_MENU(TreeTest_DeleteAll, MyFrame::OnDeleteAll)
  63     EVT_MENU(TreeTest_Recreate, MyFrame::OnRecreate)
  64     EVT_MENU(TreeTest_CollapseAndReset, MyFrame::OnCollapseAndReset)
  65     EVT_MENU(TreeTest_EnsureVisible, MyFrame::OnEnsureVisible)
  66     EVT_MENU(TreeTest_AddItem, MyFrame::OnAddItem)
  67 END_EVENT_TABLE()
  68
  69 BEGIN_EVENT_TABLE(MyTreeCtrl, wxTreeCtrl)
  70     EVT_TREE_BEGIN_DRAG(TreeTest_Ctrl, MyTreeCtrl::OnBeginDrag)
  71     EVT_TREE_BEGIN_RDRAG(TreeTest_Ctrl, MyTreeCtrl::OnBeginRDrag)
  72     EVT_TREE_BEGIN_LABEL_EDIT(TreeTest_Ctrl, MyTreeCtrl::OnBeginLabelEdit)
  73     EVT_TREE_END_LABEL_EDIT(TreeTest_Ctrl, MyTreeCtrl::OnEndLabelEdit)
  74     EVT_TREE_DELETE_ITEM(TreeTest_Ctrl, MyTreeCtrl::OnDeleteItem)
  75     EVT_TREE_GET_INFO(TreeTest_Ctrl, MyTreeCtrl::OnGetInfo)
  76     EVT_TREE_SET_INFO(TreeTest_Ctrl, MyTreeCtrl::OnSetInfo)
  77     EVT_TREE_ITEM_EXPANDED(TreeTest_Ctrl, MyTreeCtrl::OnItemExpanded)
  78     EVT_TREE_ITEM_EXPANDING(TreeTest_Ctrl, MyTreeCtrl::OnItemExpanding)
  79     EVT_TREE_ITEM_COLLAPSED(TreeTest_Ctrl, MyTreeCtrl::OnItemCollapsed)
  80     EVT_TREE_ITEM_COLLAPSING(TreeTest_Ctrl, MyTreeCtrl::OnItemCollapsing)
  81     EVT_TREE_SEL_CHANGED(TreeTest_Ctrl, MyTreeCtrl::OnSelChanged)
  82     EVT_TREE_SEL_CHANGING(TreeTest_Ctrl, MyTreeCtrl::OnSelChanging)
  83     EVT_TREE_KEY_DOWN(TreeTest_Ctrl, MyTreeCtrl::OnTreeKeyDown)
  84     EVT_TREE_ITEM_ACTIVATED(TreeTest_Ctrl, MyTreeCtrl::OnItemActivated)
  85     EVT_RIGHT_DCLICK(MyTreeCtrl::OnRMouseDClick)
  86 END_EVENT_TABLE()
  87
  88 IMPLEMENT_APP(MyApp)
  89
  90 bool MyApp::OnInit()
  91 {
  92     // Create the main frame window
  93     MyFrame *frame = new MyFrame("wxTreeCtrl Test", 50, 50, 450, 340);
  94
  95     // Show the frame
  96     frame->Show(TRUE);
  97     SetTopWindow(frame);
  98
  99     return TRUE;
 100 }
 101
 102
 103 // My frame constructor
 104 MyFrame::MyFrame(const wxString& title, int x, int y, int w, int h)
 105        : wxFrame((wxFrame *)NULL, -1, title, wxPoint(x, y), wxSize(w, h))
 106 {
 107     // This reduces flicker effects - even better would be to define
 108     // OnEraseBackground to do nothing. When the tree control's scrollbars are
 109     // show or hidden, the frame is sent a background erase event.
 110     SetBackgroundColour(wxColour(255, 255, 255));
 111
 112     // Give it an icon
 113     SetIcon(wxICON(mondrian));
 114
 115     // Make a menubar
 116     wxMenu *file_menu = new wxMenu,
 117            *tree_menu = new wxMenu,
 118            *item_menu = new wxMenu;
 119
 120     file_menu->Append(TreeTest_About, "&About...");
 121     file_menu->AppendSeparator();
 122     file_menu->Append(TreeTest_Quit, "E&xit");
 123
 124     tree_menu->Append(TreeTest_Recreate, "&Recreate the tree");
 125     tree_menu->Append(TreeTest_CollapseAndReset, "C&ollapse and reset");
 126     tree_menu->AppendSeparator();
 127     tree_menu->Append(TreeTest_AddItem, "Append a &new item");
 128     tree_menu->Append(TreeTest_Delete, "&Delete this item");
 129     tree_menu->Append(TreeTest_DeleteChildren, "Delete &children");
 130     tree_menu->Append(TreeTest_DeleteAll, "Delete &all items");
 131     tree_menu->AppendSeparator();
 132     tree_menu->Append(TreeTest_Sort, "Sort children of current item");
 133     tree_menu->Append(TreeTest_SortRev, "Sort in reversed order");
 134     tree_menu->AppendSeparator();
 135     tree_menu->Append(TreeTest_EnsureVisible, "Make the last item &visible");
 136
 137     item_menu->Append(TreeTest_Dump, "&Dump item children");
 138     item_menu->AppendSeparator();
 139     item_menu->Append(TreeTest_Rename, "&Rename item...");
 140     item_menu->AppendSeparator();
 141     item_menu->Append(TreeTest_Bold, "Make item &bold");
 142     item_menu->Append(TreeTest_UnBold, "Make item &not bold");
 143
 144     wxMenuBar *menu_bar = new wxMenuBar;
 145     menu_bar->Append(file_menu, "&File");
 146     menu_bar->Append(tree_menu, "&Tree");
 147     menu_bar->Append(item_menu, "&Item");
 148     SetMenuBar(menu_bar);
 149
 150     m_treeCtrl = new MyTreeCtrl(this, TreeTest_Ctrl,
 151                                 wxDefaultPosition, wxDefaultSize,
 152                                 wxTR_HAS_BUTTONS | wxSUNKEN_BORDER);
 153     wxTextCtrl *textCtrl = new wxTextCtrl(this, -1, "",
 154                                 wxDefaultPosition, wxDefaultSize,
 155                                 wxTE_MULTILINE | wxSUNKEN_BORDER);
 156
 157     wxLayoutConstraints *c = new wxLayoutConstraints;
 158     c->top.SameAs(this, wxTop);
 159     c->left.SameAs(this, wxLeft);
 160     c->right.SameAs(this, wxRight);
 161     c->height.PercentOf(this, wxHeight, 66);
 162     m_treeCtrl->SetConstraints(c);
 163
 164     c = new wxLayoutConstraints;
 165     c->top.Below(m_treeCtrl);
 166     c->left.SameAs(this, wxLeft);
 167     c->right.SameAs(this, wxRight);
 168     c->bottom.SameAs(this, wxBottom);
 169     textCtrl->SetConstraints(c);
 170     SetAutoLayout(TRUE);
 171
 172     // create a status bar with 3 panes
 173     CreateStatusBar(3);
 174     SetStatusText("", 0);
 175
 176 #ifdef __WXMOTIF__
 177     // For some reason, we get a memcpy crash in wxLogStream::DoLogStream
 178     // on gcc/wxMotif, if we use wxLogTextCtl. Maybe it's just gcc?
 179     delete wxLog::SetActiveTarget(new wxLogStderr);
 180 #else
 181     // set our text control as the log target
 182     wxLogTextCtrl *logWindow = new wxLogTextCtrl(textCtrl);
 183     delete wxLog::SetActiveTarget(logWindow);
 184 #endif
 185 }
 186
 187 MyFrame::~MyFrame()
 188 {
 189     delete wxLog::SetActiveTarget(NULL);
 190 }
 191
 192 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 193 {
 194     Close(TRUE);
 195 }
 196
 197 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 198 {
 199     wxMessageBox("Tree test sample\n"
 200                  "Julian Smart (c) 1997,\n"
 201                  "Vadim Zeitlin (c) 1998",
 202                  "About tree test",
 203                  wxOK | wxICON_INFORMATION, this);
 204 }
 205
 206 void MyFrame::OnRename(wxCommandEvent& WXUNUSED(event))
 207 {
 208     wxTreeItemId item = m_treeCtrl->GetSelection();
 209
 210     CHECK_ITEM( item );
 211
 212     static wxString s_text;
 213     s_text = wxGetTextFromUser("New name: ", "Tree sample question",
 214             s_text, this);
 215     if ( !s_text.IsEmpty() )
 216     {
 217         m_treeCtrl->SetItemText(item, s_text);
 218     }
 219 }
 220
 221 void MyFrame::DoSort(bool reverse)
 222 {
 223     wxTreeItemId item = m_treeCtrl->GetSelection();
 224
 225     CHECK_ITEM( item );
 226
 227     m_treeCtrl->DoSortChildren(item, reverse);
 228 }
 229
 230 void MyFrame::OnDump(wxCommandEvent& WXUNUSED(event))
 231 {
 232     wxTreeItemId root = m_treeCtrl->GetSelection();
 233
 234     CHECK_ITEM( root );
 235
 236     m_treeCtrl->GetItemsRecursively(root, -1);
 237 }
 238
 239 void MyFrame::DoSetBold(bool bold)
 240 {
 241     wxTreeItemId item = m_treeCtrl->GetSelection();
 242
 243     CHECK_ITEM( item );
 244
 245     m_treeCtrl->SetItemBold(item, bold);
 246 }
 247
 248 void MyFrame::OnDelete(wxCommandEvent& WXUNUSED(event))
 249 {
 250     wxTreeItemId item = m_treeCtrl->GetSelection();
 251
 252     CHECK_ITEM( item );
 253
 254     m_treeCtrl->Delete(item);
 255 }
 256
 257 void MyFrame::OnDeleteChildren(wxCommandEvent& WXUNUSED(event))
 258 {
 259     wxTreeItemId item = m_treeCtrl->GetSelection();
 260
 261     CHECK_ITEM( item );
 262
 263     m_treeCtrl->DeleteChildren(item);
 264 }
 265
 266 void MyFrame::OnDeleteAll(wxCommandEvent& WXUNUSED(event))
 267 {
 268     m_treeCtrl->DeleteAllItems();
 269 }
 270
 271 void MyFrame::OnRecreate(wxCommandEvent& event)
 272 {
 273     OnDeleteAll(event);
 274     m_treeCtrl->AddTestItemsToTree(3, 2);
 275 }
 276
 277 void MyFrame::OnCollapseAndReset(wxCommandEvent& event)
 278 {
 279     m_treeCtrl->CollapseAndReset(m_treeCtrl->GetRootItem());
 280 }
 281
 282 void MyFrame::OnEnsureVisible(wxCommandEvent& event)
 283 {
 284     m_treeCtrl->DoEnsureVisible();
 285 }
 286
 287 void MyFrame::OnAddItem(wxCommandEvent& WXUNUSED(event))
 288 {
 289     static int s_num = 0;
 290
 291     wxString text;
 292     text.Printf("Item #%d", ++s_num);
 293
 294     m_treeCtrl->AppendItem(m_treeCtrl->GetRootItem(),
 295                            text,
 296                            MyTreeCtrl::TreeCtrlIcon_File);
 297 }
 298
 299 // MyTreeCtrl implementation
 300 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl, wxTreeCtrl)
 301
 302 MyTreeCtrl::MyTreeCtrl(wxWindow *parent, const wxWindowID id,
 303                        const wxPoint& pos, const wxSize& size,
 304                        long style)
 305           : wxTreeCtrl(parent, id, pos, size, style)
 306 {
 307     m_reverseSort = FALSE;
 308
 309     // Make an image list containing small icons
 310     m_imageListNormal = new wxImageList(16, 16, TRUE);
 311
 312     // should correspond to TreeCtrlIcon_xxx enum
 313 #if defined(__WXMSW__) && defined(__WIN16__)
 314     // This is required in 16-bit Windows mode only because we can't load a specific (16x16)
 315     // icon image, so it comes out stretched
 316     m_imageListNormal->Add(wxBitmap("bitmap1", wxBITMAP_TYPE_BMP_RESOURCE));
 317     m_imageListNormal->Add(wxBitmap("bitmap2", wxBITMAP_TYPE_BMP_RESOURCE));
 318 #else
 319     m_imageListNormal->Add(wxICON(icon1));
 320     m_imageListNormal->Add(wxICON(icon2));
 321 #endif
 322
 323     SetImageList(m_imageListNormal);
 324
 325     // Add some items to the tree
 326     AddTestItemsToTree(3, 2);
 327 }
 328
 329 MyTreeCtrl::~MyTreeCtrl()
 330 {
 331     delete m_imageListNormal;
 332 }
 333
 334 int MyTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
 335                                const wxTreeItemId& item2)
 336 {
 337     if ( m_reverseSort )
 338     {
 339         // just exchange 1st and 2nd items
 340         return wxTreeCtrl::OnCompareItems(item2, item1);
 341     }
 342     else
 343     {
 344         return wxTreeCtrl::OnCompareItems(item1, item2);
 345     }
 346 }
 347
 348 void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId& idParent,
 349                                      size_t numChildren,
 350                                      size_t depth,
 351                                      size_t folder)
 352 {
 353     if ( depth > 0 )
 354     {
 355         wxString str;
 356         for ( size_t n = 0; n < numChildren; n++ )
 357         {
 358             // at depth 1 elements won't have any more children
 359             if (depth == 1)
 360                 str.Printf("%s child %d.%d", "File", folder, n + 1);
 361             else
 362                 str.Printf("%s child %d", "Folder", n + 1);
 363
 364             int image = depth == 1 ? TreeCtrlIcon_File : TreeCtrlIcon_Folder;
 365             wxTreeItemId id = AppendItem(idParent, str, image, image,
 366                                          new MyTreeItemData(str));
 367
 368             // remember the last child for OnEnsureVisible()
 369             if ( depth == 1 && n == numChildren - 1 )
 370             {
 371                 m_lastItem = id;
 372             }
 373
 374             AddItemsRecursively(id, numChildren, depth - 1, n + 1);
 375         }
 376     }
 377     //else: done!
 378 }
 379
 380 void MyTreeCtrl::AddTestItemsToTree(size_t numChildren,
 381                                     size_t depth)
 382 {
 383     wxTreeItemId rootId = AddRoot("Root",
 384                                   TreeCtrlIcon_Folder, TreeCtrlIcon_Folder,
 385                                   new MyTreeItemData("Root item"));
 386
 387     AddItemsRecursively(rootId, numChildren, depth, 0);
 388 }
 389
 390 void MyTreeCtrl::GetItemsRecursively(const wxTreeItemId& idParent, long cookie)
 391 {
 392     wxTreeItemId id;
 393
 394     if( cookie == -1 )
 395         id = GetFirstChild(idParent, cookie);
 396     else
 397         id = GetNextChild(idParent, cookie);
 398
 399     if(id <= 0)
 400         return;
 401
 402     wxString text=GetItemText(id);
 403     wxLogMessage(text);
 404
 405     if (ItemHasChildren(id))
 406         GetItemsRecursively(id,-1);
 407
 408     GetItemsRecursively(idParent, cookie);
 409 }
 410
 411
 412 // avoid repetition
 413 #define TREE_EVENT_HANDLER(name)                            \
 414 void MyTreeCtrl::name(wxTreeEvent& WXUNUSED(event))         \
 415 {                                                           \
 416     wxLogMessage(#name);                                    \
 417 }
 418
 419 TREE_EVENT_HANDLER(OnBeginDrag)
 420 TREE_EVENT_HANDLER(OnBeginRDrag)
 421 TREE_EVENT_HANDLER(OnBeginLabelEdit)
 422 TREE_EVENT_HANDLER(OnEndLabelEdit)
 423 TREE_EVENT_HANDLER(OnDeleteItem)
 424 TREE_EVENT_HANDLER(OnGetInfo)
 425 TREE_EVENT_HANDLER(OnSetInfo)
 426 TREE_EVENT_HANDLER(OnItemExpanded)
 427 TREE_EVENT_HANDLER(OnItemExpanding)
 428 TREE_EVENT_HANDLER(OnItemCollapsed)
 429 TREE_EVENT_HANDLER(OnSelChanged)
 430 TREE_EVENT_HANDLER(OnSelChanging)
 431
 432 #undef TREE_EVENT_HANDLER
 433
 434 void MyTreeCtrl::OnItemCollapsing(wxTreeEvent& event)
 435 {
 436     wxLogMessage("OnItemCollapsing");
 437
 438     // for testing, prevent the user from collapsing the first child folder
 439     wxTreeItemId itemId = event.GetItem();
 440     if ( GetParent(itemId) == GetRootItem() && !GetPrevSibling(itemId) )
 441     {
 442         wxMessageBox("You can't collapse this item.");
 443
 444         event.Veto();
 445     }
 446 }
 447
 448 void MyTreeCtrl::OnTreeKeyDown(wxTreeEvent&WXUNUSED(event))
 449 {
 450     wxLogMessage("OnTreeKeyDown");
 451 }
 452
 453 void MyTreeCtrl::OnItemActivated(wxTreeEvent&WXUNUSED(event))
 454 {
 455     // show some info about this item
 456     wxTreeItemId itemId = GetSelection();
 457     MyTreeItemData *item = (MyTreeItemData *)GetItemData(itemId);
 458
 459     if ( item != NULL )
 460     {
 461         item->ShowInfo(this);
 462     }
 463
 464     wxLogMessage("OnItemActivated");
 465 }
 466
 467 void MyTreeCtrl::OnRMouseDClick(wxMouseEvent& event)
 468 {
 469     wxTreeItemId id = HitTest(event.GetPosition());
 470     if ( !id )
 471         wxLogMessage("No item under mouse");
 472     else
 473     {
 474         MyTreeItemData *item = (MyTreeItemData *)GetItemData(id);
 475         if ( item )
 476             wxLogMessage("Item '%s' under mouse", item->GetDesc());
 477     }
 478 }
 479
 480 static inline const char *Bool2String(bool b)
 481 {
 482     return b ? "" : "not ";
 483 }
 484
 485 void MyTreeItemData::ShowInfo(wxTreeCtrl *tree)
 486 {
 487     wxLogMessage("Item '%s': %sselected, %sexpanded, %sbold,\n"
 488                  "%u children (%u immediately under this item).",
 489                  m_desc.c_str(),
 490                  Bool2String(tree->IsSelected(GetId())),
 491                  Bool2String(tree->IsExpanded(GetId())),
 492                  Bool2String(tree->IsBold(GetId())),
 493                  tree->GetChildrenCount(GetId()),
 494                  tree->GetChildrenCount(GetId(), FALSE));
 495 }