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