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