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