/
ResourceTreeView.cpp
309 lines (242 loc) · 8.02 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
#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)
{
// 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);
}
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)
{
_mode = mode;
setupTreeModelFilter();
}
void ResourceTreeView::populateContextMenu(wxutil::PopupMenu& popupMenu)
{
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)
);
popupMenu.addItem(
new StockIconTextMenuItem(_(REMOVE_FROM_FAVOURITES), wxART_DEL_BOOKMARK),
std::bind(&ResourceTreeView::_onSetFavourite, this, false),
std::bind(&ResourceTreeView::_testRemoveFromFavourites, this)
);
}
std::string ResourceTreeView::getSelection()
{
// 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::setSelection(const std::string& fullName)
{
// 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 a selection change event
wxDataViewEvent ev(wxEVT_DATAVIEW_SELECTION_CHANGED, this, item);
ProcessWindowEvent(ev);
}
}
void ResourceTreeView::clear()
{
// Clear the media browser on MaterialManager unrealisation
_treeStore->Clear();
_emptyFavouritesLabel = wxDataViewItem();
}
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(decl::Type::Material, row[_columns.fullName]);
}
else
{
GlobalFavouritesManager().removeFavourite(decl::Type::Material, 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;
}
}