1 /***************************************************************************
2 * Copyright (C) 2012 by Frank Reininghaus <frank78ac@googlemail.com> *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
18 ***************************************************************************/
20 #include <qtest_kde.h>
21 #include <qtestmouse.h>
22 #include <qtestkeyboard.h>
25 #include "kitemviews/kitemlistcontainer.h"
26 #include "kitemviews/kfileitemlistview.h"
27 #include "kitemviews/kfileitemmodel.h"
28 #include "kitemviews/kitemlistcontroller.h"
29 #include "kitemviews/kitemlistselectionmanager.h"
30 #include "kitemviews/kitemlistviewlayouter_p.h"
34 const int DefaultTimeout
= 2000;
37 Q_DECLARE_METATYPE(KFileItemListView::Layout
);
38 Q_DECLARE_METATYPE(Qt::Orientation
);
39 Q_DECLARE_METATYPE(KItemListController::SelectionBehavior
);
41 class KItemListControllerTest
: public QObject
47 void cleanupTestCase();
52 void testKeyboardNavigation_data();
53 void testKeyboardNavigation();
57 * Make sure that the number of columns in the view is equal to \a count
58 * by changing the geometry of the container.
60 void adjustGeometryForColumnCount(int count
);
63 KFileItemListView
* m_view
;
64 KItemListController
* m_controller
;
65 KItemListSelectionManager
* m_selectionManager
;
66 KFileItemModel
* m_model
;
67 KDirLister
* m_dirLister
;
69 KItemListContainer
* m_container
;
73 * This function initializes the member objects, creates the temporary files, and
74 * shows the view on the screen on startup. This could also be done before every
75 * single test, but this would make the time needed to run the test much larger.
77 void KItemListControllerTest::initTestCase()
79 m_testDir
= new TestDir();
80 m_dirLister
= new KDirLister();
81 m_model
= new KFileItemModel(m_dirLister
);
82 m_container
= new KItemListContainer();
83 m_controller
= m_container
->controller();
84 m_controller
->setSelectionBehavior(KItemListController::MultiSelection
);
85 m_selectionManager
= m_controller
->selectionManager();
87 m_view
= new KFileItemListView();
88 m_controller
->setView(m_view
);
89 m_controller
->setModel(m_model
);
93 << "a1" << "a2" << "a3"
95 << "c1" << "c2" << "c3" << "c4" << "c5"
96 << "d1" << "d2" << "d3" << "d4"
97 << "e1" << "e2" << "e3" << "e4" << "e5" << "e6" << "e7";
99 m_testDir
->createFiles(files
);
100 m_dirLister
->openUrl(m_testDir
->url());
101 QVERIFY(QTest::kWaitForSignal(m_model
, SIGNAL(loadingCompleted()), DefaultTimeout
));
104 QTest::qWaitForWindowShown(m_container
);
107 void KItemListControllerTest::cleanupTestCase()
126 /** Before each test, the current item, selection, and item size are reset to the defaults. */
127 void KItemListControllerTest::init()
129 m_selectionManager
->setCurrentItem(0);
130 QCOMPARE(m_selectionManager
->currentItem(), 0);
132 m_selectionManager
->clearSelection();
133 QVERIFY(!m_selectionManager
->hasSelection());
135 const QSizeF
itemSize(50, 50);
136 m_view
->setItemSize(itemSize
);
137 QCOMPARE(m_view
->itemSize(), itemSize
);
140 void KItemListControllerTest::cleanup()
145 * \class KeyPress is a small helper struct that represents a key press event,
146 * including the key and the keyboard modifiers.
150 KeyPress(Qt::Key key
, Qt::KeyboardModifiers modifier
= Qt::NoModifier
) :
156 Qt::KeyboardModifiers m_modifier
;
160 * \class ViewState is a small helper struct that represents a certain state
161 * of the view, including the current item and the selected items.
165 ViewState(int current
, QSet
<int> selection
) :
167 m_selection(selection
)
171 QSet
<int> m_selection
;
174 // We have to define a typedef for the pair in order to make the test compile.
175 typedef QPair
<KeyPress
, ViewState
> keyPressViewStatePair
;
176 Q_DECLARE_METATYPE(QList
<keyPressViewStatePair
>);
179 * This function provides the data for the actual test function
180 * KItemListControllerTest::testKeyboardNavigation().
181 * It tests all possible combinations of view layouts, selection behaviors,
182 * and enabled/disabled groupings for different column counts, and
183 * provides a list of key presses and the states that the view should be in
184 * after the key press event.
186 void KItemListControllerTest::testKeyboardNavigation_data()
188 QTest::addColumn
<KFileItemListView::Layout
>("layout");
189 QTest::addColumn
<Qt::Orientation
>("scrollOrientation");
190 QTest::addColumn
<int>("columnCount");
191 QTest::addColumn
<KItemListController::SelectionBehavior
>("selectionBehavior");
192 QTest::addColumn
<bool>("groupingEnabled");
193 QTest::addColumn
<QList
<QPair
<KeyPress
, ViewState
> > >("testList");
195 QList
<KFileItemListView::Layout
> layoutList
;
196 QHash
<KFileItemListView::Layout
, QString
> layoutNames
;
197 layoutList
.append(KFileItemListView::IconsLayout
);
198 layoutNames
[KFileItemListView::IconsLayout
] = "Icons";
199 layoutList
.append(KFileItemListView::CompactLayout
);
200 layoutNames
[KFileItemListView::CompactLayout
] = "Compact";
201 layoutList
.append(KFileItemListView::DetailsLayout
);
202 layoutNames
[KFileItemListView::DetailsLayout
] = "Details";
204 QList
<KItemListController::SelectionBehavior
> selectionBehaviorList
;
205 QHash
<KItemListController::SelectionBehavior
, QString
> selectionBehaviorNames
;
206 selectionBehaviorList
.append(KItemListController::NoSelection
);
207 selectionBehaviorNames
[KItemListController::NoSelection
] = "NoSelection";
208 selectionBehaviorList
.append(KItemListController::SingleSelection
);
209 selectionBehaviorNames
[KItemListController::SingleSelection
] = "SingleSelection";
210 selectionBehaviorList
.append(KItemListController::MultiSelection
);
211 selectionBehaviorNames
[KItemListController::MultiSelection
] = "MultiSelection";
213 QList
<bool> groupingEnabledList
;
214 QHash
<bool, QString
> groupingEnabledNames
;
215 groupingEnabledList
.append(false);
216 groupingEnabledNames
[false] = "ungrouped";
217 groupingEnabledList
.append(true);
218 groupingEnabledNames
[true] = "grouping enabled";
220 foreach (KFileItemListView::Layout layout
, layoutList
) {
221 // The following settings depend on the layout.
222 // Note that 'columns' are actually 'rows' in
224 Qt::Orientation scrollOrientation
;
225 QList
<int> columnCountList
;
227 Qt::Key previousItemKey
;
229 Qt::Key previousRowKey
;
232 case KFileItemListView::IconsLayout
:
233 scrollOrientation
= Qt::Vertical
;
234 columnCountList
<< 1 << 3 << 5;
235 nextItemKey
= Qt::Key_Right
;
236 previousItemKey
= Qt::Key_Left
;
237 nextRowKey
= Qt::Key_Down
;
238 previousRowKey
= Qt::Key_Up
;
240 case KFileItemListView::CompactLayout
:
241 scrollOrientation
= Qt::Horizontal
;
242 columnCountList
<< 1 << 3 << 5;
243 nextItemKey
= Qt::Key_Down
;
244 previousItemKey
= Qt::Key_Up
;
245 nextRowKey
= Qt::Key_Right
;
246 previousRowKey
= Qt::Key_Left
;
248 case KFileItemListView::DetailsLayout
:
249 scrollOrientation
= Qt::Vertical
;
250 columnCountList
<< 1;
251 nextItemKey
= Qt::Key_Down
;
252 previousItemKey
= Qt::Key_Up
;
253 nextRowKey
= Qt::Key_Down
;
254 previousRowKey
= Qt::Key_Up
;
258 foreach (int columnCount
, columnCountList
) {
259 foreach (KItemListController::SelectionBehavior selectionBehavior
, selectionBehaviorList
) {
260 foreach (bool groupingEnabled
, groupingEnabledList
) {
261 QList
<QPair
<KeyPress
, ViewState
> > testList
;
263 // First, key presses which should have the same effect
264 // for any layout and any number of columns.
266 << qMakePair(KeyPress(nextItemKey
), ViewState(1, QSet
<int>() << 1))
267 << qMakePair(KeyPress(nextItemKey
), ViewState(2, QSet
<int>() << 2))
268 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(3, QSet
<int>() << 2 << 3))
269 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(2, QSet
<int>() << 2))
270 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(3, QSet
<int>() << 2 << 3))
271 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(4, QSet
<int>() << 2 << 3))
272 << qMakePair(KeyPress(previousItemKey
), ViewState(3, QSet
<int>() << 3))
273 << qMakePair(KeyPress(Qt::Key_Home
, Qt::ShiftModifier
), ViewState(0, QSet
<int>() << 0 << 1 << 2 << 3))
274 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(1, QSet
<int>() << 0 << 1 << 2 << 3))
275 << qMakePair(KeyPress(Qt::Key_Space
, Qt::ControlModifier
), ViewState(1, QSet
<int>() << 0 << 2 << 3))
276 << qMakePair(KeyPress(Qt::Key_Space
, Qt::ControlModifier
), ViewState(1, QSet
<int>() << 0 << 1 << 2 << 3))
277 << qMakePair(KeyPress(Qt::Key_End
), ViewState(19, QSet
<int>() << 19))
278 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(18, QSet
<int>() << 18 << 19))
279 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
281 // Next, we test combinations of key presses which only work for a
282 // particular number of columns and either enabled or disabled grouping.
285 if (columnCount
== 1) {
287 << qMakePair(KeyPress(nextRowKey
), ViewState(1, QSet
<int>() << 1))
288 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(2, QSet
<int>() << 1 << 2))
289 << qMakePair(KeyPress(nextRowKey
, Qt::ControlModifier
), ViewState(3, QSet
<int>() << 1 << 2))
290 << qMakePair(KeyPress(previousRowKey
), ViewState(2, QSet
<int>() << 2))
291 << qMakePair(KeyPress(previousItemKey
), ViewState(1, QSet
<int>() << 1))
292 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
295 // Multiple columns: we test both 3 and 5 columns with grouping
296 // enabled or disabled. For each case, the layout of the items
297 // in the view is shown (both using file names and indices) to
298 // make it easier to understand what the tests do.
300 if (columnCount
== 3 && !groupingEnabled
) {
301 // 3 columns, no grouping:
306 // d1 d2 d3 | 9 10 11
307 // d4 e1 e2 | 12 13 14
308 // e3 e4 e5 | 15 16 17
311 << qMakePair(KeyPress(nextRowKey
), ViewState(3, QSet
<int>() << 3))
312 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(4, QSet
<int>() << 3))
313 << qMakePair(KeyPress(nextRowKey
), ViewState(7, QSet
<int>() << 7))
314 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(8, QSet
<int>() << 7 << 8))
315 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(9, QSet
<int>() << 7 << 8 << 9))
316 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(8, QSet
<int>() << 7 << 8))
317 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(7, QSet
<int>() << 7))
318 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(6, QSet
<int>() << 6 << 7))
319 << qMakePair(KeyPress(previousItemKey
, Qt::ShiftModifier
), ViewState(5, QSet
<int>() << 5 << 6 << 7))
320 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(6, QSet
<int>() << 6 << 7))
321 << qMakePair(KeyPress(nextItemKey
, Qt::ShiftModifier
), ViewState(7, QSet
<int>() << 7))
322 << qMakePair(KeyPress(nextRowKey
), ViewState(10, QSet
<int>() << 10))
323 << qMakePair(KeyPress(nextItemKey
), ViewState(11, QSet
<int>() << 11))
324 << qMakePair(KeyPress(nextRowKey
), ViewState(14, QSet
<int>() << 14))
325 << qMakePair(KeyPress(nextRowKey
), ViewState(17, QSet
<int>() << 17))
326 << qMakePair(KeyPress(nextRowKey
), ViewState(19, QSet
<int>() << 19))
327 << qMakePair(KeyPress(previousRowKey
), ViewState(17, QSet
<int>() << 17))
328 << qMakePair(KeyPress(Qt::Key_End
), ViewState(19, QSet
<int>() << 19))
329 << qMakePair(KeyPress(previousRowKey
), ViewState(16, QSet
<int>() << 16))
330 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
333 if (columnCount
== 5 && !groupingEnabled
) {
334 // 5 columns, no grouping:
336 // a1 a2 a3 b1 c1 | 0 1 2 3 4
337 // c2 c3 c4 c5 d1 | 5 6 7 8 9
338 // d2 d3 d4 e1 e2 | 10 11 12 13 14
339 // e3 e4 e5 e6 e7 | 15 16 17 18 19
341 << qMakePair(KeyPress(nextRowKey
), ViewState(5, QSet
<int>() << 5))
342 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(6, QSet
<int>() << 5))
343 << qMakePair(KeyPress(nextRowKey
), ViewState(11, QSet
<int>() << 11))
344 << qMakePair(KeyPress(nextItemKey
), ViewState(12, QSet
<int>() << 12))
345 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(17, QSet
<int>() << 12 << 13 << 14 << 15 << 16 << 17))
346 << qMakePair(KeyPress(previousRowKey
, Qt::ShiftModifier
), ViewState(12, QSet
<int>() << 12))
347 << qMakePair(KeyPress(previousRowKey
, Qt::ShiftModifier
), ViewState(7, QSet
<int>() << 7 << 8 << 9 << 10 << 11 << 12))
348 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(12, QSet
<int>() << 12))
349 << qMakePair(KeyPress(Qt::Key_End
, Qt::ControlModifier
), ViewState(19, QSet
<int>() << 12))
350 << qMakePair(KeyPress(previousRowKey
), ViewState(14, QSet
<int>() << 14))
351 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
354 if (columnCount
== 3 && groupingEnabled
) {
355 // 3 columns, with grouping:
361 // d1 d2 d3 | 9 10 11
363 // e1 e2 e3 | 13 14 15
364 // e4 e5 e6 | 16 17 18
367 << qMakePair(KeyPress(nextItemKey
), ViewState(1, QSet
<int>() << 1))
368 << qMakePair(KeyPress(nextItemKey
), ViewState(2, QSet
<int>() << 2))
369 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(3, QSet
<int>() << 2 << 3))
370 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(6, QSet
<int>() << 2 << 3 << 4 << 5 << 6))
371 << qMakePair(KeyPress(nextRowKey
), ViewState(8, QSet
<int>() << 8))
372 << qMakePair(KeyPress(nextRowKey
), ViewState(11, QSet
<int>() << 11))
373 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(12, QSet
<int>() << 11))
374 << qMakePair(KeyPress(nextRowKey
), ViewState(13, QSet
<int>() << 13))
375 << qMakePair(KeyPress(nextRowKey
), ViewState(16, QSet
<int>() << 16))
376 << qMakePair(KeyPress(nextItemKey
), ViewState(17, QSet
<int>() << 17))
377 << qMakePair(KeyPress(nextRowKey
), ViewState(19, QSet
<int>() << 19))
378 << qMakePair(KeyPress(previousRowKey
), ViewState(17, QSet
<int>() << 17))
379 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
382 if (columnCount
== 5 && groupingEnabled
) {
383 // 5 columns, with grouping:
387 // c1 c2 c3 c4 c5 | 4 5 6 7 8
388 // d1 d2 d3 d4 | 9 10 11 12
389 // e1 e2 e3 e4 e5 | 13 14 15 16 17
392 << qMakePair(KeyPress(nextItemKey
), ViewState(1, QSet
<int>() << 1))
393 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(3, QSet
<int>() << 1 << 2 << 3))
394 << qMakePair(KeyPress(nextRowKey
, Qt::ShiftModifier
), ViewState(5, QSet
<int>() << 1 << 2 << 3 << 4 << 5))
395 << qMakePair(KeyPress(nextItemKey
), ViewState(6, QSet
<int>() << 6))
396 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(7, QSet
<int>() << 6))
397 << qMakePair(KeyPress(nextItemKey
, Qt::ControlModifier
), ViewState(8, QSet
<int>() << 6))
398 << qMakePair(KeyPress(nextRowKey
), ViewState(12, QSet
<int>() << 12))
399 << qMakePair(KeyPress(nextRowKey
), ViewState(17, QSet
<int>() << 17))
400 << qMakePair(KeyPress(nextRowKey
), ViewState(19, QSet
<int>() << 19))
401 << qMakePair(KeyPress(previousRowKey
), ViewState(17, QSet
<int>() << 17))
402 << qMakePair(KeyPress(Qt::Key_End
, Qt::ShiftModifier
), ViewState(19, QSet
<int>() << 17 << 18 << 19))
403 << qMakePair(KeyPress(previousRowKey
, Qt::ShiftModifier
), ViewState(14, QSet
<int>() << 14 << 15 << 16 << 17))
404 << qMakePair(KeyPress(Qt::Key_Home
), ViewState(0, QSet
<int>() << 0));
407 const QString testName
=
408 layoutNames
[layout
] + ", " +
409 QString("%1 columns, ").arg(columnCount
) +
410 selectionBehaviorNames
[selectionBehavior
] + ", " +
411 groupingEnabledNames
[groupingEnabled
];
413 const QByteArray testNameAscii
= testName
.toAscii();
415 QTest::newRow(testNameAscii
.data())
429 * This function sets the view's properties according to the data provided by
430 * KItemListControllerTest::testKeyboardNavigation_data().
432 * The list \a testList contains pairs of key presses, which are sent to the
433 * container, and expected view states, which are verified then.
435 void KItemListControllerTest::testKeyboardNavigation()
437 QFETCH(KFileItemListView::Layout
, layout
);
438 QFETCH(Qt::Orientation
, scrollOrientation
);
439 QFETCH(int, columnCount
);
440 QFETCH(KItemListController::SelectionBehavior
, selectionBehavior
);
441 QFETCH(bool, groupingEnabled
);
442 QFETCH(QList
<keyPressViewStatePair
>, testList
);
444 m_view
->setItemLayout(layout
);
445 QCOMPARE(m_view
->itemLayout(), layout
);
447 m_view
->setScrollOrientation(scrollOrientation
);
448 QCOMPARE(m_view
->scrollOrientation(), scrollOrientation
);
450 adjustGeometryForColumnCount(columnCount
);
451 QCOMPARE(m_view
->m_layouter
->m_columnCount
, columnCount
);
453 m_controller
->setSelectionBehavior(selectionBehavior
);
454 QCOMPARE(m_controller
->selectionBehavior(), selectionBehavior
);
456 m_model
->setGroupedSorting(groupingEnabled
);
457 QCOMPARE(m_model
->groupedSorting(), groupingEnabled
);
459 while (!testList
.isEmpty()) {
460 const QPair
<KeyPress
, ViewState
> test
= testList
.takeFirst();
461 const Qt::Key key
= test
.first
.m_key
;
462 const Qt::KeyboardModifiers modifier
= test
.first
.m_modifier
;
463 const int current
= test
.second
.m_current
;
464 const QSet
<int> selection
= test
.second
.m_selection
;
466 QTest::keyClick(m_container
, key
, modifier
);
467 QCOMPARE(m_selectionManager
->currentItem(), current
);
468 switch (selectionBehavior
) {
469 case KItemListController::NoSelection
: QVERIFY(m_selectionManager
->selectedItems().isEmpty()); break;
470 case KItemListController::SingleSelection
: QCOMPARE(m_selectionManager
->selectedItems(), QSet
<int>() << current
); break;
471 case KItemListController::MultiSelection
: QCOMPARE(m_selectionManager
->selectedItems(), selection
); break;
476 void KItemListControllerTest::adjustGeometryForColumnCount(int count
)
478 const QSize size
= m_view
->itemSize().toSize();
480 QRect rect
= m_container
->geometry();
481 rect
.setSize(size
* count
);
482 m_container
->setGeometry(rect
);
484 // Increase the size of the container until the correct column count is reached.
485 while (m_view
->m_layouter
->m_columnCount
< count
) {
486 rect
= m_container
->geometry();
487 rect
.setSize(rect
.size() + size
);
488 m_container
->setGeometry(rect
);
492 QTEST_KDEMAIN(KItemListControllerTest
, GUI
)
494 #include "kitemlistcontrollertest.moc"