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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206 | /* ============================================================
*
* This file is a part of digiKam project
* https://www.digikam.org
*
* Date : 2009-03-25
* Description : Tree View for album models
*
* SPDX-FileCopyrightText: 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
* SPDX-FileCopyrightText: 2010-2011 by Andi Clemens <andi dot clemens at gmail dot com>
* SPDX-FileCopyrightText: 2014 by Mohamed_Anwer <m_dot_anwer at gmx dot com>
* SPDX-FileCopyrightText: 2014 by Michael G. Hansen <mike at mghansen dot de>
* SPDX-FileCopyrightText: 2009-2025 by Gilles Caulier <caulier dot gilles at gmail dot com>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* ============================================================ */
#include "abstractalbumtreeview_p.h"
namespace Digikam
{
AbstractAlbumTreeView::AbstractAlbumTreeView(QWidget* const parent, Flags flags)
: QTreeView (parent),
StateSavingObject(this),
m_flags (flags),
d (new Private)
{
if (flags & CreateDefaultDelegate)
{
d->delegate = new AlbumTreeViewDelegate(this);
setItemDelegate(d->delegate);
setUniformRowHeights(true);
}
d->resizeColumnsTimer = new QTimer(this);
d->resizeColumnsTimer->setInterval(200);
d->resizeColumnsTimer->setSingleShot(true);
d->contextMenuIcon = QIcon::fromTheme(QLatin1String("digikam")).pixmap(style()->pixelMetric(QStyle::PM_SmallIconSize));
d->contextMenuTitle = i18n("Context menu");
connect(d->resizeColumnsTimer, SIGNAL(timeout()),
this, SLOT(adaptColumnsToContent()));
connect(ApplicationSettings::instance(), SIGNAL(setupChanged()),
this, SLOT(albumSettingsChanged()));
connect(this, SIGNAL(currentAlbumChanged(Album*)),
this, SLOT(currentAlbumChangedForBackupSelection(Album*)));
if (flags & CreateDefaultFilterModel)
{
this->setAlbumFilterModel(new AlbumFilterModel(this));
}
setSortingEnabled(true);
albumSettingsChanged();
}
AbstractAlbumTreeView::~AbstractAlbumTreeView()
{
delete d;
}
void AbstractAlbumTreeView::setAlbumModel(AbstractSpecificAlbumModel* const model)
{
if (m_albumModel == model)
{
return;
}
if (m_albumModel)
{
disconnect(m_albumModel, nullptr,
this, nullptr);
}
m_albumModel = model;
if (m_albumFilterModel)
{
m_albumFilterModel->setSourceAlbumModel(m_albumModel);
}
if (m_albumModel)
{
if (!m_albumModel->rootAlbum())
{
connect(m_albumModel, SIGNAL(rootAlbumAvailable()),
this, SLOT(slotRootAlbumAvailable()));
}
if (m_albumFilterModel)
{
expand(m_albumFilterModel->rootAlbumIndex());
}
}
}
void AbstractAlbumTreeView::setAlbumFilterModel(AlbumFilterModel* const filterModel)
{
if (filterModel == m_albumFilterModel)
{
return;
}
if (m_albumFilterModel)
{
disconnect(m_albumFilterModel);
}
if (selectionModel())
{
disconnect(selectionModel());
}
m_albumFilterModel = filterModel;
setModel(m_albumFilterModel);
if (m_albumFilterModel)
{
m_albumFilterModel->setSourceAlbumModel(m_albumModel);
connect(m_albumFilterModel, SIGNAL(searchTextSettingsAboutToChange(bool,bool)),
this, SLOT(slotSearchTextSettingsAboutToChange(bool,bool)));
connect(m_albumFilterModel, SIGNAL(searchTextSettingsChanged(bool,bool)),
this, SLOT(slotSearchTextSettingsChanged(bool,bool)));
/**
* @note When only single selection was available, everything was
* implemented using currentAlbum() which was equal with selectedAlbum()
* after enabling multiple selection they are no longer the same
* and some options must use selected others only currentAlbum
* Now AlbumManager implementation is a little bit of mess
* because selected are now currentAlbums().
*/
connect(selectionModel(), SIGNAL(currentChanged(QModelIndex,QModelIndex)),
this, SLOT(slotCurrentChanged()));
connect(selectionModel(), SIGNAL(selectionChanged(QItemSelection,QItemSelection)),
this, SLOT(slotSelectionChanged()));
connect(m_albumFilterModel, SIGNAL(dataChanged(QModelIndex,QModelIndex)),
this, SLOT(adaptColumnsOnDataChange(QModelIndex,QModelIndex)));
connect(m_albumFilterModel, SIGNAL(rowsInserted(QModelIndex,int,int)),
this, SLOT(adaptColumnsOnRowChange(QModelIndex,int,int)));
connect(m_albumFilterModel, SIGNAL(rowsRemoved(QModelIndex,int,int)),
this, SLOT(adaptColumnsOnRowChange(QModelIndex,int,int)));
connect(m_albumFilterModel, SIGNAL(layoutChanged()),
this, SLOT(adaptColumnsOnLayoutChange()));
connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
this, SLOT(slotScrollBarValueChanged(int)));
connect(horizontalScrollBar(), SIGNAL(actionTriggered(int)),
this, SLOT(slotScrollBarActionTriggered(int)));
adaptColumnsToContent();
if (m_albumModel)
{
expand(m_albumFilterModel->rootAlbumIndex());
}
/*
m_albumFilterModel->setDynamicSortFilter(true);
*/
}
}
AbstractSpecificAlbumModel* AbstractAlbumTreeView::albumModel() const
{
return m_albumModel;
}
AlbumFilterModel* AbstractAlbumTreeView::albumFilterModel() const
{
return m_albumFilterModel;
}
void AbstractAlbumTreeView::setExpandOnSingleClick(const bool doThat)
{
d->expandOnSingleClick = doThat;
}
void AbstractAlbumTreeView::setExpandNewCurrentItem(const bool doThat)
{
d->expandNewCurrent = doThat;
}
void AbstractAlbumTreeView::setSelectAlbumOnClick(const bool selectOnClick)
{
d->selectAlbumOnClick = selectOnClick;
}
QModelIndex AbstractAlbumTreeView::indexVisuallyAt(const QPoint& p)
{
if (viewport()->rect().contains(p))
{
const QModelIndex index = indexAt(p);
if (index.isValid() && visualRect(index).contains(p))
{
return index;
}
}
return QModelIndex();
}
template<class A>
QList<A*> AbstractAlbumTreeView::currentAlbums()
{
QList<A*> albums;
const QList<Album*> currentAl = AlbumManager::instance()->currentAlbums();
for (QList<Album*>::const_iterator it = currentAl.constBegin() ; it != currentAl.constEnd() ; ++it)
{
A* const item = dynamic_cast<A*>(*it);<--- Variable 'item' can be declared as pointer to const
if (item)
{
albums.append(item);
}
}
return albums;
}
void AbstractAlbumTreeView::slotSearchTextSettingsAboutToChange(bool searched, bool willSearch)
{
// backup before we begin searching
if (!searched && willSearch && d->searchBackup.isEmpty())
{
qCDebug(DIGIKAM_GENERAL_LOG) << "Searching started, backing up state";
QList<int> selection, expansion;
saveStateRecursive(QModelIndex(), selection, expansion);
// selection is ignored here because the user may have changed this
// while searching
for (const int& expandedId : std::as_const(expansion))
{
d->searchBackup[expandedId].expanded = true;
}
// also backup the last selected album in case this didn't work via the slot
const QList<Album*> selList = selectedAlbums<Album>(selectionModel(),
m_albumFilterModel);
if (!selList.isEmpty())
{
d->lastSelectedAlbum = selList.first();
}
}
}
void AbstractAlbumTreeView::slotSearchTextSettingsChanged(bool wasSearching, bool searched)
{
// ensure that all search results are visible if there is currently a search working
if (searched)
{
qCDebug(DIGIKAM_GENERAL_LOG) << "Searched, expanding all results";
expandMatches(QModelIndex());
}
// Restore the tree view state if searching finished
if (wasSearching && !searched && !d->searchBackup.isEmpty())
{
qCDebug(DIGIKAM_GENERAL_LOG) << "Searching finished, restoring tree view state";
collapseAll();
restoreStateForHierarchy(QModelIndex(), d->searchBackup);
d->searchBackup.clear();
if (d->lastSelectedAlbum)
{
setCurrentAlbums(QList<Album*>() << d->lastSelectedAlbum, false);
// Doing this twice somehow ensures that all parents are expanded
// and we are at the right position. Maybe a hack... ;)
scrollTo(m_albumFilterModel->indexForAlbum(d->lastSelectedAlbum));
scrollTo(m_albumFilterModel->indexForAlbum(d->lastSelectedAlbum));
}
}
}
void AbstractAlbumTreeView::currentAlbumChangedForBackupSelection(Album* currentAlbum)
{
d->lastSelectedAlbum = currentAlbum;
}
void AbstractAlbumTreeView::slotRootAlbumAvailable()
{
expand(m_albumFilterModel->rootAlbumIndex());
}
bool AbstractAlbumTreeView::expandMatches(const QModelIndex& index)
{
bool anyMatch = false;
// Expand index if a child matches
const QModelIndex source_index = m_albumFilterModel->mapToSource(index);
const AlbumFilterModel::MatchResult result = m_albumFilterModel->matchResult(source_index);
switch (result)
{
case AlbumFilterModel::NoMatch:
{
if (index != rootIndex())
{
return false;
}
break;
}
case AlbumFilterModel::ParentMatch:
{
// Does not rule out additional child match, return value is unknown
break;
}
case AlbumFilterModel::DirectMatch:
{
// Does not rule out additional child match, but we know we will return true
anyMatch = true;
break;
}
case AlbumFilterModel::ChildMatch:
case AlbumFilterModel::SpecialMatch:
{
// We know already to expand, and we know already we will return true.
anyMatch = true;
expand(index);
break;
}
}
// Recurse. Expand if children if have an (indirect) match
const int rows = m_albumFilterModel->rowCount(index);
for (int i = 0 ; i < rows ; ++i)
{
const QModelIndex child = m_albumFilterModel->index(i, 0, index);
const bool childResult = expandMatches(child);
if (childResult)
{
anyMatch = true;
// if there is a direct match _and_ a child match, do not forget to expand the parent
expand(index);
}
}
return anyMatch;
}
void AbstractAlbumTreeView::setSearchTextSettings(const SearchTextSettings& settings)
{
m_albumFilterModel->setSearchTextSettings(settings);
}
void AbstractAlbumTreeView::setAlbumManagerCurrentAlbum(const bool set)
{
d->setInAlbumManager = set;
}
void AbstractAlbumTreeView::setCurrentAlbums(const QList<Album*>& albums, bool selectInAlbumManager)
{
if (!model())
{
return;
}
if (selectInAlbumManager && d->setInAlbumManager)
{
AlbumManager::instance()->setCurrentAlbums(albums);
}
setCurrentIndex(albumFilterModel()->indexForAlbum(albums.first()));
QItemSelectionModel* const model = selectionModel();
model->clearSelection();
for (int it = 0 ; it < albums.size() ; ++it)
{
model->select(albumFilterModel()->indexForAlbum(albums.at(it)),
model->Select);
}
}
void AbstractAlbumTreeView::slotCurrentChanged()
{
// It seems that QItemSelectionModel::selectedIndexes() has not been updated at this point
// and returns the previously selected items. Therefore the line below did not work.
/*
QList<Album*> selected = selectedAlbums<Album>(selectionModel(),
m_albumFilterModel);
*/
// Instead, we call QItemSelectionModel::currentIndex to get the current index.
const QModelIndex cIndex = selectionModel()->currentIndex();
if (!cIndex.isValid())
{
return;
}
Album* const cAlbum = m_albumFilterModel->albumForIndex(cIndex);
if (!cAlbum)
{
return;
}
Q_EMIT currentAlbumChanged(cAlbum);
}
void AbstractAlbumTreeView::slotSelectionChanged()
{
// FIXME: Dead signal? Nobody listens to it
/*
Q_EMIT selectedAlbumsChanged(selectedAlbums<Album>(selectionModel(), m_albumFilterModel));
*/
if (d->selectAlbumOnClick)
{
AlbumManager::instance()->setCurrentAlbums(selectedAlbums<Album>(selectionModel(),
m_albumFilterModel));
}
}
void AbstractAlbumTreeView::mousePressEvent(QMouseEvent* e)
{
const QModelIndex currentBefor = currentIndex();
QTreeView::mousePressEvent(e);
if ((d->expandOnSingleClick || d->expandNewCurrent) && (e->button() == Qt::LeftButton))
{
const QModelIndex index = indexVisuallyAt(e->pos());
if (index.isValid())
{
if (d->expandOnSingleClick)
{
// See bug #126871: collapse/expand treeview using left mouse button single click.
// Exception: If a newly selected item is already expanded, do not collapse on selection.
const bool expanded = isExpanded(index);
if ((index == currentIndex()) || !expanded)
{
setExpanded(index, !expanded);
}
}
else
{
if (currentBefor != currentIndex())
{
expand(index);
}
}
}
}
else if (m_checkOnMiddleClick && (e->button() == Qt::MiddleButton))
{
Album* const a = m_albumFilterModel->albumForIndex(indexAt(e->pos()));
if (a)
{
middleButtonPressed(a);
}
}
}
void AbstractAlbumTreeView::middleButtonPressed(Album*)
{
// reimplement if needed
}
void AbstractAlbumTreeView::startDrag(Qt::DropActions supportedActions)
{
const QModelIndexList indexes = selectedIndexes();
if (indexes.count() > 0)
{
QMimeData* const data = m_albumFilterModel->mimeData(indexes);
if (!data)
{
return;
}
QStyleOptionViewItem option;
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
initViewItemOption(&option);
#else
option = viewOptions();
#endif
option.rect = viewport()->rect();
const QPixmap pixmap = /*m_delegate->*/pixmapForDrag(option, indexes);
QDrag* const drag = new QDrag(this);
drag->setPixmap(pixmap);
drag->setMimeData(data);
drag->exec(supportedActions, Qt::CopyAction);
}
}
/**
* @todo Move to delegate, when we have one.
* Copy code from image delegate for creating icons when dragging multiple items
*/
QPixmap AbstractAlbumTreeView::pixmapForDrag(const QStyleOptionViewItem&, QList<QModelIndex> indexes)
{
if (indexes.isEmpty())
{
return QPixmap();
}
const QVariant decoration = indexes.first().data(Qt::DecorationRole);
return (decoration.value<QPixmap>());
}
void AbstractAlbumTreeView::dragEnterEvent(QDragEnterEvent* e)
{
AlbumModelDragDropHandler* const handler = m_albumModel->dragDropHandler();
if (handler && handler->acceptsMimeData(e->mimeData()))
{
setState(DraggingState);
e->accept();
}
else
{
e->ignore();
}
}
void AbstractAlbumTreeView::dragMoveEvent(QDragMoveEvent* e)
{
QTreeView::dragMoveEvent(e);
AlbumModelDragDropHandler* const handler = m_albumModel->dragDropHandler();
if (handler)
{
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
const QModelIndex index = indexVisuallyAt(e->position().toPoint());
#else
const QModelIndex index = indexVisuallyAt(e->pos());
#endif
const QModelIndex source = m_albumFilterModel->mapToSourceAlbumModel(index);
const Qt::DropAction action = handler->accepts(e, source);
if (action == Qt::IgnoreAction)
{
m_albumModel->setDropIndex(QModelIndex());
e->ignore();
}
else
{
m_albumModel->setDropIndex(source);
e->setDropAction(action);
e->accept();
}
}
}
void AbstractAlbumTreeView::dragLeaveEvent(QDragLeaveEvent* e)
{
QTreeView::dragLeaveEvent(e);
m_albumModel->setDropIndex(QModelIndex());
}
void AbstractAlbumTreeView::dropEvent(QDropEvent* e)
{
QTreeView::dropEvent(e);
AlbumModelDragDropHandler* const handler = m_albumModel->dragDropHandler();
if (handler)
{
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
const QModelIndex index = indexVisuallyAt(e->position().toPoint());
#else
const QModelIndex index = indexVisuallyAt(e->pos());
#endif
if (handler->dropEvent(this, e, m_albumFilterModel->mapToSourceAlbumModel(index)))
{
e->accept();
}
}
m_albumModel->setDropIndex(QModelIndex());
}
bool AbstractAlbumTreeView::viewportEvent(QEvent* event)
{
return QTreeView::viewportEvent(event);
}
QList<Album*> AbstractAlbumTreeView::selectedItems()
{
return selectedAlbums<Album>(selectionModel(), m_albumFilterModel);
}
void AbstractAlbumTreeView::doLoadState()
{
KConfigGroup configGroup = getConfigGroup();
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "Loading view state from " << this << configGroup.name() << objectName();
*/
// extract the selection from the config
const QStringList selection = configGroup.readEntry(entryName(d->configSelectionEntry), QStringList());
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "selection: " << selection;
*/
for (const QString& key : std::as_const(selection))
{
bool validId;
const int id = key.toInt(&validId);
if (validId)
{
d->statesByAlbumId[id].selected = true;
}
}
// extract expansion state from config
const QStringList expansion = configGroup.readEntry(entryName(d->configExpansionEntry), QStringList());
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "expansion: " << expansion;
*/
// If no expansion was done, at least expand the root albums
if (expansion.isEmpty())
{
QList<AlbumRootInfo> roots = CoreDbAccess().db()->getAlbumRoots();
for (const AlbumRootInfo& info : std::as_const(roots))
{
int albumId = CoreDbAccess().db()->getAlbumForPath(info.id, QLatin1String("/"), false);
if (albumId != -1)
{
d->statesByAlbumId[albumId].expanded = true;
}
}
}
else
{
for (const QString& key : std::as_const(expansion))
{
bool validId;
const int id = key.toInt(&validId);
if (validId)
{
d->statesByAlbumId[id].expanded = true;
}
}
}
// extract current index from config
const QString key = configGroup.readEntry(entryName(d->configCurrentIndexEntry), QString());
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "currentIndex: " << key;
*/
bool validId;
const int id = key.toInt(&validId);
if (validId)
{
d->statesByAlbumId[id].currentIndex = true;
}
/*
for (QMap<int, Digikam::State>::iterator it = d->statesByAlbumId.begin() ; it
!= d->statesByAlbumId.end() ; ++it)
{
qCDebug(DIGIKAM_GENERAL_LOG) << "id = " << it.key() << ": recovered state (selected = "
<< it.value().selected << ", expanded = "
<< it.value().expanded << ", currentIndex = "
<< it.value().currentIndex << ")";
}
*/
// initial restore run, for everything already loaded
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "initial restore run with " << model()->rowCount() << " rows";
*/
restoreStateForHierarchy(QModelIndex(), d->statesByAlbumId);
// also restore the sorting order
sortByColumn(configGroup.readEntry(entryName(d->configSortColumnEntry), 0),
(Qt::SortOrder) configGroup.readEntry(entryName(d->configSortOrderEntry), (int)Qt::AscendingOrder));
// use a timer to scroll to the first possible selected album
QTimer::singleShot(200, this, SLOT(scrollToSelectedAlbum()));
}
void AbstractAlbumTreeView::restoreStateForHierarchy(const QModelIndex& index, const QMap<int, Digikam::State>& stateStore)
{
restoreState(index, stateStore);
// do a recursive call of the state restoration
for (int i = 0 ; i < model()->rowCount(index) ; ++i)
{
const QModelIndex child = model()->index(i, 0, index);
restoreStateForHierarchy(child, stateStore);
}
}
void AbstractAlbumTreeView::restoreState(const QModelIndex& index, const QMap<int, Digikam::State>& stateStore)
{
Album* const album = albumFilterModel()->albumForIndex(index);<--- Variable 'album' can be declared as pointer to const
if (album && stateStore.contains(album->id()))
{
Digikam::State state = stateStore.value(album->id());
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "Trying to restore state of album " << album->title() << "(" <<album->id() << ")"
<< ": state(selected = " << state.selected
<< ", expanded = " << state.expanded
<< ", currentIndex = " << state.currentIndex << ")" << this;
*/
// Block signals to prevent that the searches started when the last
// selected index is restored when loading the GUI
selectionModel()->blockSignals(true);
if (state.selected)
{
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "Selecting" << album->title();
*/
selectionModel()->select(index, QItemSelectionModel::SelectCurrent | QItemSelectionModel::Rows);
}
// Restore expansion state but ensure that the root album is always expanded
if (!album->isRoot())
{
setExpanded(index, state.expanded);
}
else
{
setExpanded(index, true);
}
// Restore the current index
if (state.currentIndex)
{
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "Setting current index" << album->title() << "(" << album->id() << ")";
*/
selectionModel()->setCurrentIndex(index, QItemSelectionModel::SelectCurrent | QItemSelectionModel::Rows);
}
selectionModel()->blockSignals(false);
}
}
void AbstractAlbumTreeView::rowsInserted(const QModelIndex& parent, int start, int end)
{
QTreeView::rowsInserted(parent, start, end);
if (!d->statesByAlbumId.isEmpty())
{
/*
qCDebug(DIGIKAM_GENERAL_LOG) << "slot rowInserted called with index = " << index
<< ", start = " << start << ", end = " << end
<< "remaining ids" << d->statesByAlbumId.keys();
*/
// Restore state for parent a second time - expansion can only be restored if there are children
restoreState(parent, d->statesByAlbumId);
for (int i = start ; i <= end ; ++i)
{
const QModelIndex child = model()->index(i, 0, parent);
restoreState(child, d->statesByAlbumId);
}
}
}
void AbstractAlbumTreeView::rowsAboutToBeRemoved(const QModelIndex& parent, int start, int end)
{
QTreeView::rowsAboutToBeRemoved(parent, start, end);
// Clean up map if album id is reused for a new album
if (!d->statesByAlbumId.isEmpty())
{
for (int i = start ; i <= end ; ++i)
{
const QModelIndex child = model()->index(i, 0, parent);
Album* const album = albumModel()->albumForIndex(child);<--- Variable 'album' can be declared as pointer to const
if (album)
{
d->statesByAlbumId.remove(album->id());
}
}
}
}
void AbstractAlbumTreeView::adaptColumnsToContent()
{
resizeColumnToContents(0);
}
void AbstractAlbumTreeView::scrollToSelectedAlbum()
{
const QModelIndexList selected = selectedIndexes();
if (!selected.isEmpty())
{
scrollTo(selected.first(), PositionAtCenter);
horizontalScrollBar()->setValue(0);
}
}
void AbstractAlbumTreeView::expandEverything(const QModelIndex& index)
{
for (int row = 0 ; row < albumFilterModel()->rowCount(index) ; ++row)
{
const QModelIndex rowIndex = albumFilterModel()->index(row, 0, index);
expand(rowIndex);
expandEverything(rowIndex);
}
}
void AbstractAlbumTreeView::slotExpandNode()
{
QItemSelectionModel* const model = selectionModel();
QModelIndexList selected = model->selectedIndexes();
for (const QModelIndex& index : std::as_const(selected))
{
expandRecursively(index);
}
}
void AbstractAlbumTreeView::slotCollapseNode()
{
QItemSelectionModel* const model = selectionModel();
QModelIndexList selected = model->selectedIndexes();
QQueue<QModelIndex> greyNodes;
for (const QModelIndex& index : std::as_const(selected))
{
greyNodes.append(index);
collapse(index);
}
while (!greyNodes.isEmpty())
{
QModelIndex current = greyNodes.dequeue();
if (!current.isValid())
{
continue;
}
int it = 0;
QModelIndex child = current.model()->index(it++, 0, current);
while (child.isValid())
{
collapse(child);
greyNodes.enqueue(child);
child = current.model()->index(it++, 0, current);
}
}
}
void AbstractAlbumTreeView::slotCollapseAllNodes()
{
QQueue<QModelIndex> greyNodes;
greyNodes.append(m_albumFilterModel->rootAlbumIndex());
while (!greyNodes.isEmpty())
{
QModelIndex current = greyNodes.dequeue();
if (!current.isValid())
{
continue;
}
int it = 0;
QModelIndex child = current.model()->index(it++, 0, current);
while (child.isValid())
{
collapse(child);
greyNodes.enqueue(child);
child = current.model()->index(it++, 0, current);
}
}
}
void AbstractAlbumTreeView::adaptColumnsOnDataChange(const QModelIndex& topLeft, const QModelIndex& bottomRight)
{
Q_UNUSED(topLeft);
Q_UNUSED(bottomRight);
if (!d->resizeColumnsTimer->isActive())
{
d->resizeColumnsTimer->start();
}
}
void AbstractAlbumTreeView::adaptColumnsOnRowChange(const QModelIndex& parent, int start, int end)
{
Q_UNUSED(parent);
Q_UNUSED(start);
Q_UNUSED(end);
if (!d->resizeColumnsTimer->isActive())
{
d->resizeColumnsTimer->start();
}
}
void AbstractAlbumTreeView::adaptColumnsOnLayoutChange()
{
if (!d->resizeColumnsTimer->isActive())
{
d->resizeColumnsTimer->start();
}
}
void AbstractAlbumTreeView::doSaveState()
{
KConfigGroup configGroup = getConfigGroup();
QList<int> selection, expansion;
for (int i = 0 ; i < model()->rowCount() ; ++i)
{
const QModelIndex index = model()->index(i, 0);
saveStateRecursive(index, selection, expansion);
}
Album* const selectedAlbum = albumFilterModel()->albumForIndex(selectionModel()->currentIndex());<--- Variable 'selectedAlbum' can be declared as pointer to const
QString currentIndex;
if (selectedAlbum)
{
currentIndex = QString::number(selectedAlbum->id());
}
configGroup.writeEntry(entryName(d->configSelectionEntry), selection);
configGroup.writeEntry(entryName(d->configExpansionEntry), expansion);
configGroup.writeEntry(entryName(d->configCurrentIndexEntry), currentIndex);
configGroup.writeEntry(entryName(d->configSortColumnEntry), albumFilterModel()->sortColumn());
configGroup.writeEntry(entryName(d->configSortOrderEntry), int(albumFilterModel()->sortOrder()));
}
void AbstractAlbumTreeView::saveStateRecursive(const QModelIndex& index, QList<int>& selection, QList<int>& expansion)
{
Album* const album = albumFilterModel()->albumForIndex(index);<--- Variable 'album' can be declared as pointer to const
if (album)
{
const int id = album->id();
if (selectionModel()->isSelected(index))
{
selection.append(id);
}
if (isExpanded(index))
{
expansion.append(id);
}
}
for (int i = 0 ; i < model()->rowCount(index) ; ++i)
{
const QModelIndex child = model()->index(i, 0, index);
saveStateRecursive(child, selection, expansion);
}
}
void AbstractAlbumTreeView::setEnableContextMenu(const bool enable)
{
d->enableContextMenu = enable;
}
bool AbstractAlbumTreeView::showContextMenuAt(QContextMenuEvent* event, Album* albumForEvent)
{
Q_UNUSED(event);
return albumForEvent;
}
void AbstractAlbumTreeView::setContextMenuIcon(const QPixmap& pixmap)
{
d->contextMenuIcon = pixmap;
}
void AbstractAlbumTreeView::setContextMenuTitle(const QString& title)
{
d->contextMenuTitle = title;
}
QPixmap AbstractAlbumTreeView::contextMenuIcon() const
{
return d->contextMenuIcon;
}
QString AbstractAlbumTreeView::contextMenuTitle() const
{
return d->contextMenuTitle;
}
void AbstractAlbumTreeView::addContextMenuElement(ContextMenuElement* element)
{
d->contextMenuElements << element;
}
void AbstractAlbumTreeView::removeContextMenuElement(ContextMenuElement* element)
{
d->contextMenuElements.removeAll(element);
}
QList<AbstractAlbumTreeView::ContextMenuElement*> AbstractAlbumTreeView::contextMenuElements() const
{
return d->contextMenuElements;
}
void AbstractAlbumTreeView::contextMenuEvent(QContextMenuEvent* event)
{
if (!d->enableContextMenu)
{
return;
}
Album* const album = albumFilterModel()->albumForIndex(indexAt(event->pos()));
if (!album)
{
return;
}
if (album->isTrashAlbum())
{
QMenu* const trashAlbumMenu = new QMenu(this);
ContextMenuHelper cmhelper(trashAlbumMenu);
addCustomContextMenuActions(cmhelper, album);
QAction* emptyTrashAction = new QAction(QIcon::fromTheme(QLatin1String("edit-delete")),
i18n("Empty Trash"), this);
connect(emptyTrashAction, SIGNAL(triggered()),
AlbumManager::instance(), SIGNAL(signalEmptyTrash()));
cmhelper.addAction(emptyTrashAction);
AlbumPointer<Album> albumPointer(album);
QAction* const choice = cmhelper.exec(QCursor::pos());
handleCustomContextMenuAction(choice, albumPointer);
return;
}
if (!showContextMenuAt(event, album))
{
return;
}
// switch to the selected album if need
if (d->selectOnContextMenu)
{
setCurrentAlbums(QList<Album*>() << album);
}
// --------------------------------------------------------
QMenu* const popmenu = new QMenu(this);
popmenu->addSection(contextMenuIcon(), contextMenuTitle());
ContextMenuHelper cmhelper(popmenu);
addCustomContextMenuActions(cmhelper, album);
for (ContextMenuElement* const element : std::as_const(d->contextMenuElements))
{
element->addActions(this, cmhelper, album);
}
AlbumPointer<Album> albumPointer(album);
QAction* const choice = cmhelper.exec(QCursor::pos());
handleCustomContextMenuAction(choice, albumPointer);
}
void AbstractAlbumTreeView::setSelectOnContextMenu(const bool select)
{
d->selectOnContextMenu = select;
}
void AbstractAlbumTreeView::addCustomContextMenuActions(ContextMenuHelper& cmh, Album* album)
{
Q_UNUSED(cmh);
Q_UNUSED(album);
}
void AbstractAlbumTreeView::handleCustomContextMenuAction(QAction* action, const AlbumPointer<Album>& album)
{
Q_UNUSED(action);
Q_UNUSED(album);
}
void AbstractAlbumTreeView::albumSettingsChanged()
{
setFont(ApplicationSettings::instance()->getTreeViewFont());
if (d->delegate)
{
d->delegate->updateHeight();
}
}
void AbstractAlbumTreeView::slotScrollBarValueChanged(int value)
{
if (m_lastScrollBarValue == -1)
{
m_lastScrollBarValue = value;
}
if ((value == 0) && (m_lastScrollBarValue > 0))
{
horizontalScrollBar()->setValue(m_lastScrollBarValue);
}
}
void AbstractAlbumTreeView::slotScrollBarActionTriggered(int action)
{
if (
(action == QAbstractSlider::SliderMove) ||
(action == QAbstractSlider::SliderToMinimum) ||
(action == QAbstractSlider::SliderPageStepSub) ||
(action == QAbstractSlider::SliderSingleStepSub)
)
{
m_lastScrollBarValue = -1;
}
}
} // namespace Digikam
#include "moc_abstractalbumtreeview.cpp"
#include "moc_abstractalbumtreeview_p.cpp"
|