-
Notifications
You must be signed in to change notification settings - Fork 47
/
TreeView.cpp
634 lines (517 loc) · 14.3 KB
/
TreeView.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
#include "TreeView.h"
#include "i18n.h"
#include <wx/eventfilter.h>
#include <wx/bmpbuttn.h>
#include <wx/popupwin.h>
#include <wx/stattext.h>
#include <wx/app.h>
#include <wx/sizer.h>
#include <wx/timer.h>
#include "wxutil/Bitmap.h"
#include <wx/textctrl.h>
namespace wxutil
{
namespace
{
const int MSECS_TO_AUTO_CLOSE_POPUP = 6000;
}
class TreeView::Search :
public wxEvtHandler
{
private:
TreeView& _treeView;
SearchPopupWindow* _popup;
wxDataViewItem _curSearchMatch;
wxTimer _closeTimer;
public:
Search(TreeView& treeView);
~Search();
SearchPopupWindow* GetPopupWindow();
void HandleKeyEvent(wxKeyEvent& ev);
void HighlightNextMatch();
void HighlightPrevMatch();
void Close();
private:
void HighlightMatch(const wxDataViewItem& item);
void _onIntervalReached(wxTimerEvent& ev);
void _onTreeViewCharHook(wxKeyEvent& keyEvent);
};
TreeView::TreeView(wxWindow* parent, wxDataViewModel* model, long style) :
wxDataViewCtrl(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, style),
_collapseRecursively(true)
{
EnableAutoColumnWidthFix();
if (model)
{
AssociateModel(model);
}
Bind(wxEVT_CHAR, &TreeView::_onChar, this);
Bind(wxEVT_DATAVIEW_ITEM_ACTIVATED, &TreeView::_onItemActivated, this);
Bind(wxEVT_DATAVIEW_ITEM_COLLAPSING, &TreeView::_onItemCollapsing, this);
}
TreeView* TreeView::Create(wxWindow* parent, long style)
{
return new TreeView(parent, nullptr, style);
}
TreeView* TreeView::CreateWithModel(wxWindow* parent, wxDataViewModel* model, long style)
{
return new TreeView(parent, model, style);
}
TreeView::~TreeView()
{}
bool TreeView::AssociateModel(wxDataViewModel* model)
{
// We're changing models, so unselect everything first,
// even if it's the same model again, the tree might have changed.
UnselectAll();
#ifdef __WXGTK__
// In case EnsureVisible has been called in the past with no idle event
// in between, the wxDataViewCtrl::m_ensureVisibleDefered member will
// still be pointing to the old tree model.
// The member is set in EnsureVisible and cleared only after processing,
// so the idle event would be running into a stale pointer crash.
// Call EnsureVisible() with an not-OK item to clear it before switching models.
if (GetModel() != nullptr)
{
EnsureVisible(wxDataViewItem(nullptr));
}
#endif
// Pass the call to the regular routine
return wxDataViewCtrl::AssociateModel(model);
}
// Enable the automatic recalculation of column widths
void TreeView::EnableAutoColumnWidthFix(bool enable)
{
if (enable)
{
Bind(wxEVT_DATAVIEW_ITEM_EXPANDED, &TreeView::_onItemExpanded, this);
}
else
{
Unbind(wxEVT_DATAVIEW_ITEM_EXPANDED, &TreeView::_onItemExpanded, this);
}
}
void TreeView::TriggerColumnSizeEvent(const wxDataViewItem& item)
{
if (GetModel() == nullptr) return;
// Trigger a column size event on the first row
wxDataViewItemArray children;
GetModel()->GetChildren(item, children);
for (const auto& child : children)
{
GetModel()->ItemChanged(child);
}
}
void TreeView::ExpandTopLevelItems()
{
TreeModel* model = dynamic_cast<TreeModel*>(GetModel());
if (model == nullptr) return;
// Expand the first layer
wxDataViewItemArray children;
model->GetChildren(model->GetRoot(), children);
for (const auto& item : children)
{
Expand(item);
}
}
void TreeView::EnableRecursiveCollapse(bool enabled)
{
_collapseRecursively = enabled;
}
void TreeView::ResetSortingOnAllColumns()
{
#if wxCHECK_VERSION(3, 1, 0) && defined(__WXMSW__ )
ResetAllSortColumns();
#else
// We don't have ResetAllSortColumns in wxWidgets 3.0.x
wxDataViewColumn* col = GetSortingColumn();
if (col != nullptr)
{
col->UnsetAsSortKey();
}
#endif
}
void TreeView::AddSearchColumn(const TreeModel::Column& column)
{
// Only text columns are supported right now
assert(column.type == TreeModel::Column::String || column.type == TreeModel::Column::IconText);
_colsToSearch.push_back(column);
}
bool TreeView::HasActiveSearchPopup()
{
return _search != nullptr;
}
#if !defined(__linux__)
void TreeView::Rebuild()
{
TreeModel* model = dynamic_cast<TreeModel*>(GetModel());
if (model == nullptr) return;
// Trigger a rebuild of the tree
wxDataViewItemArray children;
wxDataViewItem root = model->GetRoot();
model->GetChildren(root, children);
// By calling deleted and added, the internal dataview's nodes
// are invalidated which effectively is a rebuild of everything.
for (auto child : children)
{
model->ItemDeleted(root, child);
model->ItemAdded(root, child);
}
}
#endif
void TreeView::SendSelectionChangeEvent(const wxDataViewItem& item)
{
// In wxWidgets 3.1.x the wxDataViewEvent constructors have changed, switch on it
#if wxCHECK_VERSION(3, 1, 0)
wxDataViewEvent le(wxEVT_DATAVIEW_SELECTION_CHANGED, this, item);
#else
wxDataViewEvent le(wxEVT_DATAVIEW_SELECTION_CHANGED, GetId());
le.SetEventObject(this);
le.SetModel(GetModel());
le.SetItem(item);
#endif
ProcessWindowEvent(le);
}
void TreeView::CollapseChildren(const wxDataViewItem& item)
{
// Collapse all children that are currently expanded
wxDataViewItemArray children;
GetModel()->GetChildren(item, children);
for (const auto& child : children)
{
if (IsExpanded(child))
{
Collapse(child);
}
}
}
void TreeView::_onItemCollapsing(wxDataViewEvent& ev)
{
ev.Skip();
if (_collapseRecursively && GetModel() != nullptr)
{
CollapseChildren(ev.GetItem());
return;
}
}
void TreeView::_onItemExpanded(wxDataViewEvent& ev)
{
// This should force a recalculation of the column width
if (GetModel() != nullptr)
{
GetModel()->ItemChanged(ev.GetItem());
}
ev.Skip();
}
void TreeView::_onItemActivated(wxDataViewEvent& ev)
{
if (!IsExpanded(ev.GetItem()))
{
Expand(ev.GetItem());
}
else
{
Collapse(ev.GetItem());
}
}
// The custom popup window containing our search box
class TreeView::SearchPopupWindow :
public wxPopupWindow,
public wxEventFilter
{
private:
TreeView* _treeView;
Search& _owner;
wxTextCtrl* _entry;
public:
SearchPopupWindow(TreeView* treeView, Search& owner) :
wxPopupWindow(treeView, wxBORDER_SIMPLE),
_treeView(treeView),
_owner(owner),
_entry(nullptr)
{
SetSizer(new wxBoxSizer(wxHORIZONTAL));
auto label = new wxStaticText(this, wxID_ANY, _("Find: "));
_entry = new wxTextCtrl(this, wxID_ANY);
auto nextImg = wxutil::GetLocalBitmap("arrow_down.png");
auto nextButton = new wxBitmapButton(this, wxID_ANY, nextImg);
auto prevImg = wxutil::GetLocalBitmap("arrow_up.png");
auto prevButton = new wxBitmapButton(this, wxID_ANY, prevImg);
nextButton->SetSize(wxSize(16, 16));
prevButton->SetSize(wxSize(16, 16));
nextButton->SetToolTip(_("Go to next match"));
prevButton->SetToolTip(_("Go to previous match"));
nextButton->Bind(wxEVT_BUTTON, [this] (wxCommandEvent& ev) { _owner.HighlightNextMatch(); });
prevButton->Bind(wxEVT_BUTTON, [this] (wxCommandEvent& ev) { _owner.HighlightPrevMatch(); });
GetSizer()->Add(label, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 6);
GetSizer()->Add(_entry, 1, wxEXPAND | wxALL, 6);
GetSizer()->Add(prevButton, 0, wxEXPAND | wxRIGHT | wxTOP | wxBOTTOM, 6);
GetSizer()->Add(nextButton, 0, wxEXPAND | wxRIGHT | wxTOP | wxBOTTOM, 6);
Layout();
Fit();
Reposition();
// Subscribe to the parent window's visibility and iconise events to avoid
// the popup from lingering around long after the tree is gone (#5095)
wxWindow* parentWindow = wxGetTopLevelParent(treeView);
if (parentWindow != nullptr)
{
parentWindow->Bind(wxEVT_SHOW, &SearchPopupWindow::_onParentVisibilityChanged, this);
parentWindow->Bind(wxEVT_ICONIZE, &SearchPopupWindow::_onParentMinimized, this);
// Detect when the parent window is losing focus (e.g. by alt-tabbing)
parentWindow->Bind(wxEVT_ACTIVATE, &SearchPopupWindow::_onParentActivate, this);
// Detect parent window movements to reposition ourselves
parentWindow->Bind(wxEVT_MOVE, &SearchPopupWindow::_onParentMoved, this);
}
// Register as global filter to catch mouse events
wxEvtHandler::AddFilter(this);
}
virtual ~SearchPopupWindow()
{
wxEvtHandler::RemoveFilter(this);
}
int FilterEvent(wxEvent& ev) override
{
const wxEventType t = ev.GetEventType();
if (t == wxEVT_LEFT_UP || t == wxEVT_RIGHT_UP)
{
for (wxWindow* win = wxDynamicCast(ev.GetEventObject(), wxWindow);
win != nullptr; win = win->GetParent())
{
if (win == this || win == _treeView)
{
// Ignore any clicks on this popup or the owning treeview
return Event_Skip;
}
}
// User clicked on a window which is not a child of this popup => close it
// But we can't call _owner.Close() immediately since this
// will fire the destructor and crash the event filter handler
// Register for the next idle event to close this popup
wxTheApp->Bind(wxEVT_IDLE, &SearchPopupWindow::_onIdleClose, this);
}
// Continue processing the event normally
return Event_Skip;
}
wxString GetSearchString()
{
return _entry->GetValue();
}
void SetSearchString(const wxString& str)
{
_entry->SetValue(str);
}
private:
void Reposition()
{
// Position this control in the bottom right corner
wxPoint popupPos = GetParent()->GetScreenPosition() + GetParent()->GetSize() - GetSize();
Position(popupPos, wxSize(0, 0));
}
void _onIdleClose(wxIdleEvent& ev)
{
_owner.Close();
ev.Skip();
}
void _onParentActivate(wxActivateEvent& ev)
{
if (!ev.GetActive())
{
_owner.Close();
}
}
void _onParentMoved(wxMoveEvent&)
{
Reposition();
}
void _onParentMinimized(wxIconizeEvent&)
{
// Close any searches when the parent window is minimized
_owner.Close();
}
void _onParentVisibilityChanged(wxShowEvent& ev)
{
if (!ev.IsShown())
{
// Close any searches when the parent window is hidden
_owner.Close();
}
}
};
TreeView::Search::Search(TreeView& treeView) :
_treeView(treeView),
_closeTimer(this)
{
_popup = new SearchPopupWindow(&_treeView, *this);
_popup->Show();
_curSearchMatch = wxDataViewItem();
_treeView.Bind(wxEVT_CHAR_HOOK, &Search::_onTreeViewCharHook, this);
Bind(wxEVT_TIMER, &Search::_onIntervalReached, this);
_closeTimer.Start(MSECS_TO_AUTO_CLOSE_POPUP);
}
TreeView::Search::~Search()
{
_closeTimer.Stop();
_treeView.Unbind(wxEVT_CHAR_HOOK, &Search::_onTreeViewCharHook, this);
Unbind(wxEVT_TIMER, &Search::_onIntervalReached, this);
// Always hide popup windows before destroying them, otherwise the
// wx-internal wxCurrentPopupWindow pointer doesn't get cleared (in MSW at least)
_popup->Hide();
_popup->Destroy();
_popup = nullptr;
_curSearchMatch = wxDataViewItem();
}
void TreeView::Search::_onTreeViewCharHook(wxKeyEvent& ev)
{
if (ev.GetKeyCode() == WXK_ESCAPE)
{
// The parent dialog listens to ESC keys to close the window
// While this search window is alive, eat the event and close the popup instead
_treeView.CloseSearch();
return;
}
ev.Skip();
}
void TreeView::Search::_onIntervalReached(wxTimerEvent& ev)
{
// Disconnect the timing event
_closeTimer.Stop();
_treeView.CloseSearch();
}
void TreeView::Search::HighlightMatch(const wxDataViewItem& item)
{
_closeTimer.Start(MSECS_TO_AUTO_CLOSE_POPUP); // restart
_curSearchMatch = item;
_treeView.JumpToSearchMatch(_curSearchMatch);
}
TreeView::SearchPopupWindow* TreeView::Search::GetPopupWindow()
{
return _popup;
}
void TreeView::Search::HandleKeyEvent(wxKeyEvent& ev)
{
TreeModel* model = dynamic_cast<TreeModel*>(_treeView.GetModel());
if (model == nullptr)
{
ev.Skip();
return;
}
// Adapted this from the wxWidgets docs
wxChar uc = ev.GetUnicodeKey();
if (uc != WXK_NONE)
{
// It's a "normal" character. Notice that this includes
// control characters in 1..31 range, e.g. WXK_RETURN or
// WXK_BACK, so check for them explicitly.
if (uc >= 32)
{
_popup->SetSearchString(_popup->GetSearchString() + ev.GetUnicodeKey());
HighlightMatch(model->FindNextString(_popup->GetSearchString(), _treeView._colsToSearch));
}
else if (ev.GetKeyCode() == WXK_ESCAPE)
{
_treeView.CloseSearch();
}
else if (ev.GetKeyCode() == WXK_BACK)
{
_popup->SetSearchString(_popup->GetSearchString().RemoveLast(1));
HighlightMatch(model->FindNextString(_popup->GetSearchString(), _treeView._colsToSearch));
}
else
{
ev.Skip();
}
}
// No Unicode equivalent, might be an arrow key
else if (ev.GetKeyCode() == WXK_UP)
{
HighlightPrevMatch();
}
else if (ev.GetKeyCode() == WXK_DOWN)
{
HighlightNextMatch();
}
else
{
ev.Skip();
}
}
void TreeView::Search::HighlightNextMatch()
{
TreeModel* model = dynamic_cast<TreeModel*>(_treeView.GetModel());
if (model == nullptr)
{
return;
}
HighlightMatch(model->FindNextString(_popup->GetSearchString(), _treeView._colsToSearch, _curSearchMatch));
}
void TreeView::Search::HighlightPrevMatch()
{
TreeModel* model = dynamic_cast<TreeModel*>(_treeView.GetModel());
if (model == nullptr)
{
return;
}
HighlightMatch(model->FindPrevString(_popup->GetSearchString(), _treeView._colsToSearch, _curSearchMatch));
}
void TreeView::Search::Close()
{
_treeView.CloseSearch();
}
void TreeView::CloseSearch()
{
_search.reset();
}
void TreeView::_onChar(wxKeyEvent& ev)
{
if (GetModel() == nullptr || _colsToSearch.empty())
{
ev.Skip();
return;
}
// Adapted this from the wxWidgets docs
wxChar uc = ev.GetUnicodeKey();
// Start a search operation on any "normal" character
if (uc != WXK_NONE && uc >= 32 && !_search)
{
_search = std::make_unique<Search>(*this);
}
if (_search)
{
// Forward the key event to the search helper
_search->HandleKeyEvent(ev);
}
else
{
// Don't eat the event
ev.Skip();
}
}
void TreeView::JumpToSearchMatch(const wxDataViewItem& item)
{
TreeModel* model = dynamic_cast<TreeModel*>(GetModel());
if (model == nullptr)
{
return;
}
if (GetSelection() != item && item.IsOk())
{
UnselectAll();
Select(item);
EnsureVisible(item);
#ifdef __WXMSW__
// #5511: Avoid the search box blocking the found item
auto itemRect = GetItemRect(item);
ClientToScreen(&itemRect.x, &itemRect.y);
if (_search && _search->GetPopupWindow() != nullptr &&
_search->GetPopupWindow()->GetRect().Intersects(itemRect))
{
// Scroll down by two rows
int itemRow = GetRowByItem(item);
EnsureVisibleRowCol(itemRow + 2, 0);
}
#endif
// Synthesise a selection changed signal
SendSelectionChangeEvent(item);
}
}
} // namespace