]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/kitemviews/kitemlistselectionmanager.cpp
SVN_SILENT made messages (.desktop file) - always resolve ours
[dolphin.git] / src / kitemviews / kitemlistselectionmanager.cpp
index 9aaf22f5853fbff4d37cdb724706ea3c8f0ac390..6f7f0e0776121850799674817736f7522277f51a 100644 (file)
@@ -1,38 +1,21 @@
-/***************************************************************************
- *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
- *   Copyright (C) 2011 by Frank Reininghaus <frank78ac@googlemail.com>    *
- *                                                                         *
- *   Based on the Itemviews NG project from Trolltech Labs:                *
- *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2011 Frank Reininghaus <frank78ac@googlemail.com>
+ *
+ * Based on the Itemviews NG project from Trolltech Labs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #include "kitemlistselectionmanager.h"
 
-#include "kitemmodelbase.h"
-#include <KDebug>
-
-KItemListSelectionManager::KItemListSelectionManager(QObject* parent) :
-    QObject(parent),
-    m_currentItem(-1),
-    m_anchorItem(-1),
-    m_selectedItems(),
-    m_isAnchoredSelectionActive(false),
-    m_model(0)
+KItemListSelectionManager::KItemListSelectionManager(QObject *parent)
+    : QObject(parent)
+    , m_currentItem(-1)
+    , m_anchorItem(-1)
+    , m_selectedItems()
+    , m_isAnchoredSelectionActive(false)
+    , m_model(nullptr)
 {
 }
 
@@ -43,7 +26,7 @@ KItemListSelectionManager::~KItemListSelectionManager()
 void KItemListSelectionManager::setCurrentItem(int current)
 {
     const int previous = m_currentItem;
-    const QSet<int> previousSelection = selectedItems();
+    const KItemSet previousSelection = selectedItems();
 
     if (m_model && current >= 0 && current < m_model->count()) {
         m_currentItem = current;
@@ -52,12 +35,12 @@ void KItemListSelectionManager::setCurrentItem(int current)
     }
 
     if (m_currentItem != previous) {
-        emit currentChanged(m_currentItem, previous);
+        Q_EMIT currentChanged(m_currentItem, previous);
 
         if (m_isAnchoredSelectionActive) {
-            const QSet<int> selection = selectedItems();
+            const KItemSet selection = selectedItems();
             if (selection != previousSelection) {
-                emit selectionChanged(selection, previousSelection);
+                Q_EMIT selectionChanged(selection, previousSelection);
             }
         }
     }
@@ -68,24 +51,26 @@ int KItemListSelectionManager::currentItem() const
     return m_currentItem;
 }
 
-void KItemListSelectionManager::setSelectedItems(const QSet<int>& items)
+void KItemListSelectionManager::setSelectedItems(const KItemSet &items)
 {
     if (m_selectedItems != items) {
-        const QSet<int> previous = m_selectedItems;
+        const KItemSet previous = m_selectedItems;
         m_selectedItems = items;
-        emit selectionChanged(m_selectedItems, previous);
+        Q_EMIT selectionChanged(m_selectedItems, previous);
     }
 }
 
-QSet<int> KItemListSelectionManager::selectedItems() const
+KItemSet KItemListSelectionManager::selectedItems() const
 {
-    QSet<int> selectedItems = m_selectedItems;
+    KItemSet selectedItems = m_selectedItems;
 
-    if (m_isAnchoredSelectionActive && (m_anchorItem != m_currentItem)) {
+    if (m_isAnchoredSelectionActive && m_anchorItem != m_currentItem) {
+        Q_ASSERT(m_anchorItem >= 0);
+        Q_ASSERT(m_currentItem >= 0);
         const int from = qMin(m_anchorItem, m_currentItem);
         const int to = qMax(m_anchorItem, m_currentItem);
 
-        for (int index = from; index <= to; index++) {
+        for (int index = from; index <= to; ++index) {
             selectedItems.insert(index);
         }
     }
@@ -93,9 +78,29 @@ QSet<int> KItemListSelectionManager::selectedItems() const
     return selectedItems;
 }
 
+bool KItemListSelectionManager::isSelected(int index) const
+{
+    if (m_selectedItems.contains(index)) {
+        return true;
+    }
+
+    if (m_isAnchoredSelectionActive && m_anchorItem != m_currentItem) {
+        Q_ASSERT(m_anchorItem >= 0);
+        Q_ASSERT(m_currentItem >= 0);
+        const int from = qMin(m_anchorItem, m_currentItem);
+        const int to = qMax(m_anchorItem, m_currentItem);
+
+        if (from <= index && index <= to) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 bool KItemListSelectionManager::hasSelection() const
 {
-    return !m_selectedItems.isEmpty() || (m_isAnchoredSelectionActive && (m_anchorItem != m_currentItem));
+    return !m_selectedItems.isEmpty() || (m_isAnchoredSelectionActive && m_anchorItem != m_currentItem);
 }
 
 void KItemListSelectionManager::setSelected(int index, int count, SelectionMode mode)
@@ -105,11 +110,11 @@ void KItemListSelectionManager::setSelected(int index, int count, SelectionMode
     }
 
     endAnchoredSelection();
-    const QSet<int> previous = selectedItems();
+    const KItemSet previous = selectedItems();
 
     count = qMin(count, m_model->count() - index);
 
-    const int endIndex = index + count -1;
+    const int endIndex = index + count - 1;
     switch (mode) {
     case Select:
         for (int i = index; i <= endIndex; ++i) {
@@ -138,35 +143,49 @@ void KItemListSelectionManager::setSelected(int index, int count, SelectionMode
         break;
     }
 
-    const QSet<int> selection = selectedItems();
+    const KItemSet selection = selectedItems();
     if (selection != previous) {
-        emit selectionChanged(selection, previous);
+        Q_EMIT selectionChanged(selection, previous);
     }
 }
 
 void KItemListSelectionManager::clearSelection()
 {
-    const QSet<int> previous = selectedItems();
+    const KItemSet previous = selectedItems();
     if (!previous.isEmpty()) {
         m_selectedItems.clear();
         m_isAnchoredSelectionActive = false;
-        emit selectionChanged(QSet<int>(), previous);
+        Q_EMIT selectionChanged(KItemSet(), previous);
     }
 }
 
+void KItemListSelectionManager::replaceSelection(int index, int count)
+{
+    const KItemSet previous = selectedItems();
+    if (!previous.isEmpty()) {
+        m_selectedItems.clear();
+        m_isAnchoredSelectionActive = false;
+    }
+    setSelected(index, count);
+}
+
 void KItemListSelectionManager::beginAnchoredSelection(int anchor)
 {
-    m_isAnchoredSelectionActive = true;
-    setAnchorItem(anchor);
+    if (anchor >= 0 && m_model && anchor < m_model->count()) {
+        m_isAnchoredSelectionActive = true;
+        m_anchorItem = anchor;
+    }
 }
 
 void KItemListSelectionManager::endAnchoredSelection()
 {
     if (m_isAnchoredSelectionActive && (m_anchorItem != m_currentItem)) {
+        Q_ASSERT(m_anchorItem >= 0);
+        Q_ASSERT(m_currentItem >= 0);
         const int from = qMin(m_anchorItem, m_currentItem);
         const int to = qMax(m_anchorItem, m_currentItem);
 
-        for (int index = from; index <= to; index++) {
+        for (int index = from; index <= to; ++index) {
             m_selectedItems.insert(index);
         }
     }
@@ -174,41 +193,17 @@ void KItemListSelectionManager::endAnchoredSelection()
     m_isAnchoredSelectionActive = false;
 }
 
-void KItemListSelectionManager::setAnchorItem(int anchor)
-{
-    const int previous = m_anchorItem;
-    if (m_model && anchor < m_model->count()) {
-        m_anchorItem = anchor;
-    } else {
-        m_anchorItem = -1;
-    }
-
-    if (m_anchorItem != previous) {
-        emit anchorChanged(m_anchorItem, previous);
-    }
-}
-
-int KItemListSelectionManager::anchorItem() const
-{
-    return m_anchorItem;
-}
-
 bool KItemListSelectionManager::isAnchoredSelectionActive() const
 {
     return m_isAnchoredSelectionActive;
 }
 
-void KItemListSelectionManager::setAnchoredSelectionActive(bool active)
-{
-    m_isAnchoredSelectionActive = active;
-}
-
-KItemModelBase* KItemListSelectionManager::model() const
+KItemModelBase *KItemListSelectionManager::model() const
 {
     return m_model;
 }
 
-void KItemListSelectionManager::setModel(KItemModelBasemodel)
+void KItemListSelectionManager::setModel(KItemModelBase *model)
 {
     m_model = model;
     if (model && model->count() > 0) {
@@ -216,10 +211,10 @@ void KItemListSelectionManager::setModel(KItemModelBase* model)
     }
 }
 
-void KItemListSelectionManager::itemsInserted(const KItemRangeListitemRanges)
+void KItemListSelectionManager::itemsInserted(const KItemRangeList &itemRanges)
 {
     // Store the current selection (needed in the selectionChanged() signal)
-    const QSet<int> previousSelection = selectedItems();
+    const KItemSet previousSelection = selectedItems();
 
     // Update the current item
     if (m_currentItem < 0) {
@@ -227,7 +222,7 @@ void KItemListSelectionManager::itemsInserted(const KItemRangeList& itemRanges)
     } else {
         const int previousCurrent = m_currentItem;
         int inc = 0;
-        foreach (const KItemRange& itemRange, itemRanges) {
+        for (const KItemRange &itemRange : itemRanges) {
             if (m_currentItem < itemRange.index) {
                 break;
             }
@@ -236,34 +231,34 @@ void KItemListSelectionManager::itemsInserted(const KItemRangeList& itemRanges)
         // Calling setCurrentItem would trigger the selectionChanged signal, but we want to
         // emit it only once in this function -> change the current item manually and emit currentChanged
         m_currentItem += inc;
-        emit currentChanged(m_currentItem, previousCurrent);
+        if (m_currentItem >= m_model->count()) {
+            m_currentItem = -1;
+        }
+        Q_EMIT currentChanged(m_currentItem, previousCurrent);
     }
 
     // Update the anchor item
     if (m_anchorItem < 0) {
-        setAnchorItem(0);
+        m_anchorItem = 0;
     } else {
-        const int previousAnchor = m_anchorItem;
         int inc = 0;
-        foreach (const KItemRange& itemRange, itemRanges) {
+        for (const KItemRange &itemRange : itemRanges) {
             if (m_anchorItem < itemRange.index) {
                 break;
             }
             inc += itemRange.count;
         }
         m_anchorItem += inc;
-        emit anchorChanged(m_anchorItem, previousAnchor);
     }
 
     // Update the selections
     if (!m_selectedItems.isEmpty()) {
-        const QSet<int> previous = m_selectedItems;
+        const KItemSet previous = m_selectedItems;
         m_selectedItems.clear();
-        QSetIterator<int> it(previous);
-        while (it.hasNext()) {
-            const int index = it.next();
+
+        for (int index : previous) {
             int inc = 0;
-            foreach (const KItemRange& itemRange, itemRanges) {
+            for (const KItemRange &itemRange : itemRanges) {
                 if (index < itemRange.index) {
                     break;
                 }
@@ -273,88 +268,132 @@ void KItemListSelectionManager::itemsInserted(const KItemRangeList& itemRanges)
         }
     }
 
-    const QSet<int> selection = selectedItems();
+    const KItemSet selection = selectedItems();
     if (selection != previousSelection) {
-        emit selectionChanged(selection, previousSelection);
+        Q_EMIT selectionChanged(selection, previousSelection);
     }
 }
 
-void KItemListSelectionManager::itemsRemoved(const KItemRangeListitemRanges)
+void KItemListSelectionManager::itemsRemoved(const KItemRangeList &itemRanges)
 {
     // Store the current selection (needed in the selectionChanged() signal)
-    const QSet<int> previousSelection = selectedItems();
+    const KItemSet previousSelection = selectedItems();
+    const int previousCurrent = m_currentItem;
 
     // Update the current item
-    if (m_currentItem >= 0) {
-        const int previousCurrent = m_currentItem;
-        int currentItem = m_currentItem;
-        foreach (const KItemRange& itemRange, itemRanges) {
-            if (currentItem < itemRange.index) {
-                break;
-            }
-            if (currentItem >= itemRange.index + itemRange.count) {
-                currentItem -= itemRange.count;
-            } else if (currentItem >= m_model->count()) {
-                currentItem = m_model->count() - 1;
-            }
+    m_currentItem = indexAfterRangesRemoving(m_currentItem, itemRanges, DiscardRemovedIndex);
+    if (m_currentItem != previousCurrent) {
+        Q_EMIT currentChanged(m_currentItem, previousCurrent);
+        if (m_currentItem < 0) {
+            // Calling setCurrentItem() would trigger the selectionChanged signal, but we want to
+            // emit it only once in this function -> change the current item manually and emit currentChanged
+            m_currentItem = indexAfterRangesRemoving(previousCurrent, itemRanges, AdjustRemovedIndex);
+            Q_EMIT currentChanged(m_currentItem, -1);
         }
-        // Calling setCurrentItem would trigger the selectionChanged signal, but we want to
-        // emit it only once in this function -> change the current item manually and emit currentChanged
-        m_currentItem = currentItem;
-        emit currentChanged(m_currentItem, previousCurrent);
     }
 
     // Update the anchor item
     if (m_anchorItem >= 0) {
-        const int previousAnchor = m_anchorItem;
-        int anchorItem = m_anchorItem;
-        foreach (const KItemRange& itemRange, itemRanges) {
-            if (anchorItem < itemRange.index) {
-                break;
-            }
-            if (anchorItem >= itemRange.index + itemRange.count) {
-                anchorItem -= itemRange.count;
-            } else if (anchorItem >= m_model->count()) {
-                anchorItem = m_model->count() - 1;
+        m_anchorItem = indexAfterRangesRemoving(m_anchorItem, itemRanges, DiscardRemovedIndex);
+        if (m_anchorItem < 0) {
+            m_isAnchoredSelectionActive = false;
+        }
+    }
+
+    // Update the selections and the anchor item
+    if (!m_selectedItems.isEmpty()) {
+        const KItemSet previous = m_selectedItems;
+        m_selectedItems.clear();
+
+        for (int oldIndex : previous) {
+            const int index = indexAfterRangesRemoving(oldIndex, itemRanges, DiscardRemovedIndex);
+            if (index >= 0) {
+                m_selectedItems.insert(index);
             }
         }
-        m_anchorItem = anchorItem;
-        emit anchorChanged(m_anchorItem, previousAnchor);
+    }
+
+    const KItemSet selection = selectedItems();
+    if (selection != previousSelection) {
+        Q_EMIT selectionChanged(selection, previousSelection);
+    }
+
+    Q_ASSERT(m_currentItem < m_model->count());
+    Q_ASSERT(m_anchorItem < m_model->count());
+}
+
+void KItemListSelectionManager::itemsMoved(const KItemRange &itemRange, const QList<int> &movedToIndexes)
+{
+    // Store the current selection (needed in the selectionChanged() signal)
+    const KItemSet previousSelection = selectedItems();
+
+    // Store whether we were doing an anchored selection
+    const bool wasInAnchoredSelection = isAnchoredSelectionActive();
+
+    // endAnchoredSelection() adds all items between m_currentItem and
+    // m_anchorItem to m_selectedItems. They can then be moved
+    // individually later in this function.
+    endAnchoredSelection();
+
+    // Update the current item
+    if (m_currentItem >= itemRange.index && m_currentItem < itemRange.index + itemRange.count) {
+        const int previousCurrentItem = m_currentItem;
+        const int newCurrentItem = movedToIndexes.at(previousCurrentItem - itemRange.index);
+
+        // Calling setCurrentItem would trigger the selectionChanged signal, but we want to
+        // emit it only once in this function -> change the current item manually and emit currentChanged
+        m_currentItem = newCurrentItem;
+        Q_EMIT currentChanged(newCurrentItem, previousCurrentItem);
+    }
+
+    // Start a new anchored selection.
+    if (wasInAnchoredSelection) {
+        beginAnchoredSelection(m_currentItem);
     }
 
     // Update the selections
     if (!m_selectedItems.isEmpty()) {
-        const QSet<int> previous = m_selectedItems;
+        const KItemSet previous = m_selectedItems;
         m_selectedItems.clear();
-        QSetIterator<int> it(previous);
-        while (it.hasNext()) {
-            int index = it.next();
-            int dec = 0;
-            foreach (const KItemRange& itemRange, itemRanges) {
-                if (index < itemRange.index) {
-                    break;
-                }
 
-                if (index < itemRange.index + itemRange.count) {
-                    // The selection is part of the removed range
-                    // and will get deleted
-                    index = -1;
-                    break;
-                }
-
-                dec += itemRange.count;
-            }
-            index -= dec;
-            if (index >= 0)  {
+        for (int index : previous) {
+            if (index >= itemRange.index && index < itemRange.index + itemRange.count) {
+                m_selectedItems.insert(movedToIndexes.at(index - itemRange.index));
+            } else {
                 m_selectedItems.insert(index);
             }
         }
     }
 
-    const QSet<int> selection = selectedItems();
+    const KItemSet selection = selectedItems();
     if (selection != previousSelection) {
-        emit selectionChanged(selection, previousSelection);
+        Q_EMIT selectionChanged(selection, previousSelection);
+    }
+}
+
+int KItemListSelectionManager::indexAfterRangesRemoving(int index, const KItemRangeList &itemRanges, const RangesRemovingBehaviour behaviour) const
+{
+    int dec = 0;
+    for (const KItemRange &itemRange : itemRanges) {
+        if (index < itemRange.index) {
+            break;
+        }
+
+        dec += itemRange.count;
+
+        const int firstIndexAfterRange = itemRange.index + itemRange.count;
+        if (index < firstIndexAfterRange) {
+            // The index is part of the removed range
+            if (behaviour == DiscardRemovedIndex) {
+                return -1;
+            } else {
+                // Use the first item after the range as new index
+                index = firstIndexAfterRange;
+                break;
+            }
+        }
     }
+    return qBound(-1, index - dec, m_model->count() - 1);
 }
 
-#include "kitemlistselectionmanager.moc"
+#include "moc_kitemlistselectionmanager.cpp"