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