Added support for highlighting items by typing their name on the keyboard.

src/CMakeLists.txt

@@ -25,6 +25,7 @@ set(dolphinprivate_LIB_SRCS
     kitemviews/kitemlistcontainer.cpp
     kitemviews/kitemlistcontroller.cpp
     kitemviews/kitemlistgroupheader.cpp
+    kitemviews/kitemlistkeyboardsearchmanager.cpp
     kitemviews/kitemlistrubberband.cpp
     kitemviews/kitemlistselectionmanager.cpp
     kitemviews/kitemlistsizehintresolver.cpp

src/kitemviews/kfileitemmodel.cpp

@@ -124,6 +124,24 @@ bool KFileItemModel::setData(int index, const QHash<QByteArray, QVariant>& value
     return false;
 }
 
+int KFileItemModel::indexForKeyboardSearch(const QString& text, int startFromIndex) const
+{
+    startFromIndex = qMax(0, startFromIndex);
+    for (int i = startFromIndex; i < count(); i++) {
+        if (data(i)["name"].toString().startsWith(text, Qt::CaseInsensitive)) {
+            kDebug() << data(i)["name"].toString();
+            return i;
+        }
+    }
+    for (int i = 0; i < startFromIndex; i++) {
+        if (data(i)["name"].toString().startsWith(text, Qt::CaseInsensitive)) {
+            kDebug() << data(i)["name"].toString();
+            return i;
+        }
+    }
+    return -1;
+}
+
 bool KFileItemModel::supportsGrouping() const
 {
     return true;

src/kitemviews/kfileitemmodel.h

@@ -54,6 +54,10 @@ public:
     virtual QHash<QByteArray, QVariant> data(int index) const;
     virtual bool setData(int index, const QHash<QByteArray, QVariant> &values);
 
+    /**
+     * @reimp
+     */
+    virtual int indexForKeyboardSearch(const QString& text, int startFromIndex = 0) const;
     /**
      * @return True
      * @reimp

src/kitemviews/kitemlistcontroller.cpp

@@ -25,6 +25,7 @@
 #include "kitemlistview.h"
 #include "kitemlistrubberband_p.h"
 #include "kitemlistselectionmanager.h"
+#include "kitemlistkeyboardsearchmanager_p.h"
 
 #include <QApplication>
 #include <QDrag>
@@ -42,10 +43,12 @@ KItemListController::KItemListController(QObject* parent) :
     m_model(0),
     m_view(0),
     m_selectionManager(new KItemListSelectionManager(this)),
+    m_keyboardManager(new KItemListKeyboardSearchManager(this)),
     m_pressedIndex(-1),
     m_pressedMousePos(),
     m_oldSelection()
 {
+    connect(m_keyboardManager, SIGNAL(requestItemActivation(QString,bool)), this, SLOT(slotKeyboardActivationRequested(QString,bool)));
 }
 
 KItemListController::~KItemListController()
@@ -202,10 +205,12 @@ bool KItemListController::keyPressEvent(QKeyEvent* event)
             m_selectionManager->endAnchoredSelection();
             m_selectionManager->setSelected(index, 1, KItemListSelectionManager::Toggle);
             m_selectionManager->beginAnchoredSelection(index);
+            break;
         }
 
     default:
-        break;
+        m_keyboardManager->addKeys(event->text());
+        return false;
     }
 
     if (m_selectionManager->currentItem() != index) {
@@ -227,6 +232,27 @@ bool KItemListController::keyPressEvent(QKeyEvent* event)
     return true;
 }
 
+void KItemListController::slotKeyboardActivationRequested(const QString& text, bool searchFromNextItem)
+{
+    if (!m_model) {
+        return;
+    }
+    const int currentIndex = m_selectionManager->currentItem();
+    int index;
+    if (searchFromNextItem) {
+         index = m_model->indexForKeyboardSearch(text, (currentIndex + 1) % m_model->count());
+    }
+    else {
+        index = m_model->indexForKeyboardSearch(text, currentIndex);
+    }
+    if (index >= 0) {
+        m_selectionManager->setCurrentItem(index);
+        m_selectionManager->clearSelection();
+        m_selectionManager->setSelected(index, 1);
+        m_selectionManager->beginAnchoredSelection(index);
+    }
+}
+
 bool KItemListController::inputMethodEvent(QInputMethodEvent* event)
 {
     Q_UNUSED(event);

src/kitemviews/kitemlistcontroller.h

@@ -31,6 +31,7 @@
 #include <QSet>
 
 class KItemModelBase;
+class KItemListKeyboardSearchManager;
 class KItemListSelectionManager;
 class KItemListView;
 class QGraphicsSceneHoverEvent;
@@ -132,6 +133,8 @@ private slots:
      */
     void slotRubberBandChanged();
 
+    void slotKeyboardActivationRequested(const QString& text, bool searchFromNextItem);
+
 private:
     /**
      * Creates a QDrag object to start a drag-operation.
@@ -146,6 +149,7 @@ private:
     KItemModelBase* m_model;
     KItemListView* m_view;
     KItemListSelectionManager* m_selectionManager;
+    KItemListKeyboardSearchManager* m_keyboardManager;
     int m_pressedIndex;
     QPointF m_pressedMousePos;
 

src/kitemviews/kitemlistkeyboardsearchmanager.cpp

@@ -0,0 +1,54 @@
+/***************************************************************************
+ * Copyright (C) 2011 by Tirtha Chatterjee <tirtha.p.chatterjee@gmail.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            *
+ ***************************************************************************/
+
+#include "kitemlistkeyboardsearchmanager_p.h"
+
+#include <QApplication>
+#include <QElapsedTimer>
+
+#include <KDebug>
+
+KItemListKeyboardSearchManager::KItemListKeyboardSearchManager(QObject* parent) :
+    QObject(parent)
+{
+    m_keyboardInputTime.invalidate();
+}
+
+KItemListKeyboardSearchManager::~KItemListKeyboardSearchManager()
+{
+}
+
+void KItemListKeyboardSearchManager::addKeys(const QString& keys)
+{
+    const bool keyboardTimeWasValid = m_keyboardInputTime.isValid();
+    const qint64 keyboardInputTimeElapsed = m_keyboardInputTime.restart();
+    if (keyboardInputTimeElapsed > QApplication::keyboardInputInterval()
+        || !keyboardTimeWasValid || keys.isEmpty()) {
+        m_searchedString.clear();
+    }
+    const bool searchFromNextItem = m_searchedString.isEmpty();
+    if (!keys.isEmpty()) {
+        m_searchedString.append(keys);
+        emit requestItemActivation(m_searchedString, searchFromNextItem);
+    }
+    m_keyboardInputTime.start();
+}

src/kitemviews/kitemlistkeyboardsearchmanager_p.h

@@ -0,0 +1,73 @@
+/***************************************************************************
+ * Copyright (C) 2011 by Tirtha Chatterjee <tirtha.p.chatterjee@gmail.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            *
+ ***************************************************************************/
+
+#ifndef KITEMLISTKEYBOARDMANAGER_H
+#define KITEMLISTKEYBOARDMANAGER_H
+
+#include <libdolphin_export.h>
+
+#include <QObject>
+#include <QString>
+#include <QElapsedTimer>
+
+class KItemListController;
+class QInputMethodEvent;
+class QKeyEvent;
+
+/**
+ * @brief Controls the keyboard searching ability for a KItemListController.
+ *
+ * @see KItemListController
+ * @see KItemModelBase
+ */
+class LIBDOLPHINPRIVATE_EXPORT KItemListKeyboardSearchManager : public QObject
+{
+    Q_OBJECT
+
+public:
+
+    KItemListKeyboardSearchManager(QObject* parent = 0);
+    virtual ~KItemListKeyboardSearchManager();
+
+    /**
+     * Add \a keys to the text buffer used for searching.
+     */
+    void addKeys(const QString& keys);
+
+signals:
+
+    /**
+     * Is emitted when a text is to be searched.
+     * @param searchFromNextItem if true, start searching
+     * from item next to current item. Otherwise, search from
+     * current item.
+     */
+    void requestItemActivation(const QString& string, bool searchFromNextItem);
+
+private:
+    QString m_searchedString;
+    QElapsedTimer m_keyboardInputTime;
+};
+
+#endif
+
+

src/kitemviews/kitemmodelbase.cpp

@@ -109,6 +109,11 @@ QMimeData* KItemModelBase::createMimeData(const QSet<int>& indexes) const
     return 0;
 }
 
+int KItemModelBase::indexForKeyboardSearch(const QString& text, int startFromIndex) const
+{
+    return -1;
+}
+
 void KItemModelBase::onGroupRoleChanged(const QByteArray& current, const QByteArray& previous)
 {
     Q_UNUSED(current);

src/kitemviews/kitemmodelbase.h

@@ -116,6 +116,13 @@ public:
      */
     virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
 
+    /**
+     * @return Reimplement this to return the index for the first item
+     * beginning with string typed in through the keyboard, -1 if not found.
+     * @param text              the text which has been typed in through the keyboard
+     * @param startFromIndex    the index from which to start searching from
+     */
+    virtual int indexForKeyboardSearch(const QString& text, int startFromIndex = 0) const;
 signals:
     /**
      * Is emitted if one or more items have been inserted. Each item-range consists