Debian Codegraph @

core/libs/album/widgets/albumselectcombobox.cpp

raw
1 /* ============================================================
2 *
3 * This file is a part of digiKam project
4 * https://www.digikam.org
5 *
6 * Date : 2009-05-09
7 * Description : A combo box for selecting albums
8 *
9 * SPDX-FileCopyrightText: 2008-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
10 * SPDX-FileCopyrightText: 2010-2011 by Andi Clemens <andi dot clemens at gmail dot com>
11 * SPDX-FileCopyrightText: 2012-2026 by Gilles Caulier <caulier dot gilles at gmail dot com>
12 *
13 * SPDX-License-Identifier: GPL-2.0-or-later
14 *
15 * ============================================================ */
16
17 #include "albumselectcombobox.h"
18
19 // Qt includes
20
21 #include <QSortFilterProxyModel>
22 #include <QTreeView>
23
24 // KDE includes
25
26 #include <klocalizedstring.h>
27
28 // Local includes
29
30 #include "albummodel.h"
31 #include "albumfiltermodel.h"
32 #include "albumtreeview.h"
33 #include "tagtreeview.h"
34 #include "contextmenuhelper.h"
35
36 namespace Digikam
37 {
38
39 class Q_DECL_HIDDEN AlbumSelectComboBox::Private
40 {
41 public:
42
43 explicit Private(AlbumSelectComboBox* const qq)
44 : q(qq)
45 {
46 }
47
48 void updateCheckable();
49 void updateCloseOnActivate();
50
51 public:
52
53 AbstractCheckableAlbumModel* model = nullptr;
54 AlbumFilterModel* filterModel = nullptr;
55 QString noSelectionText;
56 bool recursive = false;
57 bool isCheckable = true;
58 bool closeOnActivate = false;
59 bool allSelectedText = false;
60 bool showCheckStateSummary = true;
61
62 AlbumSelectComboBox* const q;
63 };
64
65 AlbumSelectComboBox::AlbumSelectComboBox(QWidget* const parent)
66 : TreeViewLineEditComboBox(parent),
67 d (new Private(this))
68 {
69 d->noSelectionText = i18n("No Album Selected");
70
71 // Workaround for QLineEdit text when QComboBox loses focus
72
73 /// @note use dynamic binding as updateText() is a virtual slot which can be re-implemented in derived classes.
74
75 connect(this, &AlbumSelectComboBox::editTextChanged,
76 this, &AlbumSelectComboBox::updateText);
77 }
78
79 AlbumSelectComboBox::~AlbumSelectComboBox()
80 {
81 delete d;
82 }
83
84 void AlbumSelectComboBox::setDefaultAlbumModel()
85 {
86 d->noSelectionText = i18n("No Album Selected");
87 setAlbumModels(new AlbumModel(AlbumModel::IgnoreRootAlbum, this));
88 view()->expandToDepth(0);
89 }
90
91 void AlbumSelectComboBox::setDefaultTagModel()
92 {
93 d->noSelectionText = i18n("No Tag Selected");
94 setAlbumModels(new TagModel(AlbumModel::IgnoreRootAlbum, this));
95 }
96
97 void AlbumSelectComboBox::setAlbumModels(AbstractCheckableAlbumModel* _model, AlbumFilterModel* _filterModel)
98 {
99 d->model = _model;
100 d->model->setRecursive(d->recursive);
101
102 if (_filterModel)
103 {
104 d->filterModel = _filterModel;
105 }
106 else
107 {
108 d->filterModel = new AlbumFilterModel(this);
109 /*
110 d->filterModel->setDynamicSortFilter(true);
111 */
112 d->filterModel->setSourceAlbumModel(d->model);
113 }
114
115 d->updateCheckable();
116
117 QComboBox::setModel(d->filterModel);
118 installView();
119
120 d->updateCloseOnActivate();
121 updateText();
122 }
123
124 void AlbumSelectComboBox::installView(QAbstractItemView* v)
125 {
126 if (view())
127 {
128 return;
129 }
130
131 TreeViewLineEditComboBox::installView(v);
132
133 // cppcheck-suppress nullPointerRedundantCheck
134 view()->sortByColumn(0, Qt::AscendingOrder);
135
136 // cppcheck-suppress nullPointerRedundantCheck
137 view()->setSortingEnabled(true);
138
139 // cppcheck-suppress nullPointerRedundantCheck
140 view()->collapseAll();
141 }
142
143 void AlbumSelectComboBox::setCheckable(bool checkable)
144 {
145 if (checkable == d->isCheckable)
146 {
147 return;
148 }
149
150 d->isCheckable = checkable;
151 d->updateCheckable();
152 }
153
154 bool AlbumSelectComboBox::isCheckable() const
155 {
156 return d->isCheckable;
157 }
158
159 void AlbumSelectComboBox::Private::updateCheckable()
160 {
161 if (!model)
162 {
163 return;
164 }
165
166 model->setCheckable(isCheckable);
167
168 if (isCheckable)
169 {
170 connect(model, SIGNAL(checkStateChanged(Album*,Qt::CheckState)),
171 q, SLOT(updateText()));
172 }
173 else
174 {
175 disconnect(model, SIGNAL(checkStateChanged(Album*,Qt::CheckState)),
176 q, SLOT(updateText()));
177 }
178 }
179
180 void AlbumSelectComboBox::setCloseOnActivate(bool close)
181 {
182 if (d->closeOnActivate == close)
183 {
184 return;
185 }
186
187 d->closeOnActivate = close;
188 d->updateCloseOnActivate();
189 }
190
191 void AlbumSelectComboBox::Private::updateCloseOnActivate()
192 {
193 if (!q->view())
194 {
195 return;
196 }
197
198 if (closeOnActivate)
199 {
200 connect(q->view(), SIGNAL(activated(QModelIndex)),
201 q, SLOT(hidePopup()));
202 }
203 else
204 {
205 disconnect(q->view(), SIGNAL(activated(QModelIndex)),
206 q, SLOT(hidePopup()));
207 }
208 }
209
210 void AlbumSelectComboBox::setRecursive(bool recursive)
211 {
212 d->recursive = recursive; // used if a new model will be set
213
214 if (d->model)
215 {
216 d->model->setRecursive(recursive);
217 }
218 }
219
220 void AlbumSelectComboBox::setNoSelectionText(const QString& text)
221 {
222 d->noSelectionText = text;
223 updateText();
224 }
225
226 void AlbumSelectComboBox::setAllSelectedText(bool all)
227 {
228 d->allSelectedText = all;
229 updateText();
230 }
231
232 void AlbumSelectComboBox::setShowCheckStateSummary(bool show)
233 {
234 d->showCheckStateSummary = show;
235 updateText();
236 }
237
238 AbstractCheckableAlbumModel* AlbumSelectComboBox::model() const
239 {
240 return d->model;
241 }
242
243 QSortFilterProxyModel* AlbumSelectComboBox::filterModel() const
244 {
245 return d->filterModel;
246 }
247
248 void AlbumSelectComboBox::hidePopup()
249 {
250 // just make this a slot
251
252 TreeViewLineEditComboBox::hidePopup();
253 updateText();
254 }
255
256 void AlbumSelectComboBox::updateText()
257 {
258 if (!d->isCheckable || !d->showCheckStateSummary)
259 {
260 return;
261 }
262
263 QList<Album*> checkedAlbums;
264
265 if (!d->allSelectedText)
266 {
267 checkedAlbums = d->model->checkedAlbums();
268 }
269 else
270 {
271 if (d->model->albumType() == Album::TAG)
272 {
273 checkedAlbums = AlbumManager::instance()->allTAlbums();
274 }
275 else
276 {
277 checkedAlbums = AlbumManager::instance()->allPAlbums();
278 }
279 }
280
281 QList<Album*> partiallyCheckedAlbums = d->model->partiallyCheckedAlbums();
282 QString newIncludeText;
283 QString newExcludeText;
284
285 if (!checkedAlbums.isEmpty())
286 {
287 if (checkedAlbums.count() == 1)
288 {
289 newIncludeText = checkedAlbums.first()->title();
290 }
291 else
292 {
293 if (d->model->albumType() == Album::TAG)
294 {
295 newIncludeText = i18np("1 Tag selected", "%1 Tags selected",
296 checkedAlbums.count());
297 }
298 else
299 {
300 newIncludeText = i18np("1 Album selected", "%1 Albums selected",
301 checkedAlbums.count());
302 }
303 }
304 }
305
306 if (!partiallyCheckedAlbums.isEmpty() && !d->allSelectedText)
307 {
308 if (d->model->albumType() == Album::TAG)
309 {
310 newExcludeText = i18np("1 Tag excluded", "%1 Tags excluded",
311 partiallyCheckedAlbums.count());
312 }
313 else
314 {
315 newExcludeText = i18np("1 Album excluded", "%1 Albums excluded",
316 partiallyCheckedAlbums.count());
317 }
318 }
319
320 blockSignals(true);
321
322 if (newIncludeText.isEmpty() && newExcludeText.isEmpty())
323 {
324 setLineEditText(d->noSelectionText);
325 }
326 else if (newIncludeText.isEmpty() || newExcludeText.isEmpty())
327 {
328 setLineEditText(newIncludeText + newExcludeText);
329 }
330 else
331 {
332 setLineEditText(newIncludeText + QLatin1String(", ") + newExcludeText);
333 }
334
335 blockSignals(false);
336 }
337
338 // ---------------------------------------------------------------------------------------------------
339
340 AbstractAlbumTreeViewSelectComboBox::AbstractAlbumTreeViewSelectComboBox(QWidget* const parent)
341 : AlbumSelectComboBox(parent)
342 {
343 }
344
345 void AbstractAlbumTreeViewSelectComboBox::installView(QAbstractItemView* view)
346 {
347 if (!view)
348 {
349 view = m_treeView;
350 }
351
352 AlbumSelectComboBox::installView(view);
353 }
354
355 void AbstractAlbumTreeViewSelectComboBox::sendViewportEventToView(QEvent* e)
356 {
357 // needed for StayPoppedUpComboBox
358
359 m_treeView->viewportEvent(e);
360 }
361
362 void AbstractAlbumTreeViewSelectComboBox::setTreeView(AbstractAlbumTreeView* const treeView)
363 {
364 // this is independent from the installView mechanism, just to override
365 // the tree view created below without the need to subclass
366
367 if (!m_treeView)
368 {
369 m_treeView = treeView;
370 }
371 }
372
373 // -------------------------------------------------------------------------------------------------------------------
374
375 class Q_DECL_HIDDEN CheckUncheckContextMenuElement : public QObject,
376 public AbstractAlbumTreeView::ContextMenuElement
377 {
378 Q_OBJECT
379
380 public:
381
382 explicit CheckUncheckContextMenuElement(QObject* const parent)
383 : QObject(parent)
384 {
385 }
386
387 void addActions(AbstractAlbumTreeView* view, ContextMenuHelper& cmh, Album* album) override
388 {
389 AbstractCheckableAlbumModel* const checkable = qobject_cast<AbstractCheckableAlbumModel*>(view->albumModel());
390
391 if (checkable)
392 {
393 cmh.setAlbumModel(checkable);
394 cmh.addAlbumCheckUncheckActions(album);
395 }
396 }
397 };
398
399 void AbstractAlbumTreeViewSelectComboBox::addCheckUncheckContextMenuActions()
400 {
401 if (m_treeView)
402 {
403 m_treeView->setEnableContextMenu(true);
404 m_treeView->addContextMenuElement(new CheckUncheckContextMenuElement(this));
405 }
406 }
407
408 // ---------------------------------------------------------------------------------
409
410 AlbumTreeViewSelectComboBox::AlbumTreeViewSelectComboBox(QWidget* const parent)
411 : AbstractAlbumTreeViewSelectComboBox(parent)
412 {
413 }
414
415 AlbumTreeView* AlbumTreeViewSelectComboBox::treeView() const
416 {
417 return static_cast<AlbumTreeView*>(m_treeView);
418 }
419
420 void AlbumTreeViewSelectComboBox::setDefaultModel()
421 {
422 setAlbumModels(nullptr, nullptr);
423 }
424
425 void AlbumTreeViewSelectComboBox::setAlbumModels(AlbumModel* model, CheckableAlbumFilterModel* filterModel)
426 {
427 if (!m_treeView)
428 {
429 AlbumTreeView::Flags flags;
430 m_treeView = new AlbumTreeView(this, flags);
431 }
432
433 if (!model)
434 {
435 model = new AlbumModel(AlbumModel::IgnoreRootAlbum, this);
436 }
437
438 if (!filterModel)
439 {
440 filterModel = new CheckableAlbumFilterModel(this);
441 }
442
443 treeView()->setPAlbumModel(model);
444 treeView()->setCheckableAlbumFilterModel(filterModel);
445
446 AlbumSelectComboBox::setAlbumModels(treeView()->checkableAlbumModel(), treeView()->albumFilterModel());
447
448 treeView()->setRootIsDecorated(true);
449 treeView()->expandToDepth(0);
450 }
451
452 // ---------------------------------------------------------------------------------------------------
453
454 TagTreeViewSelectComboBox::TagTreeViewSelectComboBox(QWidget* const parent)
455 : AbstractAlbumTreeViewSelectComboBox(parent)
456 {
457 }
458
459 TagTreeView* TagTreeViewSelectComboBox::treeView() const
460 {
461 return static_cast<TagTreeView*>(m_treeView);
462 }
463
464 void TagTreeViewSelectComboBox::setDefaultModel()
465 {
466 setAlbumModels(nullptr, nullptr);
467 }
468
469 void TagTreeViewSelectComboBox::setAlbumModels(TagModel* model,
470 TagPropertiesFilterModel* filteredModel,
471 CheckableAlbumFilterModel* filterModel)
472 {
473 if (!m_treeView)
474 {
475 TagTreeView::Flags flags;
476 m_treeView = new TagTreeView(this, flags);
477 }
478
479 if (!model)
480 {
481 model = new TagModel(AlbumModel::IgnoreRootAlbum, this);
482 }
483
484 if (!filteredModel)
485 {
486 filteredModel = new TagPropertiesFilterModel(this);
487 }
488
489 if (!filterModel)
490 {
491 filterModel = new CheckableAlbumFilterModel(this);
492 }
493
494 treeView()->setTAlbumModel(model);
495 treeView()->setTAlbumFilterModel(filteredModel, filterModel);
496
497 AlbumSelectComboBox::setAlbumModels(treeView()->checkableAlbumModel(), treeView()->albumFilterModel());
498 }
499
500 } // namespace Digikam
501
502 #include "albumselectcombobox.moc"
503
504 #include "moc_albumselectcombobox.cpp"