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
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx/wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #ifndef WX_PRECOMP
  20     #include "wx/wx.h"
  21     #include "wx/log.h"
  22 #endif
  23
  24 #include "wx/colordlg.h"
  25 #include "wx/numdlg.h"
  26
  27 #include "wx/artprov.h"
  28 #include "wx/image.h"
  29 #include "wx/imaglist.h"
  30 #include "wx/treectrl.h"
  31 #include "wx/math.h"
  32 #include "wx/renderer.h"
  33
  34 #ifdef __WIN32__
  35     // this is not supported by native control
  36     #define NO_VARIABLE_HEIGHT
  37 #endif
  38
  39 #include "treetest.h"
  40
  41 #include "icon1.xpm"
  42 #include "icon2.xpm"
  43 #include "icon3.xpm"
  44 #include "icon4.xpm"
  45 #include "icon5.xpm"
  46
  47 #include "state1.xpm"
  48 #include "state2.xpm"
  49 #include "state3.xpm"
  50 #include "state4.xpm"
  51 #include "state5.xpm"
  52
  53 #include "unchecked.xpm"
  54 #include "checked.xpm"
  55
  56 #ifndef __WXMSW__
  57     #include "../sample.xpm"
  58 #endif
  59
  60 static const int NUM_CHILDREN_PER_LEVEL = 5;
  61 static const int NUM_LEVELS = 2;
  62
  63 // verify that the item is ok and insult the user if it is not
  64 #define CHECK_ITEM( item ) if ( !item.IsOk() ) {                                 \
  65                              wxMessageBox(wxT("Please select some item first!"), \
  66                                           wxT("Tree sample error"),              \
  67                                           wxOK | wxICON_EXCLAMATION,             \
  68                                           this);                                 \
  69                              return;                                             \
  70                            }
  71
  72 #define MENU_LINK(name) EVT_MENU(TreeTest_##name, MyFrame::On##name)
  73
  74 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
  75     EVT_IDLE(MyFrame::OnIdle)
  76     EVT_SIZE(MyFrame::OnSize)
  77
  78     MENU_LINK(Quit)
  79     MENU_LINK(About)
  80     MENU_LINK(ClearLog)
  81
  82     MENU_LINK(TogButtons)
  83     MENU_LINK(TogTwist)
  84     MENU_LINK(TogLines)
  85     MENU_LINK(TogEdit)
  86     MENU_LINK(TogHideRoot)
  87     MENU_LINK(TogRootLines)
  88     MENU_LINK(TogBorder)
  89     MENU_LINK(TogFullHighlight)
  90     MENU_LINK(SetFgColour)
  91     MENU_LINK(SetBgColour)
  92     MENU_LINK(ResetStyle)
  93
  94     MENU_LINK(Highlight)
  95     MENU_LINK(Dump)
  96 #ifndef NO_MULTIPLE_SELECTION
  97     MENU_LINK(DumpSelected)
  98     MENU_LINK(Select)
  99     MENU_LINK(Unselect)
 100     MENU_LINK(ToggleSel)
 101     MENU_LINK(SelectChildren)
 102 #endif // NO_MULTIPLE_SELECTION
 103     MENU_LINK(Rename)
 104     MENU_LINK(Count)
 105     MENU_LINK(CountRec)
 106     MENU_LINK(Sort)
 107     MENU_LINK(SortRev)
 108     MENU_LINK(SetBold)
 109     MENU_LINK(ClearBold)
 110     MENU_LINK(Delete)
 111     MENU_LINK(DeleteChildren)
 112     MENU_LINK(DeleteAll)
 113     MENU_LINK(Recreate)
 114     MENU_LINK(ToggleImages)
 115     MENU_LINK(ToggleStates)
 116     MENU_LINK(ToggleAlternateImages)
 117     MENU_LINK(ToggleAlternateStates)
 118     MENU_LINK(ToggleButtons)
 119     MENU_LINK(SetImageSize)
 120     MENU_LINK(CollapseAndReset)
 121     MENU_LINK(EnsureVisible)
 122     MENU_LINK(SetFocus)
 123     MENU_LINK(AddItem)
 124     MENU_LINK(InsertItem)
 125     MENU_LINK(IncIndent)
 126     MENU_LINK(DecIndent)
 127     MENU_LINK(IncSpacing)
 128     MENU_LINK(DecSpacing)
 129     MENU_LINK(ToggleIcon)
 130     MENU_LINK(ToggleState)
 131     MENU_LINK(SelectRoot)
 132     MENU_LINK(SetFocusedRoot)
 133     MENU_LINK(ClearFocused)
 134
 135     MENU_LINK(ShowFirstVisible)
 136 #ifdef wxHAS_LAST_VISIBLE
 137     MENU_LINK(ShowLastVisible)
 138 #endif // wxHAS_LAST_VISIBLE
 139     MENU_LINK(ShowNextVisible)
 140     MENU_LINK(ShowPrevVisible)
 141     MENU_LINK(ShowParent)
 142     MENU_LINK(ShowPrevSibling)
 143     MENU_LINK(ShowNextSibling)
 144     MENU_LINK(ScrollTo)
 145     MENU_LINK(SelectLast)
 146 #undef MENU_LINK
 147
 148 END_EVENT_TABLE()
 149
 150 #if USE_GENERIC_TREECTRL
 151 BEGIN_EVENT_TABLE(MyTreeCtrl, wxGenericTreeCtrl)
 152 #else
 153 BEGIN_EVENT_TABLE(MyTreeCtrl, wxTreeCtrl)
 154 #endif
 155     EVT_TREE_BEGIN_DRAG(TreeTest_Ctrl, MyTreeCtrl::OnBeginDrag)
 156     EVT_TREE_BEGIN_RDRAG(TreeTest_Ctrl, MyTreeCtrl::OnBeginRDrag)
 157     EVT_TREE_END_DRAG(TreeTest_Ctrl, MyTreeCtrl::OnEndDrag)
 158     EVT_TREE_BEGIN_LABEL_EDIT(TreeTest_Ctrl, MyTreeCtrl::OnBeginLabelEdit)
 159     EVT_TREE_END_LABEL_EDIT(TreeTest_Ctrl, MyTreeCtrl::OnEndLabelEdit)
 160     EVT_TREE_DELETE_ITEM(TreeTest_Ctrl, MyTreeCtrl::OnDeleteItem)
 161 #if 0       // there are so many of those that logging them causes flicker
 162     EVT_TREE_GET_INFO(TreeTest_Ctrl, MyTreeCtrl::OnGetInfo)
 163 #endif
 164     EVT_TREE_SET_INFO(TreeTest_Ctrl, MyTreeCtrl::OnSetInfo)
 165     EVT_TREE_ITEM_EXPANDED(TreeTest_Ctrl, MyTreeCtrl::OnItemExpanded)
 166     EVT_TREE_ITEM_EXPANDING(TreeTest_Ctrl, MyTreeCtrl::OnItemExpanding)
 167     EVT_TREE_ITEM_COLLAPSED(TreeTest_Ctrl, MyTreeCtrl::OnItemCollapsed)
 168     EVT_TREE_ITEM_COLLAPSING(TreeTest_Ctrl, MyTreeCtrl::OnItemCollapsing)
 169
 170     EVT_TREE_SEL_CHANGED(TreeTest_Ctrl, MyTreeCtrl::OnSelChanged)
 171     EVT_TREE_SEL_CHANGING(TreeTest_Ctrl, MyTreeCtrl::OnSelChanging)
 172     EVT_TREE_KEY_DOWN(TreeTest_Ctrl, MyTreeCtrl::OnTreeKeyDown)
 173     EVT_TREE_ITEM_ACTIVATED(TreeTest_Ctrl, MyTreeCtrl::OnItemActivated)
 174     EVT_TREE_STATE_IMAGE_CLICK(TreeTest_Ctrl, MyTreeCtrl::OnItemStateClick)
 175
 176     // so many different ways to handle right mouse button clicks...
 177     EVT_CONTEXT_MENU(MyTreeCtrl::OnContextMenu)
 178     // EVT_TREE_ITEM_MENU is the preferred event for creating context menus
 179     // on a tree control, because it includes the point of the click or item,
 180     // meaning that no additional placement calculations are required.
 181     EVT_TREE_ITEM_MENU(TreeTest_Ctrl, MyTreeCtrl::OnItemMenu)
 182     EVT_TREE_ITEM_RIGHT_CLICK(TreeTest_Ctrl, MyTreeCtrl::OnItemRClick)
 183
 184     EVT_RIGHT_DOWN(MyTreeCtrl::OnRMouseDown)
 185     EVT_RIGHT_UP(MyTreeCtrl::OnRMouseUp)
 186     EVT_RIGHT_DCLICK(MyTreeCtrl::OnRMouseDClick)
 187 END_EVENT_TABLE()
 188
 189 IMPLEMENT_APP(MyApp)
 190
 191 bool MyApp::OnInit()
 192 {
 193     if ( !wxApp::OnInit() )
 194         return false;
 195
 196     // Create the main frame window
 197     MyFrame *frame = new MyFrame(wxT("wxTreeCtrl Test"), 50, 50, 450, 600);
 198
 199     // Show the frame
 200     frame->Show(true);
 201
 202     return true;
 203 }
 204
 205
 206 // My frame constructor
 207 MyFrame::MyFrame(const wxString& title, int x, int y, int w, int h)
 208        : wxFrame((wxFrame *)NULL, wxID_ANY, title, wxPoint(x, y), wxSize(w, h)),
 209          m_treeCtrl(NULL)
 210 #if wxUSE_LOG
 211          , m_textCtrl(NULL)
 212 #endif // wxUSE_LOG
 213 {
 214     // This reduces flicker effects - even better would be to define
 215     // OnEraseBackground to do nothing. When the tree control's scrollbars are
 216     // show or hidden, the frame is sent a background erase event.
 217     SetBackgroundColour(wxColour(255, 255, 255));
 218
 219     // Give it an icon
 220     SetIcon(wxICON(sample));
 221
 222 #if wxUSE_MENUS
 223     // Make a menubar
 224     wxMenu *file_menu = new wxMenu,
 225            *style_menu = new wxMenu,
 226            *tree_menu = new wxMenu,
 227            *item_menu = new wxMenu;
 228
 229     file_menu->Append(TreeTest_ClearLog, wxT("&Clear log\tCtrl-L"));
 230     file_menu->AppendSeparator();
 231     file_menu->Append(TreeTest_About, wxT("&About..."));
 232     file_menu->AppendSeparator();
 233     file_menu->Append(TreeTest_Quit, wxT("E&xit\tAlt-X"));
 234
 235     style_menu->AppendCheckItem(TreeTest_TogButtons, wxT("Toggle &normal buttons"));
 236     style_menu->AppendCheckItem(TreeTest_TogTwist, wxT("Toggle &twister buttons"));
 237     style_menu->AppendCheckItem(TreeTest_ToggleButtons, wxT("Toggle image &buttons"));
 238     style_menu->AppendSeparator();
 239     style_menu->AppendCheckItem(TreeTest_TogLines, wxT("Toggle &connecting lines"));
 240     style_menu->AppendCheckItem(TreeTest_TogRootLines, wxT("Toggle &lines at root"));
 241     style_menu->AppendCheckItem(TreeTest_TogHideRoot, wxT("Toggle &hidden root"));
 242     style_menu->AppendCheckItem(TreeTest_TogBorder, wxT("Toggle &item border"));
 243     style_menu->AppendCheckItem(TreeTest_TogFullHighlight, wxT("Toggle &full row highlight"));
 244     style_menu->AppendCheckItem(TreeTest_TogEdit, wxT("Toggle &edit mode"));
 245 #ifndef NO_MULTIPLE_SELECTION
 246     style_menu->AppendCheckItem(TreeTest_ToggleSel, wxT("Toggle &selection mode\tCtrl-S"));
 247 #endif // NO_MULTIPLE_SELECTION
 248     style_menu->AppendCheckItem(TreeTest_ToggleImages, wxT("Toggle show ima&ges"));
 249     style_menu->AppendCheckItem(TreeTest_ToggleStates, wxT("Toggle show st&ates"));
 250     style_menu->AppendCheckItem(TreeTest_ToggleAlternateImages, wxT("Toggle alternate images"));
 251     style_menu->AppendCheckItem(TreeTest_ToggleAlternateStates, wxT("Toggle alternate state images"));
 252     style_menu->Append(TreeTest_SetImageSize, wxT("Set image si&ze..."));
 253     style_menu->AppendSeparator();
 254     style_menu->Append(TreeTest_SetFgColour, wxT("Set &foreground colour..."));
 255     style_menu->Append(TreeTest_SetBgColour, wxT("Set &background colour..."));
 256     style_menu->AppendSeparator();
 257     style_menu->Append(TreeTest_ResetStyle, wxT("&Reset to default\tF10"));
 258
 259     tree_menu->Append(TreeTest_Recreate, wxT("&Recreate the tree"));
 260     tree_menu->Append(TreeTest_CollapseAndReset, wxT("C&ollapse and reset"));
 261     tree_menu->AppendSeparator();
 262     tree_menu->Append(TreeTest_AddItem, wxT("Append a &new item"));
 263     tree_menu->Append(TreeTest_InsertItem, wxT("&Insert a new item"));
 264     tree_menu->Append(TreeTest_Delete, wxT("&Delete this item"));
 265     tree_menu->Append(TreeTest_DeleteChildren, wxT("Delete &children"));
 266     tree_menu->Append(TreeTest_DeleteAll, wxT("Delete &all items"));
 267     tree_menu->Append(TreeTest_SelectRoot, wxT("Select root item"));
 268     tree_menu->AppendSeparator();
 269     tree_menu->Append(TreeTest_SetFocusedRoot, wxT("Set focus to root item"));
 270     tree_menu->Append(TreeTest_ClearFocused, wxT("Reset focus"));
 271
 272     tree_menu->AppendSeparator();
 273     tree_menu->Append(TreeTest_Count, wxT("Count children of current item"));
 274     tree_menu->Append(TreeTest_CountRec, wxT("Recursively count children of current item"));
 275     tree_menu->AppendSeparator();
 276     tree_menu->Append(TreeTest_Sort, wxT("Sort children of current item"));
 277     tree_menu->Append(TreeTest_SortRev, wxT("Sort in reversed order"));
 278     tree_menu->AppendSeparator();
 279     tree_menu->Append(TreeTest_EnsureVisible, wxT("Make the last item &visible"));
 280     tree_menu->Append(TreeTest_SetFocus, wxT("Set &focus to the tree"));
 281     tree_menu->AppendSeparator();
 282     tree_menu->Append(TreeTest_IncIndent, wxT("Add 5 points to indentation\tAlt-I"));
 283     tree_menu->Append(TreeTest_DecIndent, wxT("Reduce indentation by 5 points\tAlt-R"));
 284     tree_menu->AppendSeparator();
 285     tree_menu->Append(TreeTest_IncSpacing, wxT("Add 5 points to spacing\tCtrl-I"));
 286     tree_menu->Append(TreeTest_DecSpacing, wxT("Reduce spacing by 5 points\tCtrl-R"));
 287
 288     item_menu->Append(TreeTest_Dump, wxT("&Dump item children"));
 289     item_menu->Append(TreeTest_Rename, wxT("&Rename item..."));
 290
 291     item_menu->AppendSeparator();
 292     item_menu->Append(TreeTest_SetBold, wxT("Make item &bold"));
 293     item_menu->Append(TreeTest_ClearBold, wxT("Make item &not bold"));
 294     item_menu->AppendSeparator();
 295     item_menu->Append(TreeTest_ToggleIcon, wxT("Toggle the item's &icon"));
 296     item_menu->Append(TreeTest_ToggleState, wxT("Toggle the item's &state"));
 297     item_menu->AppendSeparator();
 298     item_menu->Append(TreeTest_ShowFirstVisible, wxT("Show &first visible"));
 299 #ifdef wxHAS_LAST_VISIBLE
 300     item_menu->Append(TreeTest_ShowLastVisible, wxT("Show &last visible"));
 301 #endif // wxHAS_LAST_VISIBLE
 302     item_menu->Append(TreeTest_ShowNextVisible, wxT("Show &next visible"));
 303     item_menu->Append(TreeTest_ShowPrevVisible, wxT("Show &previous visible"));
 304     item_menu->AppendSeparator();
 305     item_menu->Append(TreeTest_ShowParent, "Show pa&rent");
 306     item_menu->Append(TreeTest_ShowPrevSibling, "Show &previous sibling");
 307     item_menu->Append(TreeTest_ShowNextSibling, "Show &next sibling");
 308     item_menu->AppendSeparator();
 309     item_menu->Append(TreeTest_ScrollTo, "Scroll &to item",
 310                       "Scroll to the last by one top level child");
 311     item_menu->Append(TreeTest_SelectLast, "Select &last item",
 312                       "Select the last item");
 313
 314 #ifndef NO_MULTIPLE_SELECTION
 315     item_menu->AppendSeparator();
 316     item_menu->Append(TreeTest_DumpSelected, wxT("Dump selected items\tAlt-D"));
 317     item_menu->Append(TreeTest_Select, wxT("Select current item\tAlt-S"));
 318     item_menu->Append(TreeTest_Unselect, wxT("Unselect everything\tAlt-U"));
 319     item_menu->Append(TreeTest_SelectChildren, wxT("Select all children\tCtrl-A"));
 320 #endif // NO_MULTIPLE_SELECTION
 321
 322     wxMenuBar *menu_bar = new wxMenuBar;
 323     menu_bar->Append(file_menu, wxT("&File"));
 324     menu_bar->Append(style_menu, wxT("&Style"));
 325     menu_bar->Append(tree_menu, wxT("&Tree"));
 326     menu_bar->Append(item_menu, wxT("&Item"));
 327     SetMenuBar(menu_bar);
 328 #endif // wxUSE_MENUS
 329
 330     m_panel = new wxPanel(this);
 331
 332 #if wxUSE_LOG
 333     // create the controls
 334     m_textCtrl = new wxTextCtrl(m_panel, wxID_ANY, wxT(""),
 335                                 wxDefaultPosition, wxDefaultSize,
 336                                 wxTE_MULTILINE | wxSUNKEN_BORDER);
 337 #endif // wxUSE_LOG
 338
 339     CreateTreeWithDefStyle();
 340
 341     menu_bar->Check(TreeTest_ToggleImages, true);
 342     menu_bar->Check(TreeTest_ToggleStates, true);
 343     menu_bar->Check(TreeTest_ToggleAlternateImages, false);
 344     menu_bar->Check(TreeTest_ToggleAlternateStates, false);
 345
 346 #if wxUSE_STATUSBAR
 347     // create a status bar
 348     CreateStatusBar(2);
 349 #endif // wxUSE_STATUSBAR
 350
 351 #if wxUSE_LOG
 352 #ifdef __WXMOTIF__
 353     // For some reason, we get a memcpy crash in wxLogStream::DoLogStream
 354     // on gcc/wxMotif, if we use wxLogTextCtl. Maybe it's just gcc?
 355     delete wxLog::SetActiveTarget(new wxLogStderr);
 356 #else
 357     // set our text control as the log target
 358     wxLogTextCtrl *logWindow = new wxLogTextCtrl(m_textCtrl);
 359     delete wxLog::SetActiveTarget(logWindow);
 360 #endif
 361 #endif // wxUSE_LOG
 362 }
 363
 364 MyFrame::~MyFrame()
 365 {
 366 #if wxUSE_LOG
 367     delete wxLog::SetActiveTarget(NULL);
 368 #endif // wxUSE_LOG
 369 }
 370
 371 void MyFrame::CreateTreeWithDefStyle()
 372 {
 373     long style = wxTR_DEFAULT_STYLE |
 374 #ifndef NO_VARIABLE_HEIGHT
 375                  wxTR_HAS_VARIABLE_ROW_HEIGHT |
 376 #endif
 377                  wxTR_EDIT_LABELS;
 378
 379     CreateTree(style | wxSUNKEN_BORDER);
 380
 381     // as we don't know what wxTR_DEFAULT_STYLE could contain, test for
 382     // everything
 383     wxMenuBar *mbar = GetMenuBar();
 384     mbar->Check(TreeTest_TogButtons, (style & wxTR_HAS_BUTTONS) != 0);
 385     mbar->Check(TreeTest_TogButtons, (style & wxTR_TWIST_BUTTONS) != 0);
 386     mbar->Check(TreeTest_TogLines, (style & wxTR_NO_LINES) == 0);
 387     mbar->Check(TreeTest_TogRootLines, (style & wxTR_LINES_AT_ROOT) != 0);
 388     mbar->Check(TreeTest_TogHideRoot, (style & wxTR_HIDE_ROOT) != 0);
 389     mbar->Check(TreeTest_TogEdit, (style & wxTR_EDIT_LABELS) != 0);
 390     mbar->Check(TreeTest_TogBorder, (style & wxTR_ROW_LINES) != 0);
 391     mbar->Check(TreeTest_TogFullHighlight, (style & wxTR_FULL_ROW_HIGHLIGHT) != 0);
 392 }
 393
 394 void MyFrame::CreateTree(long style)
 395 {
 396     m_treeCtrl = new MyTreeCtrl(m_panel, TreeTest_Ctrl,
 397                                 wxDefaultPosition, wxDefaultSize,
 398                                 style);
 399
 400     GetMenuBar()->Enable(TreeTest_SelectRoot, !(style & wxTR_HIDE_ROOT));
 401
 402     Resize();
 403 }
 404
 405 void MyFrame::TogStyle(int id, long flag)
 406 {
 407     long style = m_treeCtrl->GetWindowStyle() ^ flag;
 408
 409     // most treectrl styles can't be changed on the fly using the native
 410     // control and the tree must be recreated
 411 #ifndef __WXMSW__
 412     m_treeCtrl->SetWindowStyle(style);
 413 #else // MSW
 414     delete m_treeCtrl;
 415     CreateTree(style);
 416 #endif // !MSW/MSW
 417
 418     GetMenuBar()->Check(id, (style & flag) != 0);
 419 }
 420
 421 void MyFrame::OnIdle(wxIdleEvent& event)
 422 {
 423 #if wxUSE_STATUSBAR
 424     if ( m_treeCtrl )
 425     {
 426         wxTreeItemId idRoot = m_treeCtrl->GetRootItem();
 427         wxString status;
 428         if (idRoot.IsOk())
 429         {
 430             wxTreeItemId idLast = m_treeCtrl->GetLastChild(idRoot);
 431             status = wxString::Format(
 432                 wxT("Root/last item is %svisible/%svisible"),
 433                 m_treeCtrl->IsVisible(idRoot) ? wxT("") : wxT("not "),
 434                 idLast.IsOk() && m_treeCtrl->IsVisible(idLast)
 435                     ? wxT("") : wxT("not "));
 436         }
 437         else
 438             status = wxT("No root item");
 439
 440         SetStatusText(status, 1);
 441     }
 442 #endif // wxUSE_STATUSBAR
 443
 444     event.Skip();
 445 }
 446
 447 void MyFrame::OnSize(wxSizeEvent& event)
 448 {
 449     if ( m_treeCtrl
 450 #if wxUSE_LOG
 451                     && m_textCtrl
 452 #endif // wxUSE_LOG
 453                                   )
 454     {
 455         Resize();
 456     }
 457
 458     event.Skip();
 459 }
 460
 461 void MyFrame::Resize()
 462 {
 463     wxSize size = GetClientSize();
 464     m_treeCtrl->SetSize(0, 0, size.x, size.y
 465 #if wxUSE_LOG
 466                                             *2/3);
 467     m_textCtrl->SetSize(0, 2*size.y/3, size.x, size.y/3
 468 #endif
 469     );
 470 }
 471
 472 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 473 {
 474     Close(true);
 475 }
 476
 477 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 478 {
 479     wxMessageBox(wxT("Tree test sample\n")
 480                  wxT("(c) Julian Smart 1997, Vadim Zeitlin 1998"),
 481                  wxT("About tree test"),
 482                  wxOK | wxICON_INFORMATION, this);
 483 }
 484
 485 void MyFrame::OnClearLog(wxCommandEvent& WXUNUSED(event))
 486 {
 487     m_textCtrl->Clear();
 488 }
 489
 490 void MyFrame::OnRename(wxCommandEvent& WXUNUSED(event))
 491 {
 492     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 493
 494     CHECK_ITEM( item );
 495
 496     // old code - now we edit in place
 497 #if 0
 498     static wxString s_text;
 499     s_text = wxGetTextFromUser(wxT("New name: "), wxT("Tree sample question"),
 500             s_text, this);
 501     if ( !s_text.empty() )
 502     {
 503         m_treeCtrl->SetItemText(item, s_text);
 504     }
 505 #endif // 0
 506
 507     // TODO demonstrate creating a custom edit control...
 508     (void)m_treeCtrl->EditLabel(item);
 509 }
 510
 511 void MyFrame::OnCount(wxCommandEvent& WXUNUSED(event))
 512 {
 513     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 514
 515     CHECK_ITEM( item );
 516
 517     int i = m_treeCtrl->GetChildrenCount( item, false );
 518
 519     wxLogMessage(wxT("%d children"), i);
 520 }
 521
 522 void MyFrame::OnCountRec(wxCommandEvent& WXUNUSED(event))
 523 {
 524     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 525
 526     CHECK_ITEM( item );
 527
 528     int i = m_treeCtrl->GetChildrenCount( item );
 529
 530     wxLogMessage(wxT("%d children"), i);
 531 }
 532
 533 void MyFrame::DoSort(bool reverse)
 534 {
 535     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 536
 537     CHECK_ITEM( item );
 538
 539     m_treeCtrl->DoSortChildren(item, reverse);
 540 }
 541
 542 void MyFrame::OnHighlight(wxCommandEvent& WXUNUSED(event))
 543 {
 544     wxTreeItemId id = m_treeCtrl->GetFocusedItem();
 545
 546     CHECK_ITEM( id );
 547
 548     wxRect r;
 549     if ( !m_treeCtrl->GetBoundingRect(id, r, true /* text, not full row */) )
 550     {
 551         wxLogMessage(wxT("Failed to get bounding item rect"));
 552         return;
 553     }
 554
 555     wxClientDC dc(m_treeCtrl);
 556     dc.SetBrush(*wxRED);
 557     dc.SetPen(*wxTRANSPARENT_PEN);
 558     dc.DrawRectangle(r);
 559     m_treeCtrl->Update();
 560 }
 561
 562 void MyFrame::OnDump(wxCommandEvent& WXUNUSED(event))
 563 {
 564     wxTreeItemId root = m_treeCtrl->GetFocusedItem();
 565
 566     CHECK_ITEM( root );
 567
 568     m_treeCtrl->GetItemsRecursively(root);
 569 }
 570
 571 #ifndef NO_MULTIPLE_SELECTION
 572
 573 void MyFrame::OnToggleSel(wxCommandEvent& event)
 574 {
 575     TogStyle(event.GetId(), wxTR_MULTIPLE);
 576 }
 577
 578 void MyFrame::OnDumpSelected(wxCommandEvent& WXUNUSED(event))
 579 {
 580     wxArrayTreeItemIds array;
 581
 582     size_t count = m_treeCtrl->GetSelections(array);
 583     wxLogMessage(wxT("%u items selected"), unsigned(count));
 584
 585     for ( size_t n = 0; n < count; n++ )
 586     {
 587         wxLogMessage(wxT("\t%s"), m_treeCtrl->GetItemText(array.Item(n)).c_str());
 588     }
 589 }
 590
 591 void MyFrame::OnSelect(wxCommandEvent& WXUNUSED(event))
 592 {
 593     m_treeCtrl->SelectItem(m_treeCtrl->GetFocusedItem());
 594 }
 595
 596 void MyFrame::OnSelectRoot(wxCommandEvent& WXUNUSED(event))
 597 {
 598     if ( !m_treeCtrl->HasFlag(wxTR_HIDE_ROOT) )
 599         m_treeCtrl->SelectItem(m_treeCtrl->GetRootItem());
 600 }
 601
 602 void MyFrame::OnSetFocusedRoot(wxCommandEvent& WXUNUSED(event))
 603 {
 604     if ( !m_treeCtrl->HasFlag(wxTR_HIDE_ROOT) )
 605         m_treeCtrl->SetFocusedItem(m_treeCtrl->GetRootItem());
 606 }
 607
 608 void MyFrame::OnClearFocused(wxCommandEvent& WXUNUSED(event))
 609 {
 610     m_treeCtrl->ClearFocusedItem();
 611 }
 612
 613 void MyFrame::OnUnselect(wxCommandEvent& WXUNUSED(event))
 614 {
 615     m_treeCtrl->UnselectAll();
 616 }
 617
 618 void MyFrame::OnSelectChildren(wxCommandEvent& WXUNUSED(event))
 619 {
 620     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 621     if ( !item.IsOk() )
 622         item = m_treeCtrl->GetRootItem();
 623
 624     m_treeCtrl->SelectChildren(item);
 625 }
 626
 627 #endif // NO_MULTIPLE_SELECTION
 628
 629 void MyFrame::DoSetBold(bool bold)
 630 {
 631     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 632
 633     CHECK_ITEM( item );
 634
 635     m_treeCtrl->SetItemBold(item, bold);
 636 }
 637
 638 void MyFrame::OnDelete(wxCommandEvent& WXUNUSED(event))
 639 {
 640     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 641
 642     CHECK_ITEM( item );
 643
 644     m_treeCtrl->Delete(item);
 645 }
 646
 647 void MyFrame::OnDeleteChildren(wxCommandEvent& WXUNUSED(event))
 648 {
 649     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 650
 651     CHECK_ITEM( item );
 652
 653     m_treeCtrl->DeleteChildren(item);
 654 }
 655
 656 void MyFrame::OnDeleteAll(wxCommandEvent& WXUNUSED(event))
 657 {
 658     m_treeCtrl->DeleteAllItems();
 659 }
 660
 661 void MyFrame::OnRecreate(wxCommandEvent& event)
 662 {
 663     OnDeleteAll(event);
 664     m_treeCtrl->AddTestItemsToTree(NUM_CHILDREN_PER_LEVEL, NUM_LEVELS);
 665 }
 666
 667 void MyFrame::OnSetImageSize(wxCommandEvent& WXUNUSED(event))
 668 {
 669     int size = wxGetNumberFromUser(wxT("Enter the size for the images to use"),
 670                                     wxT("Size: "),
 671                                     wxT("TreeCtrl sample"),
 672                                     m_treeCtrl->ImageSize());
 673     if ( size == -1 )
 674         return;
 675
 676     m_treeCtrl->CreateImageList(size);
 677     wxGetApp().SetShowImages(true);
 678 }
 679
 680 void MyFrame::OnToggleImages(wxCommandEvent& WXUNUSED(event))
 681 {
 682     if ( wxGetApp().ShowImages() )
 683     {
 684         m_treeCtrl->CreateImageList(-1);
 685         wxGetApp().SetShowImages(false);
 686     }
 687     else
 688     {
 689         m_treeCtrl->CreateImageList(0);
 690         wxGetApp().SetShowImages(true);
 691     }
 692 }
 693
 694 void MyFrame::OnToggleStates(wxCommandEvent& WXUNUSED(event))
 695 {
 696     if ( wxGetApp().ShowStates() )
 697     {
 698         m_treeCtrl->CreateStateImageList(true);
 699         wxGetApp().SetShowStates(false);
 700     }
 701     else
 702     {
 703         m_treeCtrl->CreateStateImageList(false);
 704         wxGetApp().SetShowStates(true);
 705     }
 706 }
 707
 708 void MyFrame::OnToggleAlternateImages(wxCommandEvent& WXUNUSED(event))
 709 {
 710     bool alternateImages = m_treeCtrl->AlternateImages();
 711
 712     m_treeCtrl->SetAlternateImages(!alternateImages);
 713     m_treeCtrl->CreateImageList(0);
 714 }
 715
 716 void MyFrame::OnToggleAlternateStates(wxCommandEvent& WXUNUSED(event))
 717 {
 718     bool alternateStates = m_treeCtrl->AlternateStates();
 719
 720     m_treeCtrl->SetAlternateStates(!alternateStates);
 721     m_treeCtrl->CreateStateImageList();
 722
 723     // normal states < alternate states
 724     // so we must reset broken states
 725     if ( alternateStates )
 726         m_treeCtrl->ResetBrokenStateImages();
 727 }
 728
 729 void MyFrame::OnToggleButtons(wxCommandEvent& WXUNUSED(event))
 730 {
 731 #if USE_GENERIC_TREECTRL || !defined(__WXMSW__)
 732     if ( wxGetApp().ShowButtons() )
 733     {
 734         m_treeCtrl->CreateButtonsImageList(-1);
 735         wxGetApp().SetShowButtons(false);
 736     }
 737     else
 738     {
 739         m_treeCtrl->CreateButtonsImageList(15);
 740         wxGetApp().SetShowButtons(true);
 741     }
 742 #endif
 743 }
 744
 745 void MyFrame::OnCollapseAndReset(wxCommandEvent& WXUNUSED(event))
 746 {
 747     m_treeCtrl->CollapseAndReset(m_treeCtrl->GetRootItem());
 748 }
 749
 750 void MyFrame::OnEnsureVisible(wxCommandEvent& WXUNUSED(event))
 751 {
 752     m_treeCtrl->DoEnsureVisible();
 753 }
 754
 755 void MyFrame::OnSetFocus(wxCommandEvent& WXUNUSED(event))
 756 {
 757     m_treeCtrl->SetFocus();
 758 }
 759
 760 void MyFrame::OnInsertItem(wxCommandEvent& WXUNUSED(event))
 761 {
 762     int image = wxGetApp().ShowImages() ? MyTreeCtrl::TreeCtrlIcon_File : -1;
 763     m_treeCtrl->InsertItem(m_treeCtrl->GetRootItem(), image, wxT("2nd item"));
 764 }
 765
 766 void MyFrame::OnAddItem(wxCommandEvent& WXUNUSED(event))
 767 {
 768     static int s_num = 0;
 769
 770     wxString text;
 771     text.Printf(wxT("Item #%d"), ++s_num);
 772
 773     m_treeCtrl->AppendItem(m_treeCtrl->GetRootItem(),
 774                            text /*,
 775                            MyTreeCtrl::TreeCtrlIcon_File */ );
 776 }
 777
 778 void MyFrame::OnIncIndent(wxCommandEvent& WXUNUSED(event))
 779 {
 780     unsigned int indent = m_treeCtrl->GetIndent();
 781     if (indent < 100)
 782         m_treeCtrl->SetIndent( indent+5 );
 783 }
 784
 785 void MyFrame::OnDecIndent(wxCommandEvent& WXUNUSED(event))
 786 {
 787     unsigned int indent = m_treeCtrl->GetIndent();
 788     if (indent > 10)
 789         m_treeCtrl->SetIndent( indent-5 );
 790 }
 791
 792 void MyFrame::OnIncSpacing(wxCommandEvent& WXUNUSED(event))
 793 {
 794     unsigned int indent = m_treeCtrl->GetSpacing();
 795     if (indent < 100)
 796     {
 797         m_treeCtrl->SetSpacing( indent+5 );
 798         m_treeCtrl->Refresh();
 799     }
 800 }
 801
 802 void MyFrame::OnDecSpacing(wxCommandEvent& WXUNUSED(event))
 803 {
 804     unsigned int indent = m_treeCtrl->GetSpacing();
 805     if (indent > 10)
 806     {
 807         m_treeCtrl->SetSpacing( indent-5 );
 808         m_treeCtrl->Refresh();
 809     }
 810 }
 811
 812 void MyFrame::OnToggleIcon(wxCommandEvent& WXUNUSED(event))
 813 {
 814     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 815
 816     CHECK_ITEM( item );
 817
 818     m_treeCtrl->DoToggleIcon(item);
 819 }
 820
 821 void MyFrame::OnToggleState(wxCommandEvent& WXUNUSED(event))
 822 {
 823     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 824
 825     CHECK_ITEM( item );
 826
 827     m_treeCtrl->DoToggleState(item);
 828 }
 829
 830 void MyFrame::DoShowFirstOrLast(TreeFunc0_t pfn, const wxString& label)
 831 {
 832     const wxTreeItemId item = (m_treeCtrl->*pfn)();
 833
 834     if ( !item.IsOk() )
 835     {
 836         wxLogMessage("There is no %s item", label);
 837     }
 838     else
 839     {
 840         wxLogMessage("The %s item is \"%s\"",
 841                      label, m_treeCtrl->GetItemText(item));
 842     }
 843 }
 844
 845 void MyFrame::DoShowRelativeItem(TreeFunc1_t pfn, const wxString& label)
 846 {
 847     wxTreeItemId item = m_treeCtrl->GetFocusedItem();
 848
 849     CHECK_ITEM( item );
 850
 851     if ((pfn == (TreeFunc1_t) &wxTreeCtrl::GetPrevVisible
 852          || pfn == (TreeFunc1_t) &wxTreeCtrl::GetNextVisible)
 853         && !m_treeCtrl->IsVisible(item))
 854     {
 855         wxLogMessage("The selected item must be visible.");
 856         return;
 857     }
 858
 859     wxTreeItemId new_item = (m_treeCtrl->*pfn)(item);
 860
 861     if ( !new_item.IsOk() )
 862     {
 863         wxLogMessage("There is no %s item", label);
 864     }
 865     else
 866     {
 867         wxLogMessage("The %s item is \"%s\"",
 868                      label, m_treeCtrl->GetItemText(new_item));
 869     }
 870 }
 871
 872 void MyFrame::OnScrollTo(wxCommandEvent& WXUNUSED(event))
 873 {
 874     // scroll to the last but one top level child
 875     wxTreeItemId item = m_treeCtrl->GetPrevSibling(
 876                             m_treeCtrl->GetLastChild(
 877                                 m_treeCtrl->GetRootItem()));
 878     CHECK_ITEM( item );
 879
 880     m_treeCtrl->ScrollTo(item);
 881 }
 882
 883 void MyFrame::OnSelectLast(wxCommandEvent& WXUNUSED(event))
 884 {
 885     // select the very last item of the tree
 886     wxTreeItemId item = m_treeCtrl->GetRootItem();
 887     for ( ;; )
 888     {
 889         wxTreeItemId itemChild = m_treeCtrl->GetLastChild(item);
 890         if ( !itemChild.IsOk() )
 891             break;
 892
 893         item = itemChild;
 894     }
 895
 896     CHECK_ITEM( item );
 897
 898     m_treeCtrl->SelectItem(item);
 899 }
 900
 901 void MyFrame::OnSetFgColour(wxCommandEvent& WXUNUSED(event))
 902 {
 903     wxColour col = wxGetColourFromUser(this, m_treeCtrl->GetForegroundColour());
 904     if ( col.IsOk() )
 905         m_treeCtrl->SetForegroundColour(col);
 906 }
 907
 908 void MyFrame::OnSetBgColour(wxCommandEvent& WXUNUSED(event))
 909 {
 910     wxColour col = wxGetColourFromUser(this, m_treeCtrl->GetBackgroundColour());
 911     if ( col.IsOk() )
 912         m_treeCtrl->SetBackgroundColour(col);
 913 }
 914
 915 // MyTreeCtrl implementation
 916 #if USE_GENERIC_TREECTRL
 917 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl, wxGenericTreeCtrl)
 918 #else
 919 IMPLEMENT_DYNAMIC_CLASS(MyTreeCtrl, wxTreeCtrl)
 920 #endif
 921
 922 MyTreeCtrl::MyTreeCtrl(wxWindow *parent, const wxWindowID id,
 923                        const wxPoint& pos, const wxSize& size,
 924                        long style)
 925           : wxTreeCtrl(parent, id, pos, size, style),
 926             m_alternateImages(false),
 927             m_alternateStates(false)
 928 {
 929     m_reverseSort = false;
 930
 931     CreateImageList();
 932     CreateStateImageList();
 933
 934     // Add some items to the tree
 935     AddTestItemsToTree(NUM_CHILDREN_PER_LEVEL, NUM_LEVELS);
 936 }
 937
 938 void MyTreeCtrl::CreateImageList(int size)
 939 {
 940     if ( size == -1 )
 941     {
 942         SetImageList(NULL);
 943         return;
 944     }
 945     if ( size == 0 )
 946         size = m_imageSize;
 947     else
 948         m_imageSize = size;
 949
 950     // Make an image list containing small icons
 951     wxImageList *images = new wxImageList(size, size, true);
 952
 953     // should correspond to TreeCtrlIcon_xxx enum
 954     wxBusyCursor wait;
 955     wxIcon icons[5];
 956
 957     if (m_alternateImages)
 958     {
 959         icons[TreeCtrlIcon_File] = wxIcon(icon1_xpm);
 960         icons[TreeCtrlIcon_FileSelected] = wxIcon(icon2_xpm);
 961         icons[TreeCtrlIcon_Folder] = wxIcon(icon3_xpm);
 962         icons[TreeCtrlIcon_FolderSelected] = wxIcon(icon4_xpm);
 963         icons[TreeCtrlIcon_FolderOpened] = wxIcon(icon5_xpm);
 964     }
 965     else
 966     {
 967         wxSize iconSize(size, size);
 968
 969         icons[TreeCtrlIcon_File] =
 970         icons[TreeCtrlIcon_FileSelected] = wxArtProvider::GetIcon(wxART_NORMAL_FILE, wxART_LIST, iconSize);
 971         icons[TreeCtrlIcon_Folder] =
 972         icons[TreeCtrlIcon_FolderSelected] =
 973         icons[TreeCtrlIcon_FolderOpened] = wxArtProvider::GetIcon(wxART_FOLDER, wxART_LIST, iconSize);
 974     }
 975
 976     for ( size_t i = 0; i < WXSIZEOF(icons); i++ )
 977     {
 978         int sizeOrig = icons[0].GetWidth();
 979         if ( size == sizeOrig )
 980         {
 981             images->Add(icons[i]);
 982         }
 983         else
 984         {
 985             images->Add(wxBitmap(wxBitmap(icons[i]).ConvertToImage().Rescale(size, size)));
 986         }
 987     }
 988
 989     AssignImageList(images);
 990 }
 991
 992 void MyTreeCtrl::CreateStateImageList(bool del)
 993 {
 994     if ( del )
 995     {
 996         SetStateImageList(NULL);
 997         return;
 998     }
 999
1000     wxImageList *states;
1001     wxBusyCursor wait;
1002
1003     if (m_alternateStates)
1004     {
1005         wxIcon icons[5];
1006         icons[0] = wxIcon(state1_xpm);  // yellow
1007         icons[1] = wxIcon(state2_xpm);  // green
1008         icons[2] = wxIcon(state3_xpm);  // red
1009         icons[3] = wxIcon(state4_xpm);  // blue
1010         icons[4] = wxIcon(state5_xpm);  // black
1011
1012         int width  = icons[0].GetWidth(),
1013             height = icons[0].GetHeight();
1014
1015         // Make an state image list containing small icons
1016         states = new wxImageList(width, height, true);
1017
1018         for ( size_t i = 0; i < WXSIZEOF(icons); i++ )
1019             states->Add(icons[i]);
1020     }
1021     else
1022     {
1023         wxIcon icons[2];
1024         icons[0] = wxIcon(unchecked_xpm);
1025         icons[1] = wxIcon(checked_xpm);
1026
1027         int width  = icons[0].GetWidth(),
1028             height = icons[0].GetHeight();
1029
1030         // Make an state image list containing small icons
1031         states = new wxImageList(width, height, true);
1032
1033         for ( size_t i = 0; i < WXSIZEOF(icons); i++ )
1034             states->Add(icons[i]);
1035     }
1036
1037     AssignStateImageList(states);
1038 }
1039
1040 #if USE_GENERIC_TREECTRL || !defined(__WXMSW__)
1041 void MyTreeCtrl::CreateButtonsImageList(int size)
1042 {
1043     if ( size == -1 )
1044     {
1045         SetButtonsImageList(NULL);
1046         return;
1047     }
1048
1049     // Make an image list containing small icons
1050     wxImageList *images = new wxImageList(size, size, true);
1051
1052     // should correspond to TreeCtrlIcon_xxx enum
1053     wxBusyCursor wait;
1054     wxIcon icons[4];
1055
1056     if (m_alternateImages)
1057     {
1058         icons[0] = wxIcon(icon3_xpm);   // closed
1059         icons[1] = wxIcon(icon3_xpm);   // closed, selected
1060         icons[2] = wxIcon(icon5_xpm);   // open
1061         icons[3] = wxIcon(icon5_xpm);   // open, selected
1062     }
1063     else
1064     {
1065         wxSize iconSize(size, size);
1066
1067         icons[0] =                                                                 // closed
1068         icons[1] = wxArtProvider::GetIcon(wxART_FOLDER, wxART_LIST, iconSize);     // closed, selected
1069         icons[2] =                                                                 // open
1070         icons[3] = wxArtProvider::GetIcon(wxART_FOLDER_OPEN, wxART_LIST, iconSize);// open, selected
1071     }
1072
1073    for ( size_t i = 0; i < WXSIZEOF(icons); i++ )
1074     {
1075         int sizeOrig = icons[i].GetWidth();
1076         if ( size == sizeOrig )
1077         {
1078             images->Add(icons[i]);
1079         }
1080         else
1081         {
1082             images->Add(wxBitmap(wxBitmap(icons[i]).ConvertToImage().Rescale(size, size)));
1083         }
1084     }
1085
1086     AssignButtonsImageList(images);
1087 #else
1088 void MyTreeCtrl::CreateButtonsImageList(int WXUNUSED(size))
1089 {
1090 #endif
1091 }
1092
1093 int MyTreeCtrl::OnCompareItems(const wxTreeItemId& item1,
1094                                const wxTreeItemId& item2)
1095 {
1096     if ( m_reverseSort )
1097     {
1098         // just exchange 1st and 2nd items
1099         return wxTreeCtrl::OnCompareItems(item2, item1);
1100     }
1101     else
1102     {
1103         return wxTreeCtrl::OnCompareItems(item1, item2);
1104     }
1105 }
1106
1107 void MyTreeCtrl::AddItemsRecursively(const wxTreeItemId& idParent,
1108                                      size_t numChildren,
1109                                      size_t depth,
1110                                      size_t folder)
1111 {
1112     if ( depth > 0 )
1113     {
1114         bool hasChildren = depth > 1;
1115
1116         wxString str;
1117         for ( size_t n = 0; n < numChildren; n++ )
1118         {
1119             // at depth 1 elements won't have any more children
1120             if ( hasChildren )
1121                 str.Printf(wxT("%s child %u"), wxT("Folder"), unsigned(n + 1));
1122             else
1123                 str.Printf(wxT("%s child %u.%u"), wxT("File"), unsigned(folder), unsigned(n + 1));
1124
1125             // here we pass to AppendItem() normal and selected item images (we
1126             // suppose that selected image follows the normal one in the enum)
1127             int image, imageSel;
1128             if ( wxGetApp().ShowImages() )
1129             {
1130                 image = depth == 1 ? TreeCtrlIcon_File : TreeCtrlIcon_Folder;
1131                 imageSel = image + 1;
1132             }
1133             else
1134             {
1135                 image = imageSel = -1;
1136             }
1137             wxTreeItemId id = AppendItem(idParent, str, image, imageSel,
1138                                          new MyTreeItemData(str));
1139
1140             if ( wxGetApp().ShowStates() )
1141                 SetItemState(id, 0);
1142
1143             // and now we also set the expanded one (only for the folders)
1144             if ( hasChildren && wxGetApp().ShowImages() )
1145             {
1146                 SetItemImage(id, TreeCtrlIcon_FolderOpened,
1147                              wxTreeItemIcon_Expanded);
1148             }
1149
1150             // remember the last child for OnEnsureVisible()
1151             if ( !hasChildren && n == numChildren - 1 )
1152             {
1153                 m_lastItem = id;
1154             }
1155
1156             AddItemsRecursively(id, numChildren, depth - 1, n + 1);
1157         }
1158     }
1159     //else: done!
1160 }
1161
1162 void MyTreeCtrl::AddTestItemsToTree(size_t numChildren,
1163                                     size_t depth)
1164 {
1165     int image = wxGetApp().ShowImages() ? MyTreeCtrl::TreeCtrlIcon_Folder : -1;
1166     wxTreeItemId rootId = AddRoot(wxT("Root"),
1167                                   image, image,
1168                                   new MyTreeItemData(wxT("Root item")));
1169     if ( !HasFlag(wxTR_HIDE_ROOT) && image != -1 )
1170     {
1171         SetItemImage(rootId, TreeCtrlIcon_FolderOpened, wxTreeItemIcon_Expanded);
1172     }
1173
1174     AddItemsRecursively(rootId, numChildren, depth, 0);
1175
1176     // set some colours/fonts for testing
1177     if ( !HasFlag(wxTR_HIDE_ROOT) )
1178         SetItemFont(rootId, *wxITALIC_FONT);
1179
1180     wxTreeItemIdValue cookie;
1181     wxTreeItemId id = GetFirstChild(rootId, cookie);
1182     SetItemTextColour(id, *wxBLUE);
1183
1184     id = GetNextChild(rootId, cookie);
1185     if ( id )
1186         id = GetNextChild(rootId, cookie);
1187     if ( id )
1188     {
1189         SetItemTextColour(id, *wxRED);
1190         SetItemBackgroundColour(id, *wxLIGHT_GREY);
1191     }
1192 }
1193
1194 void MyTreeCtrl::GetItemsRecursively(const wxTreeItemId& idParent,
1195                                      wxTreeItemIdValue cookie)
1196 {
1197     wxTreeItemId id;
1198
1199     if ( !cookie )
1200         id = GetFirstChild(idParent, cookie);
1201     else
1202         id = GetNextChild(idParent, cookie);
1203
1204     if ( !id.IsOk() )
1205         return;
1206
1207     wxString text = GetItemText(id);
1208     wxLogMessage(text);
1209
1210     if (ItemHasChildren(id))
1211         GetItemsRecursively(id);
1212
1213     GetItemsRecursively(idParent, cookie);
1214 }
1215
1216 void MyTreeCtrl::DoToggleIcon(const wxTreeItemId& item)
1217 {
1218     int image = GetItemImage(item) == TreeCtrlIcon_Folder
1219                     ? TreeCtrlIcon_File
1220                     : TreeCtrlIcon_Folder;
1221     SetItemImage(item, image, wxTreeItemIcon_Normal);
1222
1223     image = GetItemImage(item, wxTreeItemIcon_Selected) == TreeCtrlIcon_FolderSelected
1224                     ? TreeCtrlIcon_FileSelected
1225                     : TreeCtrlIcon_FolderSelected;
1226     SetItemImage(item, image, wxTreeItemIcon_Selected);
1227 }
1228
1229 void MyTreeCtrl::DoToggleState(const wxTreeItemId& item)
1230 {
1231     if ( m_alternateStates )
1232     {
1233         // sets random state unlike current
1234         int state = GetItemState(item);
1235         int nState;
1236
1237         srand (time(NULL));
1238         do {
1239             nState = rand() % GetStateImageList()->GetImageCount();
1240         } while (nState == state);
1241
1242         SetItemState(item, nState);
1243     }
1244     else
1245     {
1246         // we have only 2 checkbox states, so next state will be reversed
1247         SetItemState(item, wxTREE_ITEMSTATE_NEXT);
1248     }
1249 }
1250
1251 void MyTreeCtrl::DoResetBrokenStateImages(const wxTreeItemId& idParent,
1252                                           wxTreeItemIdValue cookie, int state)
1253 {
1254     wxTreeItemId id;
1255
1256     if ( !cookie )
1257         id = GetFirstChild(idParent, cookie);
1258     else
1259         id = GetNextChild(idParent, cookie);
1260
1261     if ( !id.IsOk() )
1262         return;
1263
1264     int curState = GetItemState(id);
1265     if ( curState != wxTREE_ITEMSTATE_NONE && curState > state )
1266         SetItemState(id, state);
1267
1268     if (ItemHasChildren(id))
1269         DoResetBrokenStateImages(id, 0, state);
1270
1271     DoResetBrokenStateImages(idParent, cookie, state);
1272 }
1273
1274 void MyTreeCtrl::LogEvent(const wxChar *name, const wxTreeEvent& event)
1275 {
1276     wxTreeItemId item = event.GetItem();
1277     wxString text;
1278     if ( item.IsOk() )
1279         text << wxT('"') << GetItemText(item).c_str() << wxT('"');
1280     else
1281         text = wxT("invalid item");
1282     wxLogMessage(wxT("%s(%s)"), name, text.c_str());
1283 }
1284
1285 // avoid repetition
1286 #define TREE_EVENT_HANDLER(name)                                 \
1287 void MyTreeCtrl::name(wxTreeEvent& event)                        \
1288 {                                                                \
1289     LogEvent(wxT(#name), event);                                  \
1290     SetLastItem(wxTreeItemId());                                 \
1291     event.Skip();                                                \
1292 }
1293
1294 TREE_EVENT_HANDLER(OnBeginRDrag)
1295 TREE_EVENT_HANDLER(OnDeleteItem)
1296 TREE_EVENT_HANDLER(OnGetInfo)
1297 TREE_EVENT_HANDLER(OnSetInfo)
1298 TREE_EVENT_HANDLER(OnItemExpanded)
1299 TREE_EVENT_HANDLER(OnItemExpanding)
1300 TREE_EVENT_HANDLER(OnItemCollapsed)
1301 TREE_EVENT_HANDLER(OnSelChanged)
1302 TREE_EVENT_HANDLER(OnSelChanging)
1303
1304 #undef TREE_EVENT_HANDLER
1305
1306 void LogKeyEvent(const wxChar *name, const wxKeyEvent& event)
1307 {
1308     wxString key;
1309     long keycode = event.GetKeyCode();
1310     {
1311         switch ( keycode )
1312         {
1313             case WXK_BACK: key = wxT("BACK"); break;
1314             case WXK_TAB: key = wxT("TAB"); break;
1315             case WXK_RETURN: key = wxT("RETURN"); break;
1316             case WXK_ESCAPE: key = wxT("ESCAPE"); break;
1317             case WXK_SPACE: key = wxT("SPACE"); break;
1318             case WXK_DELETE: key = wxT("DELETE"); break;
1319             case WXK_START: key = wxT("START"); break;
1320             case WXK_LBUTTON: key = wxT("LBUTTON"); break;
1321             case WXK_RBUTTON: key = wxT("RBUTTON"); break;
1322             case WXK_CANCEL: key = wxT("CANCEL"); break;
1323             case WXK_MBUTTON: key = wxT("MBUTTON"); break;
1324             case WXK_CLEAR: key = wxT("CLEAR"); break;
1325             case WXK_SHIFT: key = wxT("SHIFT"); break;
1326             case WXK_ALT: key = wxT("ALT"); break;
1327             case WXK_CONTROL: key = wxT("CONTROL"); break;
1328             case WXK_MENU: key = wxT("MENU"); break;
1329             case WXK_PAUSE: key = wxT("PAUSE"); break;
1330             case WXK_CAPITAL: key = wxT("CAPITAL"); break;
1331             case WXK_END: key = wxT("END"); break;
1332             case WXK_HOME: key = wxT("HOME"); break;
1333             case WXK_LEFT: key = wxT("LEFT"); break;
1334             case WXK_UP: key = wxT("UP"); break;
1335             case WXK_RIGHT: key = wxT("RIGHT"); break;
1336             case WXK_DOWN: key = wxT("DOWN"); break;
1337             case WXK_SELECT: key = wxT("SELECT"); break;
1338             case WXK_PRINT: key = wxT("PRINT"); break;
1339             case WXK_EXECUTE: key = wxT("EXECUTE"); break;
1340             case WXK_SNAPSHOT: key = wxT("SNAPSHOT"); break;
1341             case WXK_INSERT: key = wxT("INSERT"); break;
1342             case WXK_HELP: key = wxT("HELP"); break;
1343             case WXK_NUMPAD0: key = wxT("NUMPAD0"); break;
1344             case WXK_NUMPAD1: key = wxT("NUMPAD1"); break;
1345             case WXK_NUMPAD2: key = wxT("NUMPAD2"); break;
1346             case WXK_NUMPAD3: key = wxT("NUMPAD3"); break;
1347             case WXK_NUMPAD4: key = wxT("NUMPAD4"); break;
1348             case WXK_NUMPAD5: key = wxT("NUMPAD5"); break;
1349             case WXK_NUMPAD6: key = wxT("NUMPAD6"); break;
1350             case WXK_NUMPAD7: key = wxT("NUMPAD7"); break;
1351             case WXK_NUMPAD8: key = wxT("NUMPAD8"); break;
1352             case WXK_NUMPAD9: key = wxT("NUMPAD9"); break;
1353             case WXK_MULTIPLY: key = wxT("MULTIPLY"); break;
1354             case WXK_ADD: key = wxT("ADD"); break;
1355             case WXK_SEPARATOR: key = wxT("SEPARATOR"); break;
1356             case WXK_SUBTRACT: key = wxT("SUBTRACT"); break;
1357             case WXK_DECIMAL: key = wxT("DECIMAL"); break;
1358             case WXK_DIVIDE: key = wxT("DIVIDE"); break;
1359             case WXK_F1: key = wxT("F1"); break;
1360             case WXK_F2: key = wxT("F2"); break;
1361             case WXK_F3: key = wxT("F3"); break;
1362             case WXK_F4: key = wxT("F4"); break;
1363             case WXK_F5: key = wxT("F5"); break;
1364             case WXK_F6: key = wxT("F6"); break;
1365             case WXK_F7: key = wxT("F7"); break;
1366             case WXK_F8: key = wxT("F8"); break;
1367             case WXK_F9: key = wxT("F9"); break;
1368             case WXK_F10: key = wxT("F10"); break;
1369             case WXK_F11: key = wxT("F11"); break;
1370             case WXK_F12: key = wxT("F12"); break;
1371             case WXK_F13: key = wxT("F13"); break;
1372             case WXK_F14: key = wxT("F14"); break;
1373             case WXK_F15: key = wxT("F15"); break;
1374             case WXK_F16: key = wxT("F16"); break;
1375             case WXK_F17: key = wxT("F17"); break;
1376             case WXK_F18: key = wxT("F18"); break;
1377             case WXK_F19: key = wxT("F19"); break;
1378             case WXK_F20: key = wxT("F20"); break;
1379             case WXK_F21: key = wxT("F21"); break;
1380             case WXK_F22: key = wxT("F22"); break;
1381             case WXK_F23: key = wxT("F23"); break;
1382             case WXK_F24: key = wxT("F24"); break;
1383             case WXK_NUMLOCK: key = wxT("NUMLOCK"); break;
1384             case WXK_SCROLL: key = wxT("SCROLL"); break;
1385             case WXK_PAGEUP: key = wxT("PAGEUP"); break;
1386             case WXK_PAGEDOWN: key = wxT("PAGEDOWN"); break;
1387             case WXK_NUMPAD_SPACE: key = wxT("NUMPAD_SPACE"); break;
1388             case WXK_NUMPAD_TAB: key = wxT("NUMPAD_TAB"); break;
1389             case WXK_NUMPAD_ENTER: key = wxT("NUMPAD_ENTER"); break;
1390             case WXK_NUMPAD_F1: key = wxT("NUMPAD_F1"); break;
1391             case WXK_NUMPAD_F2: key = wxT("NUMPAD_F2"); break;
1392             case WXK_NUMPAD_F3: key = wxT("NUMPAD_F3"); break;
1393             case WXK_NUMPAD_F4: key = wxT("NUMPAD_F4"); break;
1394             case WXK_NUMPAD_HOME: key = wxT("NUMPAD_HOME"); break;
1395             case WXK_NUMPAD_LEFT: key = wxT("NUMPAD_LEFT"); break;
1396             case WXK_NUMPAD_UP: key = wxT("NUMPAD_UP"); break;
1397             case WXK_NUMPAD_RIGHT: key = wxT("NUMPAD_RIGHT"); break;
1398             case WXK_NUMPAD_DOWN: key = wxT("NUMPAD_DOWN"); break;
1399             case WXK_NUMPAD_PAGEUP: key = wxT("NUMPAD_PAGEUP"); break;
1400             case WXK_NUMPAD_PAGEDOWN: key = wxT("NUMPAD_PAGEDOWN"); break;
1401             case WXK_NUMPAD_END: key = wxT("NUMPAD_END"); break;
1402             case WXK_NUMPAD_BEGIN: key = wxT("NUMPAD_BEGIN"); break;
1403             case WXK_NUMPAD_INSERT: key = wxT("NUMPAD_INSERT"); break;
1404             case WXK_NUMPAD_DELETE: key = wxT("NUMPAD_DELETE"); break;
1405             case WXK_NUMPAD_EQUAL: key = wxT("NUMPAD_EQUAL"); break;
1406             case WXK_NUMPAD_MULTIPLY: key = wxT("NUMPAD_MULTIPLY"); break;
1407             case WXK_NUMPAD_ADD: key = wxT("NUMPAD_ADD"); break;
1408             case WXK_NUMPAD_SEPARATOR: key = wxT("NUMPAD_SEPARATOR"); break;
1409             case WXK_NUMPAD_SUBTRACT: key = wxT("NUMPAD_SUBTRACT"); break;
1410             case WXK_NUMPAD_DECIMAL: key = wxT("NUMPAD_DECIMAL"); break;
1411
1412             default:
1413             {
1414                if ( keycode < 128 && wxIsprint((int)keycode) )
1415                    key.Printf(wxT("'%c'"), (char)keycode);
1416                else if ( keycode > 0 && keycode < 27 )
1417                    key.Printf(_("Ctrl-%c"), wxT('A') + keycode - 1);
1418                else
1419                    key.Printf(wxT("unknown (%ld)"), keycode);
1420             }
1421         }
1422     }
1423
1424     wxLogMessage( wxT("%s event: %s (flags = %c%c%c%c)"),
1425                   name,
1426                   key.c_str(),
1427                   event.ControlDown() ? wxT('C') : wxT('-'),
1428                   event.AltDown() ? wxT('A') : wxT('-'),
1429                   event.ShiftDown() ? wxT('S') : wxT('-'),
1430                   event.MetaDown() ? wxT('M') : wxT('-'));
1431 }
1432
1433 void MyTreeCtrl::OnTreeKeyDown(wxTreeEvent& event)
1434 {
1435     LogKeyEvent(wxT("Tree key down "), event.GetKeyEvent());
1436
1437     event.Skip();
1438 }
1439
1440 void MyTreeCtrl::OnBeginDrag(wxTreeEvent& event)
1441 {
1442     // need to explicitly allow drag
1443     if ( event.GetItem() != GetRootItem() )
1444     {
1445         m_draggedItem = event.GetItem();
1446
1447         wxPoint clientpt = event.GetPoint();
1448         wxPoint screenpt = ClientToScreen(clientpt);
1449
1450         wxLogMessage(wxT("OnBeginDrag: started dragging %s at screen coords (%i,%i)"),
1451                      GetItemText(m_draggedItem).c_str(),
1452                      screenpt.x, screenpt.y);
1453
1454         event.Allow();
1455     }
1456     else
1457     {
1458         wxLogMessage(wxT("OnBeginDrag: this item can't be dragged."));
1459     }
1460 }
1461
1462 void MyTreeCtrl::OnEndDrag(wxTreeEvent& event)
1463 {
1464     wxTreeItemId itemSrc = m_draggedItem,
1465                  itemDst = event.GetItem();
1466     m_draggedItem = (wxTreeItemId)0l;
1467
1468     // where to copy the item?
1469     if ( itemDst.IsOk() && !ItemHasChildren(itemDst) )
1470     {
1471         // copy to the parent then
1472         itemDst = GetItemParent(itemDst);
1473     }
1474
1475     if ( !itemDst.IsOk() )
1476     {
1477         wxLogMessage(wxT("OnEndDrag: can't drop here."));
1478
1479         return;
1480     }
1481
1482     wxString text = GetItemText(itemSrc);
1483     wxLogMessage(wxT("OnEndDrag: '%s' copied to '%s'."),
1484                  text.c_str(), GetItemText(itemDst).c_str());
1485
1486     // just do append here - we could also insert it just before/after the item
1487     // on which it was dropped, but this requires slightly more work... we also
1488     // completely ignore the client data and icon of the old item but could
1489     // copy them as well.
1490     //
1491     // Finally, we only copy one item here but we might copy the entire tree if
1492     // we were dragging a folder.
1493     int image = wxGetApp().ShowImages() ? TreeCtrlIcon_File : -1;
1494     wxTreeItemId id = AppendItem(itemDst, text, image);
1495
1496     if ( wxGetApp().ShowStates() )
1497         SetItemState(id, GetItemState(itemSrc));
1498 }
1499
1500 void MyTreeCtrl::OnBeginLabelEdit(wxTreeEvent& event)
1501 {
1502     wxLogMessage(wxT("OnBeginLabelEdit"));
1503
1504     // for testing, prevent this item's label editing
1505     wxTreeItemId itemId = event.GetItem();
1506     if ( IsTestItem(itemId) )
1507     {
1508         wxMessageBox(wxT("You can't edit this item."));
1509
1510         event.Veto();
1511     }
1512     else if ( itemId == GetRootItem() )
1513     {
1514         // test that it is possible to change the text of the item being edited
1515         SetItemText(itemId, wxT("Editing root item"));
1516     }
1517 }
1518
1519 void MyTreeCtrl::OnEndLabelEdit(wxTreeEvent& event)
1520 {
1521     wxLogMessage(wxT("OnEndLabelEdit"));
1522
1523     // don't allow anything except letters in the labels
1524     if ( !event.GetLabel().IsWord() )
1525     {
1526         wxMessageBox(wxT("The new label should be a single word."));
1527
1528         event.Veto();
1529     }
1530 }
1531
1532 void MyTreeCtrl::OnItemCollapsing(wxTreeEvent& event)
1533 {
1534     wxLogMessage(wxT("OnItemCollapsing"));
1535
1536     // for testing, prevent the user from collapsing the first child folder
1537     wxTreeItemId itemId = event.GetItem();
1538     if ( IsTestItem(itemId) )
1539     {
1540         wxMessageBox(wxT("You can't collapse this item."));
1541
1542         event.Veto();
1543     }
1544 }
1545
1546 void MyTreeCtrl::OnItemActivated(wxTreeEvent& event)
1547 {
1548     // show some info about this item
1549     wxTreeItemId itemId = event.GetItem();
1550     MyTreeItemData *item = (MyTreeItemData *)GetItemData(itemId);
1551
1552     if ( item != NULL )
1553     {
1554         item->ShowInfo(this);
1555     }
1556
1557     wxLogMessage(wxT("OnItemActivated"));
1558 }
1559
1560 void MyTreeCtrl::OnItemStateClick(wxTreeEvent& event)
1561 {
1562     // toggle item state
1563     wxTreeItemId itemId = event.GetItem();
1564     DoToggleState(itemId);
1565
1566     wxLogMessage(wxT("Item \"%s\" state changed to %d"),
1567                  GetItemText(itemId), GetItemState(itemId));
1568 }
1569
1570 void MyTreeCtrl::OnItemMenu(wxTreeEvent& event)
1571 {
1572     wxTreeItemId itemId = event.GetItem();
1573     wxCHECK_RET( itemId.IsOk(), "should have a valid item" );
1574
1575     MyTreeItemData *item = (MyTreeItemData *)GetItemData(itemId);
1576     wxPoint clientpt = event.GetPoint();
1577     wxPoint screenpt = ClientToScreen(clientpt);
1578
1579     wxLogMessage(wxT("OnItemMenu for item \"%s\" at screen coords (%i, %i)"),
1580                  item->GetDesc(), screenpt.x, screenpt.y);
1581
1582     ShowMenu(itemId, clientpt);
1583     event.Skip();
1584 }
1585
1586 void MyTreeCtrl::OnContextMenu(wxContextMenuEvent& event)
1587 {
1588     wxPoint pt = event.GetPosition();
1589
1590     wxLogMessage(wxT("OnContextMenu at screen coords (%i, %i)"), pt.x, pt.y);
1591
1592     event.Skip();
1593 }
1594
1595 void MyTreeCtrl::ShowMenu(wxTreeItemId id, const wxPoint& pt)
1596 {
1597     wxString title;
1598     if ( id.IsOk() )
1599     {
1600         title << wxT("Menu for ") << GetItemText(id);
1601     }
1602     else
1603     {
1604         title = wxT("Menu for no particular item");
1605     }
1606
1607 #if wxUSE_MENUS
1608     wxMenu menu(title);
1609     menu.Append(TreeTest_About, wxT("&About..."));
1610     menu.AppendSeparator();
1611     menu.Append(TreeTest_Highlight, wxT("&Highlight item"));
1612     menu.Append(TreeTest_Dump, wxT("&Dump"));
1613
1614     PopupMenu(&menu, pt);
1615 #endif // wxUSE_MENUS
1616 }
1617
1618 void MyTreeCtrl::OnItemRClick(wxTreeEvent& event)
1619 {
1620     wxTreeItemId itemId = event.GetItem();
1621     wxCHECK_RET( itemId.IsOk(), "should have a valid item" );
1622
1623     MyTreeItemData *item = (MyTreeItemData *)GetItemData(itemId);
1624
1625     wxLogMessage(wxT("Item \"%s\" right clicked"), item->GetDesc());
1626
1627     event.Skip();
1628 }
1629
1630 void MyTreeCtrl::OnRMouseDown(wxMouseEvent& event)
1631 {
1632     wxLogMessage(wxT("Right mouse button down"));
1633
1634     event.Skip();
1635 }
1636
1637 void MyTreeCtrl::OnRMouseUp(wxMouseEvent& event)
1638 {
1639     wxLogMessage(wxT("Right mouse button up"));
1640
1641     event.Skip();
1642 }
1643
1644 void MyTreeCtrl::OnRMouseDClick(wxMouseEvent& event)
1645 {
1646     wxTreeItemId id = HitTest(event.GetPosition());
1647     if ( !id )
1648     {
1649         wxLogMessage(wxT("No item under mouse"));
1650     }
1651     else
1652     {
1653         MyTreeItemData *item = (MyTreeItemData *)GetItemData(id);
1654         if ( item )
1655         {
1656             wxLogMessage(wxT("Item '%s' under mouse"), item->GetDesc());
1657         }
1658     }
1659
1660     event.Skip();
1661 }
1662
1663 static inline const wxChar *Bool2String(bool b)
1664 {
1665     return b ? wxT("") : wxT("not ");
1666 }
1667
1668 void MyTreeItemData::ShowInfo(wxTreeCtrl *tree)
1669 {
1670     wxLogMessage(wxT("Item '%s': %sselected, %sexpanded, %sbold,\n")
1671                  wxT("%u children (%u immediately under this item)."),
1672                  m_desc.c_str(),
1673                  Bool2String(tree->IsSelected(GetId())),
1674                  Bool2String(tree->IsExpanded(GetId())),
1675                  Bool2String(tree->IsBold(GetId())),
1676                  unsigned(tree->GetChildrenCount(GetId())),
1677                  unsigned(tree->GetChildrenCount(GetId(), false)));
1678 }