Sourcecode hierarchy cleanup: Move folders "tooltips" and "versioncontrol" into "views"

svn path=/trunk/KDE/kdebase/apps/; revision=1154151

4 files changed, 612 insertions, 0 deletions

diff --git a/src/views/tooltips/filemetadatatooltip.cpp b/src/views/tooltips/filemetadatatooltip.cpp
new file mode 100644
index 000000000..d6e0c36aa
--- /dev/null
+++ b/src/views/tooltips/filemetadatatooltip.cpp
@@ -0,0 +1,159 @@
+/***************************************************************************
+ *   Copyright (C) 2010 by Peter Penz <[email protected]>                  *
+ *   Copyright (C) 2008 by Fredrik Höglund <[email protected]>               *
+ *                                                                         *
+ *   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 "filemetadatatooltip.h"
+
+#include <kcolorscheme.h>
+#include <kfilemetadatawidget.h>
+#include <kseparator.h>
+#include <kwindowsystem.h>
+
+#include <QLabel>
+#include <QPainter>
+#include <QVBoxLayout>
+
+FileMetaDataToolTip::FileMetaDataToolTip(QWidget* parent) :
+    QWidget(parent),
+    m_preview(0),
+    m_name(0),
+    m_fileMetaDataWidget(0)
+
+{
+    setAttribute(Qt::WA_TranslucentBackground);
+    setWindowFlags(Qt::ToolTip | Qt::FramelessWindowHint);
+
+    // Create widget for file preview
+    m_preview = new QLabel(this);
+
+    // Create widget for file name
+    m_name = new QLabel(this);
+    QFont font = m_name->font();
+    font.setBold(true);
+    m_name->setFont(font);
+    m_name->setAlignment(Qt::AlignHCenter);
+
+    // Create widget for the meta data
+    m_fileMetaDataWidget = new KFileMetaDataWidget();
+    m_fileMetaDataWidget->setForegroundRole(QPalette::ToolTipText);
+    m_fileMetaDataWidget->setReadOnly(true);
+
+    // The stretchwidget allows the metadata widget to be top aligned and fills
+    // the remaining vertical space
+    QWidget* stretchWidget = new QWidget(this);
+    stretchWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
+
+    QWidget* textContainer = new QWidget(this);
+    QVBoxLayout* textLayout = new QVBoxLayout(textContainer);
+    textLayout->addWidget(m_name);
+    textLayout->addWidget(new KSeparator());
+    textLayout->addWidget(m_fileMetaDataWidget);
+    textLayout->addWidget(stretchWidget);
+
+    QHBoxLayout* tipLayout = new QHBoxLayout(this);
+    tipLayout->addWidget(m_preview);
+    tipLayout->addWidget(textContainer);
+    
+    tipLayout->setSizeConstraint(QLayout::SetFixedSize);
+}
+
+FileMetaDataToolTip::~FileMetaDataToolTip()
+{
+}
+
+void FileMetaDataToolTip::setPreview(const QPixmap& pixmap)
+{
+    m_preview->setPixmap(pixmap);
+}
+
+const QPixmap* FileMetaDataToolTip::preview() const
+{
+    return m_preview->pixmap();
+}
+
+void FileMetaDataToolTip::setName(const QString& name)
+{
+    m_name->setText(name);
+}
+
+QString FileMetaDataToolTip::name() const
+{
+    return m_name->text();
+}
+
+void FileMetaDataToolTip::setItems(const KFileItemList& items)
+{
+    m_fileMetaDataWidget->setItems(items);
+}
+
+KFileItemList FileMetaDataToolTip::items() const
+{
+    return m_fileMetaDataWidget->items();
+}
+
+void FileMetaDataToolTip::paintEvent(QPaintEvent* event)
+{
+    Q_UNUSED(event);
+
+    QPainter painter(this);
+
+    QColor toColor = palette().brush(QPalette::ToolTipBase).color();
+    QColor fromColor = KColorScheme::shade(toColor, KColorScheme::LightShade, 0.2);
+
+    const bool haveAlphaChannel = KWindowSystem::compositingActive();
+    if (haveAlphaChannel) {
+        painter.setRenderHint(QPainter::Antialiasing);
+        painter.translate(0.5, 0.5);
+        toColor.setAlpha(220);
+        fromColor.setAlpha(220);
+    }
+
+    QLinearGradient gradient(QPointF(0.0, 0.0), QPointF(0.0, height()));
+    gradient.setColorAt(0.0, fromColor);
+    gradient.setColorAt(1.0, toColor);
+    painter.setPen(Qt::NoPen);
+    painter.setBrush(gradient);
+
+    const QRect rect(0, 0, width(), height());
+    if (haveAlphaChannel) {
+        const qreal radius = 5.0;
+
+        QPainterPath path;
+        path.moveTo(rect.left(), rect.top() + radius);
+        arc(path, rect.left()  + radius, rect.top()    + radius, radius, 180, -90);
+        arc(path, rect.right() - radius, rect.top()    + radius, radius,  90, -90);
+        arc(path, rect.right() - radius, rect.bottom() - radius, radius,   0, -90);
+        arc(path, rect.left()  + radius, rect.bottom() - radius, radius, 270, -90);
+        path.closeSubpath();
+
+        painter.drawPath(path);
+    } else {
+        painter.drawRect(rect);
+    }
+}
+
+void FileMetaDataToolTip::arc(QPainterPath& path,
+                              qreal cx, qreal cy,
+                              qreal radius, qreal angle,
+                              qreal sweepLength)
+{
+    path.arcTo(cx-radius, cy-radius, radius * 2, radius * 2, angle, sweepLength);
+}
+
+#include "filemetadatatooltip.moc"
diff --git a/src/views/tooltips/filemetadatatooltip.h b/src/views/tooltips/filemetadatatooltip.h
new file mode 100644
index 000000000..d5356cd23
--- /dev/null
+++ b/src/views/tooltips/filemetadatatooltip.h
@@ -0,0 +1,70 @@
+/***************************************************************************
+ *   Copyright (C) 2010 by Peter Penz <[email protected]>                  *
+ *   Copyright (C) 2008 by Fredrik Höglund <[email protected]>               *
+ *                                                                         *
+ *   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 DOLPHINCONTROLLER_H
+#define DOLPHINCONTROLLER_H
+
+#include <QWidget>
+
+class KFileItemList;
+class KFileMetaDataWidget;
+class QLabel;
+
+/**
+ * @brief Tooltip, that shows the meta information and a preview of one
+ *        or more files.
+ */
+class FileMetaDataToolTip : public QWidget
+{
+    Q_OBJECT
+
+public:
+    FileMetaDataToolTip(QWidget* parent = 0);
+    virtual ~FileMetaDataToolTip();
+
+    void setPreview(const QPixmap& pixmap);
+    const QPixmap* preview() const;
+
+    void setName(const QString& name);
+    QString name() const;
+
+    void setItems(const KFileItemList& items);
+    KFileItemList items() const;
+
+protected:
+    virtual void paintEvent(QPaintEvent* event);
+
+private:
+    /**
+     * Helper method for FileMetaDataToolTip::paintEvent() to adjust the painter path \p path
+     * by rounded corners.
+     */
+    static void arc(QPainterPath& path,
+                    qreal cx, qreal cy,
+                    qreal radius, qreal angle,
+                    qreal sweepLength);
+
+private:
+    QLabel* m_preview;
+    QLabel* m_name;
+    KFileMetaDataWidget* m_fileMetaDataWidget;
+};
+
+#endif
diff --git a/src/views/tooltips/tooltipmanager.cpp b/src/views/tooltips/tooltipmanager.cpp
new file mode 100644
index 000000000..726aed9f3
--- /dev/null
+++ b/src/views/tooltips/tooltipmanager.cpp
@@ -0,0 +1,277 @@
+/*******************************************************************************
+ *   Copyright (C) 2008 by Konstantin Heil <[email protected]> *
+ *                                                                             *
+ *   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 "tooltipmanager.h"
+
+#include "filemetadatatooltip.h"
+#include <kicon.h>
+#include <kio/previewjob.h>
+#include <kwindowsystem.h>
+
+#include <QApplication>
+#include <QDesktopWidget>
+#include <QScrollArea>
+#include <QScrollBar>
+#include <QTimer>
+
+#include <views/dolphinmodel.h>
+#include <views/dolphinsortfilterproxymodel.h>
+
+ToolTipManager::ToolTipManager(QAbstractItemView* parent,
+                               DolphinSortFilterProxyModel* model) :
+    QObject(parent),
+    m_view(parent),
+    m_dolphinModel(0),
+    m_proxyModel(model),
+    m_prepareToolTipTimer(0),
+    m_startPreviewJobTimer(0),
+    m_waitOnPreviewTimer(0),
+    m_showToolTipDelayedTimer(0),
+    m_fileMetaDataToolTip(0),
+    m_item(),
+    m_itemRect(),
+    m_generatingPreview(false),
+    m_hasDefaultIcon(false),
+    m_previewPixmap()
+{
+    static FileMetaDataToolTip* sharedToolTip = 0;
+    if (sharedToolTip == 0) {
+        sharedToolTip = new FileMetaDataToolTip();
+        // TODO: Using K_GLOBAL_STATIC would be preferable to maintain the
+        // instance, but the cleanup of KFileMetaDataWidget at this stage does
+        // not work.
+    }
+    m_fileMetaDataToolTip = sharedToolTip;
+    
+    m_dolphinModel = static_cast<DolphinModel*>(m_proxyModel->sourceModel());
+    connect(parent, SIGNAL(entered(const QModelIndex&)),
+            this, SLOT(requestToolTip(const QModelIndex&)));
+    connect(parent, SIGNAL(viewportEntered()),
+            this, SLOT(hideToolTip()));
+
+    // Initialize timers
+    m_prepareToolTipTimer = new QTimer(this);
+    m_prepareToolTipTimer->setSingleShot(true);
+    m_prepareToolTipTimer->setInterval(500);
+    connect(m_prepareToolTipTimer, SIGNAL(timeout()), this, SLOT(prepareToolTip()));   
+    
+    m_startPreviewJobTimer = new QTimer(this);
+    m_startPreviewJobTimer->setSingleShot(true);
+    m_startPreviewJobTimer->setInterval(200);
+    connect(m_startPreviewJobTimer, SIGNAL(timeout()), this, SLOT(startPreviewJob()));
+    
+    m_waitOnPreviewTimer = new QTimer(this);
+    m_waitOnPreviewTimer->setSingleShot(true);
+    m_waitOnPreviewTimer->setInterval(250);     
+    connect(m_waitOnPreviewTimer, SIGNAL(timeout()), this, SLOT(prepareToolTip()));
+
+    m_showToolTipDelayedTimer = new QTimer(this);
+    m_showToolTipDelayedTimer->setSingleShot(true);
+    m_showToolTipDelayedTimer->setInterval(100);     
+    connect(m_showToolTipDelayedTimer, SIGNAL(timeout()), this, SLOT(showToolTip()));
+    
+    // When the mousewheel is used, the items don't get a hovered indication
+    // (Qt-issue #200665). To assure that the tooltip still gets hidden,
+    // the scrollbars are observed.
+    connect(parent->horizontalScrollBar(), SIGNAL(valueChanged(int)),
+            this, SLOT(hideTip()));
+    connect(parent->verticalScrollBar(), SIGNAL(valueChanged(int)),
+            this, SLOT(hideTip()));
+
+    m_view->viewport()->installEventFilter(this);
+    m_view->installEventFilter(this);
+}
+
+ToolTipManager::~ToolTipManager()
+{
+}
+
+void ToolTipManager::hideTip()
+{
+    hideToolTip();
+}
+
+bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
+{
+    if (watched == m_view->viewport()) {
+        switch (event->type()) {
+        case QEvent::Leave:
+        case QEvent::MouseButtonPress:
+            hideToolTip();
+            break;
+        default:
+            break;
+        }
+    } else if ((watched == m_view) && (event->type() == QEvent::KeyPress)) {
+        hideToolTip();
+    }
+
+    return QObject::eventFilter(watched, event);
+}
+
+void ToolTipManager::requestToolTip(const QModelIndex& index)
+{
+    hideToolTip();
+    
+    // Only request a tooltip for the name column and when no selection or
+    // drag & drop operation is done (indicated by the left mouse button)
+    if ((index.column() == DolphinModel::Name) && !(QApplication::mouseButtons() & Qt::LeftButton)) {
+        m_itemRect = m_view->visualRect(index);
+        const QPoint pos = m_view->viewport()->mapToGlobal(m_itemRect.topLeft());
+        m_itemRect.moveTo(pos);
+
+        const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
+        m_item = m_dolphinModel->itemForIndex(dirIndex);
+
+        // Only start the previewJob when the mouse has been over this item for 200 milliseconds.
+        // This prevents a lot of useless preview jobs when passing rapidly over a lot of items.
+        m_startPreviewJobTimer->start();
+        m_previewPixmap = QPixmap();
+        m_hasDefaultIcon = false;
+
+        m_prepareToolTipTimer->start();
+    }
+}
+
+void ToolTipManager::hideToolTip()
+{
+    m_prepareToolTipTimer->stop();
+    m_startPreviewJobTimer->stop();
+    m_waitOnPreviewTimer->stop();
+    m_showToolTipDelayedTimer->stop();
+
+    m_fileMetaDataToolTip->hide();
+}
+
+void ToolTipManager::prepareToolTip()
+{
+    if (m_generatingPreview) {
+        m_waitOnPreviewTimer->start();
+    }
+
+    if (!m_previewPixmap.isNull()) {
+        showToolTipDelayed(m_previewPixmap);
+    } else if (!m_hasDefaultIcon) {
+        const QPixmap image(KIcon(m_item.iconName()).pixmap(128, 128));
+        showToolTipDelayed(image);
+        m_hasDefaultIcon = true;
+    }
+}
+
+void ToolTipManager::startPreviewJob()
+{
+    m_generatingPreview = true;
+    KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << m_item, 256, 256);
+
+    connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
+            this, SLOT(setPreviewPix(const KFileItem&, const QPixmap&)));
+    connect(job, SIGNAL(failed(const KFileItem&)),
+            this, SLOT(previewFailed()));
+}
+
+
+void ToolTipManager::setPreviewPix(const KFileItem& item,
+                                   const QPixmap& pixmap)
+{
+    if ((m_item.url() != item.url()) || pixmap.isNull()) {
+        // An old preview or an invalid preview has been received
+        previewFailed();
+    } else {
+        m_previewPixmap = pixmap;
+        m_generatingPreview = false;
+    }
+}
+
+void ToolTipManager::previewFailed()
+{
+    m_generatingPreview = false;
+}
+
+void ToolTipManager::showToolTip()
+{
+    const QRect desktop = QApplication::desktop()->screenGeometry(m_itemRect.bottomRight());
+    const QSize size = m_fileMetaDataToolTip->sizeHint();
+    
+    // m_itemRect defines the area of the item, where the tooltip should be
+    // shown. Per default the tooltip is shown in the bottom right corner.
+    // If the tooltip content exceeds the desktop borders, it must be assured that:
+    // - the content is fully visible
+    // - the content is not drawn inside m_itemRect
+    const bool hasRoomToLeft  = (m_itemRect.left()   - size.width()  >= desktop.left());
+    const bool hasRoomToRight = (m_itemRect.right()  + size.width()  <= desktop.right());
+    const bool hasRoomAbove   = (m_itemRect.top()    - size.height() >= desktop.top());
+    const bool hasRoomBelow   = (m_itemRect.bottom() + size.height() <= desktop.bottom());
+    if (!hasRoomAbove && !hasRoomBelow && !hasRoomToLeft && !hasRoomToRight) {
+        return;
+    }
+    
+    int x = 0;
+    int y = 0;
+    if (hasRoomBelow || hasRoomAbove) {
+        x = QCursor::pos().x() + 16; // TODO: use mouse pointer width instead of the magic value of 16
+        if (x + size.width() >= desktop.right()) {
+            x = desktop.right() - size.width();
+        }
+        if (hasRoomBelow) {
+            y = m_itemRect.bottom() + 1;
+        } else {
+            y = m_itemRect.top() - size.height();
+        }
+    } else {
+        Q_ASSERT(hasRoomToLeft || hasRoomToRight);
+        if (hasRoomToRight) {
+            x = m_itemRect.right() + 1;
+        } else {
+            x = m_itemRect.left() - size.width();
+        }
+
+        // Put the tooltip at the bottom of the screen. The x-coordinate has already
+        // been adjusted, so that no overlapping with m_itemRect occurs.
+        y = desktop.bottom() - size.height();
+    }
+    
+    m_fileMetaDataToolTip->move(qMax(x, 0), qMax(y, 0));
+    m_fileMetaDataToolTip->show();
+}
+
+void ToolTipManager::showToolTipDelayed(const QPixmap& pixmap)
+{
+    if (QApplication::mouseButtons() & Qt::LeftButton) {
+        return;
+    }
+    
+    m_fileMetaDataToolTip->setPreview(pixmap);
+    m_fileMetaDataToolTip->setName(m_item.text());
+    m_fileMetaDataToolTip->setItems(KFileItemList() << m_item);
+
+    // Because one tooltip instance is reused, the size hint always depends on the previous
+    // content (QWidgets don't update their layout geometry if they are invisible). To
+    // assure having a consistent size without relayout flickering, the tooltip is opened
+    // on an invisible position first. This gives the layout system some time to asynchronously
+    // update the content. Sadly this only works with compositing enabled.
+    if (KWindowSystem::compositingActive()) {
+        const QRect desktop = QApplication::desktop()->screenGeometry(m_itemRect.bottomRight());
+        m_fileMetaDataToolTip->move(desktop.bottomRight());
+        m_fileMetaDataToolTip->show();
+    }
+    
+    m_showToolTipDelayedTimer->start(); // Calls ToolTipManager::showToolTip()
+}
+
+#include "tooltipmanager.moc"
diff --git a/src/views/tooltips/tooltipmanager.h b/src/views/tooltips/tooltipmanager.h
new file mode 100644
index 000000000..24e72f28b
--- /dev/null
+++ b/src/views/tooltips/tooltipmanager.h
@@ -0,0 +1,106 @@
+/*******************************************************************************
+ *   Copyright (C) 2008 by Konstantin Heil <[email protected]> *
+ *                                                                             *
+ *   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 TOOLTIPMANAGER_H
+#define TOOLTIPMANAGER_H
+
+#include <QObject>
+#include <QRect>
+
+#include <kfileitem.h>
+
+class DolphinModel;
+class DolphinSortFilterProxyModel;
+class FileMetaDataToolTip;
+class QAbstractItemView;
+class QModelIndex;
+class QTimer;
+
+/**
+ * @brief Manages the tooltips for an item view.
+ *
+ * When hovering an item, a tooltip is shown after
+ * a short timeout. The tooltip is hidden again when the
+ * viewport is hovered or the item view has been left.
+ */
+class ToolTipManager : public QObject
+{
+    Q_OBJECT
+
+public:
+    explicit ToolTipManager(QAbstractItemView* parent,
+                            DolphinSortFilterProxyModel* model);
+    virtual ~ToolTipManager();
+
+public slots:
+    /**
+     * Hides the currently shown tooltip. Invoking this method is
+     * only needed when the tooltip should be hidden although
+     * an item is hovered.
+     */
+    void hideTip();
+
+protected:
+    virtual bool eventFilter(QObject* watched, QEvent* event);
+
+private slots:
+    void requestToolTip(const QModelIndex& index);
+    void hideToolTip();
+    void prepareToolTip();
+    void startPreviewJob();
+    void setPreviewPix(const KFileItem& item, const QPixmap& pix);
+    void previewFailed();
+    void showToolTip();
+    
+private:
+    void showToolTipDelayed(const QPixmap& pixmap);
+
+private:
+    QAbstractItemView* m_view;
+    DolphinModel* m_dolphinModel;
+    DolphinSortFilterProxyModel* m_proxyModel;
+
+    /// Timeout from requesting a tooltip until the tooltip is shown
+    QTimer* m_prepareToolTipTimer;
+    
+    /// Timeout from requesting a tooltip until starting a job to
+    /// create a preview pixmap. The preview job is started before
+    /// m_prepareToolTipTimer has been exceeded, to have the preview
+    /// pixmap ideally before the tooltip will be shown.
+    QTimer* m_startPreviewJobTimer;
+    
+    /// Don't show the tooltip, before the preview has been received. The
+    /// time indicates the interval, when the check for a received
+    /// is done.
+    QTimer* m_waitOnPreviewTimer;
+    
+    /// The tooltip is shown slightly delayed to prevent a flickering
+    /// because of layouting the content.
+    QTimer* m_showToolTipDelayedTimer;
+
+    FileMetaDataToolTip* m_fileMetaDataToolTip;
+
+    KFileItem m_item;
+    QRect m_itemRect;
+    bool m_generatingPreview;
+    bool m_hasDefaultIcon;
+    QPixmap m_previewPixmap;
+};
+
+#endif