-
Notifications
You must be signed in to change notification settings - Fork 47
/
ResourceTreeView.cpp
419 lines (331 loc) · 11 KB
/
ResourceTreeView.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
#include "ResourceTreeView.h"
#include "i18n.h"
#include "ifavourites.h"
#include "../menu/IconTextMenuItem.h"
#include "TreeViewItemStyle.h"
namespace wxutil
{
namespace
{
const char* const ADD_TO_FAVOURITES = N_("Add to Favourites");
const char* const REMOVE_FROM_FAVOURITES = N_("Remove from Favourites");
const char* const ICON_LOADING = "icon_classname.png";
}
ResourceTreeView::ResourceTreeView(wxWindow* parent, const ResourceTreeView::Columns& columns, long style) :
ResourceTreeView(parent, TreeModel::Ptr(), columns, style)
{}
ResourceTreeView::ResourceTreeView(wxWindow* parent, const TreeModel::Ptr& model,
const ResourceTreeView::Columns& columns, long style) :
TreeView(parent, nullptr, style), // associate the model later
_columns(columns),
_mode(TreeMode::ShowAll),
_expandTopLevelItemsAfterPopulation(false),
_declType(decl::Type::None)
{
// Note that we need to avoid accessing the _columns reference in the constructor
// since it is likely owned by subclasses and might not be ready yet
_treeStore = model;
if (!_treeStore)
{
// Create an empty default model
_treeStore.reset(new TreeModel(_columns));
}
AssociateModel(_treeStore.get());
Bind(wxEVT_DATAVIEW_ITEM_CONTEXT_MENU, &ResourceTreeView::_onContextMenu, this);
Bind(EV_TREEMODEL_POPULATION_FINISHED, &ResourceTreeView::_onTreeStorePopulationFinished, this);
}
ResourceTreeView::~ResourceTreeView()
{
if (_populator)
{
// This call isn't strictly necessary if the implementing thread
// populators are equipped with proper destructors.
// In case some user code is missing such a CancelAndWait call in their
// destructor, let's call it here while the object is still intact.
_populator->EnsureStopped();
_populator.reset();
}
}
const TreeModel::Ptr& ResourceTreeView::GetTreeModel()
{
return _treeStore;
}
void ResourceTreeView::SetTreeModel(const TreeModel::Ptr& model)
{
_treeStore = model;
_emptyFavouritesLabel = wxDataViewItem();
if (!_treeStore)
{
_treeModelFilter = TreeModelFilter::Ptr();
AssociateModel(nullptr);
return;
}
SetupTreeModelFilter();
}
void ResourceTreeView::SetupTreeModelFilter()
{
// Set up the filter
_treeModelFilter.reset(new TreeModelFilter(_treeStore));
_treeModelFilter->SetVisibleFunc([this](TreeModel::Row& row)
{
return _treeModelFilterFunc(row);
});
AssociateModel(_treeModelFilter.get());
// Remove the dummy label in any case
if (_emptyFavouritesLabel.IsOk())
{
_treeStore->RemoveItem(_emptyFavouritesLabel);
_emptyFavouritesLabel = wxDataViewItem();
}
if (_mode == TreeMode::ShowFavourites)
{
wxDataViewItemArray visibleChildren;
if (_treeModelFilter->GetChildren(_treeModelFilter->GetRoot(), visibleChildren) == 0)
{
// All items filtered out, show the dummy label
if (!_emptyFavouritesLabel.IsOk())
{
wxutil::TreeModel::Row row = _treeStore->AddItem();
_emptyFavouritesLabel = row.getItem();
wxIcon icon;
icon.CopyFromBitmap(wxArtProvider::GetBitmap(GlobalUIManager().ArtIdPrefix() + ICON_LOADING));
row[_columns.iconAndName] = wxVariant(wxDataViewIconText(_("No favourites added so far"), icon));
row[_columns.isFavourite] = true;
row[_columns.isFolder] = false;
row.SendItemAdded();
}
}
ExpandTopLevelItems();
}
}
ResourceTreeView::TreeMode ResourceTreeView::GetTreeMode() const
{
return _mode;
}
void ResourceTreeView::SetTreeMode(ResourceTreeView::TreeMode mode)
{
if (_mode != mode)
{
_mode = mode;
SetupTreeModelFilter();
}
}
void ResourceTreeView::PopulateContextMenu(wxutil::PopupMenu& popupMenu)
{
// Add the pre-registered items first (with an auto-separator)
if (popupMenu.GetMenuItemCount() > 0)
{
popupMenu.addSeparator();
}
for (const auto& customItem : _customMenuItems)
{
popupMenu.addItem(customItem);
}
_customMenuItems.clear();
if (popupMenu.GetMenuItemCount() > 0)
{
popupMenu.addSeparator();
}
popupMenu.addItem(
new StockIconTextMenuItem(_(ADD_TO_FAVOURITES), wxART_ADD_BOOKMARK),
std::bind(&ResourceTreeView::_onSetFavourite, this, true),
std::bind(&ResourceTreeView::_testAddToFavourites, this),
[this]() { return _declType != decl::Type::None; }
);
popupMenu.addItem(
new StockIconTextMenuItem(_(REMOVE_FROM_FAVOURITES), wxART_DEL_BOOKMARK),
std::bind(&ResourceTreeView::_onSetFavourite, this, false),
std::bind(&ResourceTreeView::_testRemoveFromFavourites, this),
[this]() { return _declType != decl::Type::None; }
);
}
std::string ResourceTreeView::GetSelectedFullname()
{
// Get the selected value
wxDataViewItem item = GetSelection();
if (!item.IsOk())
{
return std::string(); // nothing selected
}
// Cast to TreeModel::Row and get the full name
TreeModel::Row row(item, *GetModel());
return row[_columns.fullName];
}
void ResourceTreeView::SetSelectedFullname(const std::string& fullName)
{
if (_populator)
{
// Postpone the selection, store the name
_fullNameToSelectAfterPopulation = fullName;
return;
}
// If the selection string is empty, collapse the treeview and return with
// no selection
if (fullName.empty())
{
Collapse(GetTreeModel()->GetRoot());
return;
}
// Find the requested element
auto item = GetTreeModel()->FindString(fullName, _columns.fullName);
if (item.IsOk())
{
Select(item);
EnsureVisible(item);
// Send an artificial selection change event
SendSelectionChangeEvent(item);
}
_fullNameToSelectAfterPopulation.clear();
}
void ResourceTreeView::Clear()
{
// Clear any data and/or active population objects
_populator.reset();
_treeStore->Clear();
_emptyFavouritesLabel = wxDataViewItem();
}
void ResourceTreeView::EnableFavouriteManagement(decl::Type declType)
{
_declType = declType;
}
void ResourceTreeView::DisableFavouriteManagement()
{
_declType = decl::Type::None;
SetTreeMode(TreeMode::ShowAll);
}
void ResourceTreeView::Populate(const IResourceTreePopulator::Ptr& populator)
{
// Try to keep the current selection intact after population
_fullNameToSelectAfterPopulation = GetSelectedFullname();
// Remove any data or running populators first
Clear();
// Add the loading icon to the tree
TreeModel::Row row = GetTreeModel()->AddItem();
row[_columns.iconAndName] = wxVariant(wxDataViewIconText(_("Loading resources...")));
row[_columns.isFavourite] = true;
row[_columns.isFolder] = false;
row.SendItemAdded();
// It will fire the TreeModel::PopulationFinishedEvent when done, point it to ourselves
populator->SetFinishedHandler(this);
// Start population (this might be a thread or not)
_populator = populator;
_populator->Populate();
}
void ResourceTreeView::SetExpandTopLevelItemsAfterPopulation(bool expand)
{
_expandTopLevelItemsAfterPopulation = expand;
}
void ResourceTreeView::AddCustomMenuItem(const ui::IMenuItemPtr& item)
{
_customMenuItems.push_back(item);
}
void ResourceTreeView::_onTreeStorePopulationFinished(TreeModel::PopulationFinishedEvent& ev)
{
UnselectAll();
SetTreeModel(ev.GetTreeModel());
_populator.reset();
// Trigger a column size event on the first-level row
TriggerColumnSizeEvent();
if (_expandTopLevelItemsAfterPopulation)
{
ExpandTopLevelItems();
}
// Populator is empty now, check if we need to pre-select anything
if (!_fullNameToSelectAfterPopulation.empty())
{
SetSelectedFullname(_fullNameToSelectAfterPopulation);
}
}
void ResourceTreeView::_onContextMenu(wxDataViewEvent& ev)
{
if (!_popupMenu)
{
_popupMenu.reset(new wxutil::PopupMenu());
PopulateContextMenu(*_popupMenu);
}
_popupMenu->show(this);
}
bool ResourceTreeView::_testAddToFavourites()
{
// Adding favourites is allowed for any folder and non-favourite items
return IsDirectorySelected() || (GetSelection().IsOk() && !IsFavouriteSelected());
}
bool ResourceTreeView::_testRemoveFromFavourites()
{
// We can run remove from favourites on any folder or on favourites themselves
return IsDirectorySelected() || IsFavouriteSelected();
}
void ResourceTreeView::SetFavouriteRecursively(TreeModel::Row& row, bool isFavourite)
{
if (row[_columns.isFolder].getBool())
{
// Enter recursion for this folder
wxDataViewItemArray children;
GetModel()->GetChildren(row.getItem(), children);
for (const wxDataViewItem& child : children)
{
TreeModel::Row childRow(child, *GetModel());
SetFavouriteRecursively(childRow, isFavourite);
}
return;
}
// Not a folder, set the desired status on this item
row[_columns.isFavourite] = isFavourite;
row[_columns.iconAndName] = TreeViewItemStyle::Declaration(isFavourite);
// Keep track of this choice
if (isFavourite)
{
GlobalFavouritesManager().addFavourite(_declType, row[_columns.fullName]);
}
else
{
GlobalFavouritesManager().removeFavourite(_declType, row[_columns.fullName]);
}
row.SendItemChanged();
}
void ResourceTreeView::_onSetFavourite(bool isFavourite)
{
wxDataViewItem item = GetSelection();
if (!item.IsOk()) return;
// Grab this item and enter recursion, propagating the favourite status
TreeModel::Row row(item, *GetModel());
SetFavouriteRecursively(row, isFavourite);
// Store to registry on each change
// TODO: ? _favourites->saveToRegistry();
}
bool ResourceTreeView::IsDirectorySelected()
{
wxDataViewItem item = GetSelection();
if (!item.IsOk()) return false;
TreeModel::Row row(item, *GetModel());
return row[_columns.isFolder].getBool();
}
bool ResourceTreeView::IsFavouriteSelected()
{
wxDataViewItem item = GetSelection();
if (!item.IsOk()) return false;
TreeModel::Row row(item, *GetModel());
return row[_columns.isFavourite].getBool();
}
bool ResourceTreeView::_treeModelFilterFunc(wxutil::TreeModel::Row& row)
{
if (_mode == TreeMode::ShowAll) return true; // everything is visible
// Favourites mode, check if this item or any descendant is visible
if (row[_columns.isFavourite].getBool())
{
return true;
}
wxDataViewItemArray children;
_treeStore->GetChildren(row.getItem(), children);
// Enter the recursion for each of the children and bail out on the first visible one
for (const wxDataViewItem& child : children)
{
wxutil::TreeModel::Row childRow(child, *_treeStore);
if (_treeModelFilterFunc(childRow))
{
return true;
}
}
return false;
}
}