From 1cb5a202e4c861025d4eda5813848cdb7d5f350d Mon Sep 17 00:00:00 2001 From: Peter Penz Date: Sat, 24 Jul 2010 22:17:01 +0000 Subject: Sourcecode hierarchy cleanup: Move folders "tooltips" and "versioncontrol" into "views" svn path=/trunk/KDE/kdebase/apps/; revision=1154151 --- src/CMakeLists.txt | 14 +- src/tooltips/filemetadatatooltip.cpp | 159 ---------- src/tooltips/filemetadatatooltip.h | 70 ----- src/tooltips/tooltipmanager.cpp | 277 ----------------- src/tooltips/tooltipmanager.h | 106 ------- .../fileviewversioncontrolplugin.desktop | 60 ---- src/versioncontrol/pendingthreadsmaintainer.cpp | 77 ----- src/versioncontrol/pendingthreadsmaintainer.h | 83 ----- src/versioncontrol/updateitemstatesthread.cpp | 101 ------- src/versioncontrol/updateitemstatesthread.h | 84 ------ src/versioncontrol/versioncontrolobserver.cpp | 335 --------------------- src/versioncontrol/versioncontrolobserver.h | 149 --------- src/views/tooltips/filemetadatatooltip.cpp | 159 ++++++++++ src/views/tooltips/filemetadatatooltip.h | 70 +++++ src/views/tooltips/tooltipmanager.cpp | 277 +++++++++++++++++ src/views/tooltips/tooltipmanager.h | 106 +++++++ .../fileviewversioncontrolplugin.desktop | 60 ++++ .../versioncontrol/pendingthreadsmaintainer.cpp | 77 +++++ .../versioncontrol/pendingthreadsmaintainer.h | 83 +++++ .../versioncontrol/updateitemstatesthread.cpp | 101 +++++++ src/views/versioncontrol/updateitemstatesthread.h | 84 ++++++ .../versioncontrol/versioncontrolobserver.cpp | 335 +++++++++++++++++++++ src/views/versioncontrol/versioncontrolobserver.h | 149 +++++++++ 23 files changed, 1508 insertions(+), 1508 deletions(-) delete mode 100644 src/tooltips/filemetadatatooltip.cpp delete mode 100644 src/tooltips/filemetadatatooltip.h delete mode 100644 src/tooltips/tooltipmanager.cpp delete mode 100644 src/tooltips/tooltipmanager.h delete mode 100644 src/versioncontrol/fileviewversioncontrolplugin.desktop delete mode 100644 src/versioncontrol/pendingthreadsmaintainer.cpp delete mode 100644 src/versioncontrol/pendingthreadsmaintainer.h delete mode 100644 src/versioncontrol/updateitemstatesthread.cpp delete mode 100644 src/versioncontrol/updateitemstatesthread.h delete mode 100644 src/versioncontrol/versioncontrolobserver.cpp delete mode 100644 src/versioncontrol/versioncontrolobserver.h create mode 100644 src/views/tooltips/filemetadatatooltip.cpp create mode 100644 src/views/tooltips/filemetadatatooltip.h create mode 100644 src/views/tooltips/tooltipmanager.cpp create mode 100644 src/views/tooltips/tooltipmanager.h create mode 100644 src/views/versioncontrol/fileviewversioncontrolplugin.desktop create mode 100644 src/views/versioncontrol/pendingthreadsmaintainer.cpp create mode 100644 src/views/versioncontrol/pendingthreadsmaintainer.h create mode 100644 src/views/versioncontrol/updateitemstatesthread.cpp create mode 100644 src/views/versioncontrol/updateitemstatesthread.h create mode 100644 src/views/versioncontrol/versioncontrolobserver.cpp create mode 100644 src/views/versioncontrol/versioncontrolobserver.h (limited to 'src') diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 9602272ca..021edee38 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -22,11 +22,6 @@ set(dolphinprivate_LIB_SRCS settings/filemetadataconfigurationdialog.cpp settings/viewpropertiesdialog.cpp settings/viewpropsprogressinfo.cpp - tooltips/filemetadatatooltip.cpp - tooltips/tooltipmanager.cpp - versioncontrol/pendingthreadsmaintainer.cpp - versioncontrol/updateitemstatesthread.cpp - versioncontrol/versioncontrolobserver.cpp views/additionalinfoaccessor.cpp views/dolphincategorydrawer.cpp views/dolphindirlister.cpp @@ -46,9 +41,14 @@ set(dolphinprivate_LIB_SRCS views/dolphinviewcontroller.cpp views/draganddrophelper.cpp views/folderexpander.cpp + views/renamedialog.cpp views/selectiontoggle.cpp views/selectionmanager.cpp - views/renamedialog.cpp + views/tooltips/filemetadatatooltip.cpp + views/tooltips/tooltipmanager.cpp + views/versioncontrol/pendingthreadsmaintainer.cpp + views/versioncontrol/updateitemstatesthread.cpp + views/versioncontrol/versioncontrolobserver.cpp views/viewextensionsfactory.cpp views/viewmodecontroller.cpp views/viewproperties.cpp @@ -90,7 +90,7 @@ install(TARGETS dolphinpart DESTINATION ${PLUGIN_INSTALL_DIR}) install(FILES dolphinpart.rc DESTINATION ${DATA_INSTALL_DIR}/dolphinpart) install(FILES dolphinpart.desktop DESTINATION ${SERVICES_INSTALL_DIR} ) -install(FILES versioncontrol/fileviewversioncontrolplugin.desktop DESTINATION ${SERVICETYPES_INSTALL_DIR}) +install(FILES views/versioncontrol/fileviewversioncontrolplugin.desktop DESTINATION ${SERVICETYPES_INSTALL_DIR}) ########################################## diff --git a/src/tooltips/filemetadatatooltip.cpp b/src/tooltips/filemetadatatooltip.cpp deleted file mode 100644 index d6e0c36aa..000000000 --- a/src/tooltips/filemetadatatooltip.cpp +++ /dev/null @@ -1,159 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2010 by Peter Penz * - * Copyright (C) 2008 by Fredrik Höglund * - * * - * 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 -#include -#include -#include - -#include -#include -#include - -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/tooltips/filemetadatatooltip.h b/src/tooltips/filemetadatatooltip.h deleted file mode 100644 index d5356cd23..000000000 --- a/src/tooltips/filemetadatatooltip.h +++ /dev/null @@ -1,70 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2010 by Peter Penz * - * Copyright (C) 2008 by Fredrik Höglund * - * * - * 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 - -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/tooltips/tooltipmanager.cpp b/src/tooltips/tooltipmanager.cpp deleted file mode 100644 index 726aed9f3..000000000 --- a/src/tooltips/tooltipmanager.cpp +++ /dev/null @@ -1,277 +0,0 @@ -/******************************************************************************* - * Copyright (C) 2008 by Konstantin Heil * - * * - * 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 -#include -#include - -#include -#include -#include -#include -#include - -#include -#include - -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(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/tooltips/tooltipmanager.h b/src/tooltips/tooltipmanager.h deleted file mode 100644 index 24e72f28b..000000000 --- a/src/tooltips/tooltipmanager.h +++ /dev/null @@ -1,106 +0,0 @@ -/******************************************************************************* - * Copyright (C) 2008 by Konstantin Heil * - * * - * 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 -#include - -#include - -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 diff --git a/src/versioncontrol/fileviewversioncontrolplugin.desktop b/src/versioncontrol/fileviewversioncontrolplugin.desktop deleted file mode 100644 index 4239d4ddc..000000000 --- a/src/versioncontrol/fileviewversioncontrolplugin.desktop +++ /dev/null @@ -1,60 +0,0 @@ -[Desktop Entry] -Type=ServiceType -X-KDE-ServiceType=FileViewVersionControlPlugin -Comment=Version Control Plugin for File Views -Comment[ca]=Connector de control de versions per a les vistes de fitxers -Comment[ca@valencia]=Connector de control de versions per a les vistes de fitxers -Comment[cs]=Modul pro správu verzí pro pohledy na soubory -Comment[csb]=Wtëkôcz kòntrolë wersëji dlô pòdzerków lopków -Comment[da]=Versionsstyringsplugin til filvisninger -Comment[de]=Versionskontroll-Modul für Dateiansichten -Comment[el]=Έλεγχος εκδόσεων πρόσθετων για την προβολή των αρχείων -Comment[en_GB]=Version Control Plugin for File Views -Comment[eo]=Kromprogramo de versia kontrolo por dosiervidilo -Comment[es]=Complemento de control de versiones para vistas de archivos -Comment[et]=Failivaadete versioonikontrolli plugin -Comment[eu]=Bertsio kontrol plugina fitxategi ikuspegietarako -Comment[fi]=Versionhallintaliitännäinen tiedostonäkymille -Comment[fr]=Module externe de contrôle de révision pour la vue de fichiers -Comment[fy]=Ferzje kontrôle plugin foar triem werjeften -Comment[hr]=Priključak sustava kontrole inačica za prikaz datoteka -Comment[hu]=Verziókövető modul fájlnézetekhez -Comment[ia]=Plugin de Controlo de Version pro vistas de file -Comment[id]=Plugin Kontrol Versi untuk Tampilan Berkas -Comment[is]=Útgáfustýringar-íforrit fyrir skráasýnir -Comment[it]=Estensione di controllo delle versioni per le viste dei file -Comment[ja]=ファイルビューのためのバージョン管理プラグイン -Comment[kk]=Файл көрнісіне арналған Нұсқаларды басқару плагины -Comment[km]=កំណែ​កម្មវិធី​ជំនួយ​វត្ថុ​បញ្ជា​​សម្រាប់​មើល​ឯកសារ -Comment[kn]=ಕಡತ ನೋಟಗಳಿಗಾಗಿ ಆವೃತ್ತಿ ನಿಯಂತ್ರಣಾ ವ್ಯವಸ್ಥೆ ಪ್ಲಗ್ಗಿನ್ (ಮಿಳಿತಾನ್ವಯ) -Comment[ko]=파일 보기를 위한 버전 관리 플러그인 -Comment[lt]=Versijų kontrolės priedas failų tvarkyklėms -Comment[lv]=Versiju kontroles spraudnis Failu skatiem -Comment[mk]=Приклучок за „Преглед на датотеки“ за контрола на верзии -Comment[ml]=ഫയല്‍ അവതരണത്തിനുള്ള വേര്‍ഷന്‍ കണ്ട്രോള്‍ സംയോജകം -Comment[nb]=Versjonskontrollmodul for filvisninger -Comment[nds]=Verschoonkuntrull-Moduul för Dateiansichten -Comment[nl]=Plugin voor versiecontrole op bestandoverzichten -Comment[nn]=Versjonskontroll-tillegg for filvisingar -Comment[pa]=ਫਾਇਲ ਝਲਕ ਲਈ ਵਰਜਨ ਕੰਟਰੋਲ ਪਲੱਗਇਨ -Comment[pl]=Wtyczka kontroli wersji dla widoku plików -Comment[pt]='Plugin' de Controlo de Versões para as Áreas de Ficheiros -Comment[pt_BR]=Extensão de controle de versões para as visualizações de arquivos -Comment[ro]=Modul de control al versiunii pentru Vizualizări fișiere -Comment[ru]=Расширение для управления версиями для компонента просмотра папки -Comment[si]=ගොනු දැකුම් සඳහා අනුවාද පාලන ප්ලගින -Comment[sk]=Modul pre správu verzií v súborovom zobrazení -Comment[sl]=Vstavek za delo z nadzorom različic za prikaz datotek -Comment[sr]=Прикључак управљања верзијама за фајл приказе -Comment[sr@ijekavian]=Прикључак управљања верзијама за фајл приказе -Comment[sr@ijekavianlatin]=Priključak upravljanja verzijama za fajl prikaze -Comment[sr@latin]=Priključak upravljanja verzijama za fajl prikaze -Comment[sv]=Insticksprogram för versionskontroll i filvyer -Comment[tg]=Модули идоракунӣ барои намоиши файлҳо -Comment[th]=ส่วนเสริมการควบคุมเวอร์ชันสำหรับมุมมองแฟ้มต่าง ๆ -Comment[tr]=Dosya Görünümleri için Sürüm Kontrol Eklentisi -Comment[uk]=Додаток керування версіями для панелей перегляду файлів -Comment[wa]=Tchôke-divins di controle del modêye po les Vuwes des fitchîs -Comment[x-test]=xxVersion Control Plugin for File Viewsxx -Comment[zh_CN]=文件视图的版本控制插件 -Comment[zh_TW]=檔案檢視的版本控制外掛程式 diff --git a/src/versioncontrol/pendingthreadsmaintainer.cpp b/src/versioncontrol/pendingthreadsmaintainer.cpp deleted file mode 100644 index f61c79975..000000000 --- a/src/versioncontrol/pendingthreadsmaintainer.cpp +++ /dev/null @@ -1,77 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2010 by Peter Penz * - * * - * 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 "pendingthreadsmaintainer.h" - -#include -#include -#include - -struct PendingThreadsMaintainerSingleton -{ - PendingThreadsMaintainer instance; -}; -K_GLOBAL_STATIC(PendingThreadsMaintainerSingleton, s_pendingThreadsMaintainer) - - -PendingThreadsMaintainer& PendingThreadsMaintainer::instance() -{ - return s_pendingThreadsMaintainer->instance; -} - -PendingThreadsMaintainer::~PendingThreadsMaintainer() -{ -} - -void PendingThreadsMaintainer::append(QThread* thread) -{ - Q_ASSERT(thread != 0); - m_threads.append(thread); - m_timer->start(); -} - -PendingThreadsMaintainer::PendingThreadsMaintainer() : - QObject(), - m_threads(), - m_timer(0) -{ - m_timer = new QTimer(this); - m_timer->setSingleShot(true); - m_timer->setInterval(5000); // 5 seconds - connect(m_timer, SIGNAL(timeout()), this, SLOT(cleanup())); -} - -void PendingThreadsMaintainer::cleanup() -{ - QList::iterator it = m_threads.begin(); - while (it != m_threads.end()) { - if ((*it)->isFinished()) { - (*it)->deleteLater(); - it = m_threads.erase(it); - } else { - ++it; - } - } - - if (!m_threads.isEmpty()) { - m_timer->start(); - } -} - -#include "pendingthreadsmaintainer.moc" diff --git a/src/versioncontrol/pendingthreadsmaintainer.h b/src/versioncontrol/pendingthreadsmaintainer.h deleted file mode 100644 index 342cb421d..000000000 --- a/src/versioncontrol/pendingthreadsmaintainer.h +++ /dev/null @@ -1,83 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2010 by Peter Penz * - * * - * 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 PENDINGTHREADSMAINTAINER_H -#define PENDINGTHREADSMAINTAINER_H - -#include - -#include - -class QTimer; - -/** - * If the creator of a thread gets deleted, although the thread is still - * working, usually QThread::wait() is invoked. The drawback of this - * approach is that the user interface gets blocked for an undefined amount - * of time. If the thread does not contain references to the creator, the - * deleting can be forwarded to the PendingThreadsMaintainer. In the following - * example it is assumed, that m_thread will be 0, if it has been deleted by the - * creator after receiving the signal QThread::finished(): - * - * \code - * ThreadCreator::~ThreadCreator() - * { - * if (m_thread != 0) { - * PendingThreadsMaintainer::instance().append(m_thread); - * m_thread = 0; - * } - * } - * \endcode - * - * The thread will get automatically deleted after it (or has already) been finished. - * - * Implementation note: Connecting to the signal QThread::finished() is - * not sufficient, as it is possible that the thread has already emitted - * the signal, but the signal has not been received yet by the thread creator. - * Because of this a polling is done each 5 seconds to check, whether the - * thread has been finished. - */ -class LIBDOLPHINPRIVATE_EXPORT PendingThreadsMaintainer : public QObject -{ - Q_OBJECT - -public: - static PendingThreadsMaintainer& instance(); - virtual ~PendingThreadsMaintainer(); - - /** - * Appends the thread \p thread to the maintainer. The thread - * will be deleted by the maintainer after it has been finished. - */ - void append(QThread* thread); - -protected: - PendingThreadsMaintainer(); - -private slots: - void cleanup(); - -private: - QList m_threads; - QTimer* m_timer; - - friend class PendingThreadsMaintainerSingleton; -}; - -#endif diff --git a/src/versioncontrol/updateitemstatesthread.cpp b/src/versioncontrol/updateitemstatesthread.cpp deleted file mode 100644 index 57c4481c3..000000000 --- a/src/versioncontrol/updateitemstatesthread.cpp +++ /dev/null @@ -1,101 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2009 by Peter Penz * - * * - * 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 "updateitemstatesthread.h" - -#include - -UpdateItemStatesThread::UpdateItemStatesThread() : - QThread(), - m_globalPluginMutex(0), - m_plugin(0), - m_itemMutex(), - m_retrievedItems(false), - m_itemStates() -{ - // Several threads may share one instance of a plugin. A global - // mutex is required to serialize the retrieval of version control - // states inside run(). - static QMutex globalMutex; - m_globalPluginMutex = &globalMutex; -} - -UpdateItemStatesThread::~UpdateItemStatesThread() -{ -} - -void UpdateItemStatesThread::setData(KVersionControlPlugin* plugin, - const QList& itemStates) -{ - QMutexLocker itemLocker(&m_itemMutex); - m_itemStates = itemStates; - - QMutexLocker pluginLocker(m_globalPluginMutex); - m_plugin = plugin; -} - -void UpdateItemStatesThread::run() -{ - Q_ASSERT(!m_itemStates.isEmpty()); - Q_ASSERT(m_plugin != 0); - - // The items from m_itemStates may be located in different directory levels. The version - // plugin requires the root directory for KVersionControlPlugin::beginRetrieval(). Instead - // of doing an expensive search, we utilize the knowledge of the implementation of - // VersionControlObserver::addDirectory() to be sure that the last item contains the root. - QMutexLocker itemLocker(&m_itemMutex); - const QString directory = m_itemStates.last().item.url().directory(KUrl::AppendTrailingSlash); - itemLocker.unlock(); - - QMutexLocker pluginLocker(m_globalPluginMutex); - m_retrievedItems = false; - if (m_plugin->beginRetrieval(directory)) { - itemLocker.relock(); - const int count = m_itemStates.count(); - for (int i = 0; i < count; ++i) { - m_itemStates[i].version = m_plugin->versionState(m_itemStates[i].item); - } - m_plugin->endRetrieval(); - m_retrievedItems = true; - } -} - -bool UpdateItemStatesThread::lockPlugin() -{ - return m_globalPluginMutex->tryLock(300); -} - -void UpdateItemStatesThread::unlockPlugin() -{ - m_globalPluginMutex->unlock(); -} - -QList UpdateItemStatesThread::itemStates() const -{ - QMutexLocker locker(&m_itemMutex); - return m_itemStates; -} - -bool UpdateItemStatesThread::retrievedItems() const -{ - QMutexLocker locker(&m_itemMutex); - return m_retrievedItems; -} - -#include "updateitemstatesthread.moc" diff --git a/src/versioncontrol/updateitemstatesthread.h b/src/versioncontrol/updateitemstatesthread.h deleted file mode 100644 index 8467c87d7..000000000 --- a/src/versioncontrol/updateitemstatesthread.h +++ /dev/null @@ -1,84 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2009 by Peter Penz * - * * - * 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 UPDATEITEMSTATESTHREAD_H -#define UPDATEITEMSTATESTHREAD_H - -#include -#include - -#include -#include - -class KVersionControlPlugin; - -/** - * The performance of updating the version state of items depends - * on the used plugin. To prevent that Dolphin gets blocked by a - * slow plugin, the updating is delegated to a thread. - */ -class LIBDOLPHINPRIVATE_EXPORT UpdateItemStatesThread : public QThread -{ - Q_OBJECT - -public: - UpdateItemStatesThread(); - virtual ~UpdateItemStatesThread(); - - /** - * @param plugin Version control plugin that is used to update the - * state of the items. Whenever the plugin is accessed - * from the thread creator after starting the thread, - * UpdateItemStatesThread::lockPlugin() and - * UpdateItemStatesThread::unlockPlugin() must be used. - * @param itemStates List of items, where the states get updated. - */ - void setData(KVersionControlPlugin* plugin, - const QList& itemStates); - - /** - * Whenever the plugin is accessed by the thread creator, lockPlugin() must - * be invoked. True is returned, if the plugin could be locked within 300 - * milliseconds. - */ - bool lockPlugin(); - - /** - * Must be invoked if lockPlugin() returned true and plugin has been accessed - * by the thread creator. - */ - void unlockPlugin(); - - QList itemStates() const; - - bool retrievedItems() const; - -protected: - virtual void run(); - -private: - QMutex* m_globalPluginMutex; // Protects the m_plugin globally - KVersionControlPlugin* m_plugin; - - mutable QMutex m_itemMutex; // Protects m_retrievedItems and m_itemStates - bool m_retrievedItems; - QList m_itemStates; -}; - -#endif // UPDATEITEMSTATESTHREAD_H diff --git a/src/versioncontrol/versioncontrolobserver.cpp b/src/versioncontrol/versioncontrolobserver.cpp deleted file mode 100644 index 51337e097..000000000 --- a/src/versioncontrol/versioncontrolobserver.cpp +++ /dev/null @@ -1,335 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2009 by Peter Penz * - * * - * 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 "versioncontrolobserver.h" - -#include "dolphin_versioncontrolsettings.h" - -#include -#include -#include -#include -#include - -#include "pendingthreadsmaintainer.h" -#include "updateitemstatesthread.h" - -#include -#include -#include -#include - -#include - -VersionControlObserver::VersionControlObserver(QAbstractItemView* view) : - QObject(view), - m_pendingItemStatesUpdate(false), - m_versionedDirectory(false), - m_silentUpdate(false), - m_view(view), - m_dirLister(0), - m_dolphinModel(0), - m_dirVerificationTimer(0), - m_plugin(0), - m_updateItemStatesThread(0) -{ - Q_ASSERT(view != 0); - - QAbstractProxyModel* proxyModel = qobject_cast(view->model()); - m_dolphinModel = (proxyModel == 0) ? - qobject_cast(view->model()) : - qobject_cast(proxyModel->sourceModel()); - if (m_dolphinModel != 0) { - m_dirLister = m_dolphinModel->dirLister(); - connect(m_dirLister, SIGNAL(completed()), - this, SLOT(delayedDirectoryVerification())); - - // The verification timer specifies the timeout until the shown directory - // is checked whether it is versioned. Per default it is assumed that users - // don't iterate through versioned directories and a high timeout is used - // The timeout will be decreased as soon as a versioned directory has been - // found (see verifyDirectory()). - m_dirVerificationTimer = new QTimer(this); - m_dirVerificationTimer->setSingleShot(true); - m_dirVerificationTimer->setInterval(500); - connect(m_dirVerificationTimer, SIGNAL(timeout()), - this, SLOT(verifyDirectory())); - } -} - -VersionControlObserver::~VersionControlObserver() -{ - if (m_updateItemStatesThread != 0) { - if (m_updateItemStatesThread->isFinished()) { - delete m_updateItemStatesThread; - m_updateItemStatesThread = 0; - } else { - // The version controller gets deleted, while a thread still - // is working to get the version information. To avoid a blocking - // user interface, the thread will be forwarded to the - // PendingThreadsMaintainer, which will delete the thread later. - disconnect(m_updateItemStatesThread, SIGNAL(finished()), - this, SLOT(slotThreadFinished())); - PendingThreadsMaintainer::instance().append(m_updateItemStatesThread); - m_updateItemStatesThread = 0; - } - } - - if (m_plugin != 0) { - m_plugin->disconnect(); - m_plugin = 0; - } -} - -QList VersionControlObserver::contextMenuActions(const KFileItemList& items) const -{ - QList actions; - if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { - actions = m_plugin->contextMenuActions(items); - m_updateItemStatesThread->unlockPlugin(); - } - return actions; -} - -QList VersionControlObserver::contextMenuActions(const QString& directory) const -{ - QList actions; - if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { - actions = m_plugin->contextMenuActions(directory); - m_updateItemStatesThread->unlockPlugin(); - } - - return actions; -} - -void VersionControlObserver::delayedDirectoryVerification() -{ - m_silentUpdate = false; - m_dirVerificationTimer->start(); -} - -void VersionControlObserver::silentDirectoryVerification() -{ - m_silentUpdate = true; - m_dirVerificationTimer->start(); -} - -void VersionControlObserver::verifyDirectory() -{ - const KUrl versionControlUrl = m_dirLister->url(); - if (!versionControlUrl.isLocalFile()) { - return; - } - - if (m_plugin != 0) { - m_plugin->disconnect(); - } - - m_plugin = searchPlugin(versionControlUrl); - if (m_plugin != 0) { - connect(m_plugin, SIGNAL(versionStatesChanged()), - this, SLOT(silentDirectoryVerification())); - connect(m_plugin, SIGNAL(infoMessage(QString)), - this, SIGNAL(infoMessage(QString))); - connect(m_plugin, SIGNAL(errorMessage(QString)), - this, SIGNAL(errorMessage(QString))); - connect(m_plugin, SIGNAL(operationCompletedMessage(QString)), - this, SIGNAL(operationCompletedMessage(QString))); - - if (!m_versionedDirectory) { - m_versionedDirectory = true; - - // The directory is versioned. Assume that the user will further browse through - // versioned directories and decrease the verification timer. - m_dirVerificationTimer->setInterval(100); - connect(m_dirLister, SIGNAL(refreshItems(const QList>&)), - this, SLOT(delayedDirectoryVerification())); - connect(m_dirLister, SIGNAL(newItems(const KFileItemList&)), - this, SLOT(delayedDirectoryVerification())); - } - updateItemStates(); - } else if (m_versionedDirectory) { - m_versionedDirectory = false; - - // The directory is not versioned. Reset the verification timer to a higher - // value, so that browsing through non-versioned directories is not slown down - // by an immediate verification. - m_dirVerificationTimer->setInterval(500); - disconnect(m_dirLister, SIGNAL(refreshItems(const QList>&)), - this, SLOT(delayedDirectoryVerification())); - disconnect(m_dirLister, SIGNAL(newItems(const KFileItemList&)), - this, SLOT(delayedDirectoryVerification())); - } -} - -void VersionControlObserver::slotThreadFinished() -{ - if (m_plugin == 0) { - return; - } - - if (!m_updateItemStatesThread->retrievedItems()) { - // ignore m_silentUpdate for an error message - emit errorMessage(i18nc("@info:status", "Update of version information failed.")); - return; - } - - // QAbstractItemModel::setData() triggers a bottleneck in combination with QListView - // (a detailed description of the root cause is given in the class KFilePreviewGenerator - // from kdelibs). To bypass this bottleneck, the signals of the model are temporary blocked. - // This works as the update of the data does not require a relayout of the views used in Dolphin. - const bool signalsBlocked = m_dolphinModel->signalsBlocked(); - m_dolphinModel->blockSignals(true); - - const QList itemStates = m_updateItemStatesThread->itemStates(); - foreach (const ItemState& itemState, itemStates) { - m_dolphinModel->setData(itemState.index, - QVariant(static_cast(itemState.version)), - Qt::DecorationRole); - } - - m_dolphinModel->blockSignals(signalsBlocked); - m_view->viewport()->repaint(); - - if (!m_silentUpdate) { - // Using an empty message results in clearing the previously shown information message and showing - // the default status bar information. This is useful as the user already gets feedback that the - // operation has been completed because of the icon emblems. - emit operationCompletedMessage(QString()); - } - - if (m_pendingItemStatesUpdate) { - m_pendingItemStatesUpdate = false; - updateItemStates(); - } -} - -void VersionControlObserver::updateItemStates() -{ - Q_ASSERT(m_plugin != 0); - if (m_updateItemStatesThread == 0) { - m_updateItemStatesThread = new UpdateItemStatesThread(); - connect(m_updateItemStatesThread, SIGNAL(finished()), - this, SLOT(slotThreadFinished())); - } - if (m_updateItemStatesThread->isRunning()) { - // An update is currently ongoing. Wait until the thread has finished - // the update (see slotThreadFinished()). - m_pendingItemStatesUpdate = true; - return; - } - - QList itemStates; - addDirectory(QModelIndex(), itemStates); - if (!itemStates.isEmpty()) { - if (!m_silentUpdate) { - emit infoMessage(i18nc("@info:status", "Updating version information...")); - } - m_updateItemStatesThread->setData(m_plugin, itemStates); - m_updateItemStatesThread->start(); // slotThreadFinished() is called when finished - } -} - -void VersionControlObserver::addDirectory(const QModelIndex& parentIndex, QList& itemStates) -{ - const int rowCount = m_dolphinModel->rowCount(parentIndex); - for (int row = 0; row < rowCount; ++row) { - const QModelIndex index = m_dolphinModel->index(row, DolphinModel::Version, parentIndex); - addDirectory(index, itemStates); - - ItemState itemState; - itemState.index = index; - itemState.item = m_dolphinModel->itemForIndex(index); - itemState.version = KVersionControlPlugin::UnversionedVersion; - - itemStates.append(itemState); - } -} - -KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const -{ - static bool pluginsAvailable = true; - static QList plugins; - - if (!pluginsAvailable) { - // A searching for plugins has already been done, but no - // plugins are installed - return 0; - } - - if (plugins.isEmpty()) { - // No searching for plugins has been done yet. Query the KServiceTypeTrader for - // all fileview version control plugins and remember them in 'plugins'. - const QStringList enabledPlugins = VersionControlSettings::enabledPlugins(); - - const KService::List pluginServices = KServiceTypeTrader::self()->query("FileViewVersionControlPlugin"); - for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) { - if (enabledPlugins.contains((*it)->name())) { - KVersionControlPlugin* plugin = (*it)->createInstance(); - Q_ASSERT(plugin != 0); - plugins.append(plugin); - } - } - if (plugins.isEmpty()) { - pluginsAvailable = false; - return 0; - } - } - - // Verify whether the current directory contains revision information - // like .svn, .git, ... - foreach (KVersionControlPlugin* plugin, plugins) { - // Use the KDirLister cache to check for .svn, .git, ... files - KUrl dirUrl(directory); - KUrl fileUrl = dirUrl; - fileUrl.addPath(plugin->fileName()); - const KFileItem item = m_dirLister->findByUrl(fileUrl); - if (!item.isNull()) { - return plugin; - } - - // Version control systems like Git provide the version information - // file only in the root directory. Check whether the version information file can - // be found in one of the parent directories. For performance reasons this - // step is only done, if the previous directory was marked as versioned by - // m_versionedDirectory. Drawback: Until e. g. Git is recognized, the root directory - // must be shown at least once. - if (m_versionedDirectory) { - KUrl upUrl = dirUrl.upUrl(); - while (upUrl != dirUrl) { - const QString filePath = dirUrl.pathOrUrl(KUrl::AddTrailingSlash) + plugin->fileName(); - QFileInfo file(filePath); - if (file.exists()) { - return plugin; - } - dirUrl = upUrl; - upUrl = dirUrl.upUrl(); - } - } - } - - return 0; -} - -bool VersionControlObserver::isVersioned() const -{ - return m_dolphinModel->hasVersionData() && (m_plugin != 0); -} - -#include "versioncontrolobserver.moc" diff --git a/src/versioncontrol/versioncontrolobserver.h b/src/versioncontrol/versioncontrolobserver.h deleted file mode 100644 index 08bb234b3..000000000 --- a/src/versioncontrol/versioncontrolobserver.h +++ /dev/null @@ -1,149 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2009 by Peter Penz * - * * - * 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 REVISIONCONTROLOBSERVER_H -#define REVISIONCONTROLOBSERVER_H - -#include - -#include -#include -#include -#include -#include -#include -#include - -class DolphinModel; -class KDirLister; -class KFileItemList; -class QAbstractItemView; -class QAction; -class QTimer; -class UpdateItemStatesThread; - -/** - * @brief Observes all version control plugins. - * - * The item view gets updated automatically if the currently shown - * directory is under version control. - * - * @see VersionControlPlugin - */ -class LIBDOLPHINPRIVATE_EXPORT VersionControlObserver : public QObject -{ - Q_OBJECT - -public: - VersionControlObserver(QAbstractItemView* view); - virtual ~VersionControlObserver(); - - QList contextMenuActions(const KFileItemList& items) const; - QList contextMenuActions(const QString& directory) const; - -signals: - /** - * Is emitted if an information message with the content \a msg - * should be shown. - */ - void infoMessage(const QString& msg); - - /** - * Is emitted if an error message with the content \a msg - * should be shown. - */ - void errorMessage(const QString& msg); - - /** - * Is emitted if an "operation completed" message with the content \a msg - * should be shown. - */ - void operationCompletedMessage(const QString& msg); - -private slots: - /** - * Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification() - * is invoked before the delay has been exceeded, the delay will be reset. This - * assures that a lot of short requests for directory verification only result - * in one (expensive) call. - */ - void delayedDirectoryVerification(); - - /** - * Invokes verifyDirectory() with a small delay. In opposite to - * delayedDirectoryVerification() it and assures that the verification of - * the directory is done silently without information messages. - */ - void silentDirectoryVerification(); - - void verifyDirectory(); - - /** - * Is invoked if the thread m_updateItemStatesThread has been finished - * and applys the item states. - */ - void slotThreadFinished(); - -private: - struct ItemState - { - QPersistentModelIndex index; - KFileItem item; - KVersionControlPlugin::VersionState version; - }; - - void updateItemStates(); - - /** - * Adds recursively all items from the directory \p parentIndex into - * the list \p itemStates. - */ - void addDirectory(const QModelIndex& parentIndex, QList& itemStates); - - /** - * Returns a matching plugin for the given directory. - * 0 is returned, if no matching plugin has been found. - */ - KVersionControlPlugin* searchPlugin(const KUrl& directory) const; - - /** - * Returns true, if the directory contains a version control information. - */ - bool isVersioned() const; - -private: - bool m_pendingItemStatesUpdate; - bool m_versionedDirectory; - bool m_silentUpdate; // if true, no messages will be send during the update - // of version states - - QAbstractItemView* m_view; - KDirLister* m_dirLister; - DolphinModel* m_dolphinModel; - - QTimer* m_dirVerificationTimer; - - KVersionControlPlugin* m_plugin; - UpdateItemStatesThread* m_updateItemStatesThread; - - friend class UpdateItemStatesThread; -}; - -#endif // REVISIONCONTROLOBSERVER_H - 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 * + * Copyright (C) 2008 by Fredrik Höglund * + * * + * 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 +#include +#include +#include + +#include +#include +#include + +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 * + * Copyright (C) 2008 by Fredrik Höglund * + * * + * 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 + +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 * + * * + * 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 +#include +#include + +#include +#include +#include +#include +#include + +#include +#include + +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(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 * + * * + * 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 +#include + +#include + +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 diff --git a/src/views/versioncontrol/fileviewversioncontrolplugin.desktop b/src/views/versioncontrol/fileviewversioncontrolplugin.desktop new file mode 100644 index 000000000..4239d4ddc --- /dev/null +++ b/src/views/versioncontrol/fileviewversioncontrolplugin.desktop @@ -0,0 +1,60 @@ +[Desktop Entry] +Type=ServiceType +X-KDE-ServiceType=FileViewVersionControlPlugin +Comment=Version Control Plugin for File Views +Comment[ca]=Connector de control de versions per a les vistes de fitxers +Comment[ca@valencia]=Connector de control de versions per a les vistes de fitxers +Comment[cs]=Modul pro správu verzí pro pohledy na soubory +Comment[csb]=Wtëkôcz kòntrolë wersëji dlô pòdzerków lopków +Comment[da]=Versionsstyringsplugin til filvisninger +Comment[de]=Versionskontroll-Modul für Dateiansichten +Comment[el]=Έλεγχος εκδόσεων πρόσθετων για την προβολή των αρχείων +Comment[en_GB]=Version Control Plugin for File Views +Comment[eo]=Kromprogramo de versia kontrolo por dosiervidilo +Comment[es]=Complemento de control de versiones para vistas de archivos +Comment[et]=Failivaadete versioonikontrolli plugin +Comment[eu]=Bertsio kontrol plugina fitxategi ikuspegietarako +Comment[fi]=Versionhallintaliitännäinen tiedostonäkymille +Comment[fr]=Module externe de contrôle de révision pour la vue de fichiers +Comment[fy]=Ferzje kontrôle plugin foar triem werjeften +Comment[hr]=Priključak sustava kontrole inačica za prikaz datoteka +Comment[hu]=Verziókövető modul fájlnézetekhez +Comment[ia]=Plugin de Controlo de Version pro vistas de file +Comment[id]=Plugin Kontrol Versi untuk Tampilan Berkas +Comment[is]=Útgáfustýringar-íforrit fyrir skráasýnir +Comment[it]=Estensione di controllo delle versioni per le viste dei file +Comment[ja]=ファイルビューのためのバージョン管理プラグイン +Comment[kk]=Файл көрнісіне арналған Нұсқаларды басқару плагины +Comment[km]=កំណែ​កម្មវិធី​ជំនួយ​វត្ថុ​បញ្ជា​​សម្រាប់​មើល​ឯកសារ +Comment[kn]=ಕಡತ ನೋಟಗಳಿಗಾಗಿ ಆವೃತ್ತಿ ನಿಯಂತ್ರಣಾ ವ್ಯವಸ್ಥೆ ಪ್ಲಗ್ಗಿನ್ (ಮಿಳಿತಾನ್ವಯ) +Comment[ko]=파일 보기를 위한 버전 관리 플러그인 +Comment[lt]=Versijų kontrolės priedas failų tvarkyklėms +Comment[lv]=Versiju kontroles spraudnis Failu skatiem +Comment[mk]=Приклучок за „Преглед на датотеки“ за контрола на верзии +Comment[ml]=ഫയല്‍ അവതരണത്തിനുള്ള വേര്‍ഷന്‍ കണ്ട്രോള്‍ സംയോജകം +Comment[nb]=Versjonskontrollmodul for filvisninger +Comment[nds]=Verschoonkuntrull-Moduul för Dateiansichten +Comment[nl]=Plugin voor versiecontrole op bestandoverzichten +Comment[nn]=Versjonskontroll-tillegg for filvisingar +Comment[pa]=ਫਾਇਲ ਝਲਕ ਲਈ ਵਰਜਨ ਕੰਟਰੋਲ ਪਲੱਗਇਨ +Comment[pl]=Wtyczka kontroli wersji dla widoku plików +Comment[pt]='Plugin' de Controlo de Versões para as Áreas de Ficheiros +Comment[pt_BR]=Extensão de controle de versões para as visualizações de arquivos +Comment[ro]=Modul de control al versiunii pentru Vizualizări fișiere +Comment[ru]=Расширение для управления версиями для компонента просмотра папки +Comment[si]=ගොනු දැකුම් සඳහා අනුවාද පාලන ප්ලගින +Comment[sk]=Modul pre správu verzií v súborovom zobrazení +Comment[sl]=Vstavek za delo z nadzorom različic za prikaz datotek +Comment[sr]=Прикључак управљања верзијама за фајл приказе +Comment[sr@ijekavian]=Прикључак управљања верзијама за фајл приказе +Comment[sr@ijekavianlatin]=Priključak upravljanja verzijama za fajl prikaze +Comment[sr@latin]=Priključak upravljanja verzijama za fajl prikaze +Comment[sv]=Insticksprogram för versionskontroll i filvyer +Comment[tg]=Модули идоракунӣ барои намоиши файлҳо +Comment[th]=ส่วนเสริมการควบคุมเวอร์ชันสำหรับมุมมองแฟ้มต่าง ๆ +Comment[tr]=Dosya Görünümleri için Sürüm Kontrol Eklentisi +Comment[uk]=Додаток керування версіями для панелей перегляду файлів +Comment[wa]=Tchôke-divins di controle del modêye po les Vuwes des fitchîs +Comment[x-test]=xxVersion Control Plugin for File Viewsxx +Comment[zh_CN]=文件视图的版本控制插件 +Comment[zh_TW]=檔案檢視的版本控制外掛程式 diff --git a/src/views/versioncontrol/pendingthreadsmaintainer.cpp b/src/views/versioncontrol/pendingthreadsmaintainer.cpp new file mode 100644 index 000000000..f61c79975 --- /dev/null +++ b/src/views/versioncontrol/pendingthreadsmaintainer.cpp @@ -0,0 +1,77 @@ +/*************************************************************************** + * Copyright (C) 2010 by Peter Penz * + * * + * 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 "pendingthreadsmaintainer.h" + +#include +#include +#include + +struct PendingThreadsMaintainerSingleton +{ + PendingThreadsMaintainer instance; +}; +K_GLOBAL_STATIC(PendingThreadsMaintainerSingleton, s_pendingThreadsMaintainer) + + +PendingThreadsMaintainer& PendingThreadsMaintainer::instance() +{ + return s_pendingThreadsMaintainer->instance; +} + +PendingThreadsMaintainer::~PendingThreadsMaintainer() +{ +} + +void PendingThreadsMaintainer::append(QThread* thread) +{ + Q_ASSERT(thread != 0); + m_threads.append(thread); + m_timer->start(); +} + +PendingThreadsMaintainer::PendingThreadsMaintainer() : + QObject(), + m_threads(), + m_timer(0) +{ + m_timer = new QTimer(this); + m_timer->setSingleShot(true); + m_timer->setInterval(5000); // 5 seconds + connect(m_timer, SIGNAL(timeout()), this, SLOT(cleanup())); +} + +void PendingThreadsMaintainer::cleanup() +{ + QList::iterator it = m_threads.begin(); + while (it != m_threads.end()) { + if ((*it)->isFinished()) { + (*it)->deleteLater(); + it = m_threads.erase(it); + } else { + ++it; + } + } + + if (!m_threads.isEmpty()) { + m_timer->start(); + } +} + +#include "pendingthreadsmaintainer.moc" diff --git a/src/views/versioncontrol/pendingthreadsmaintainer.h b/src/views/versioncontrol/pendingthreadsmaintainer.h new file mode 100644 index 000000000..342cb421d --- /dev/null +++ b/src/views/versioncontrol/pendingthreadsmaintainer.h @@ -0,0 +1,83 @@ +/*************************************************************************** + * Copyright (C) 2010 by Peter Penz * + * * + * 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 PENDINGTHREADSMAINTAINER_H +#define PENDINGTHREADSMAINTAINER_H + +#include + +#include + +class QTimer; + +/** + * If the creator of a thread gets deleted, although the thread is still + * working, usually QThread::wait() is invoked. The drawback of this + * approach is that the user interface gets blocked for an undefined amount + * of time. If the thread does not contain references to the creator, the + * deleting can be forwarded to the PendingThreadsMaintainer. In the following + * example it is assumed, that m_thread will be 0, if it has been deleted by the + * creator after receiving the signal QThread::finished(): + * + * \code + * ThreadCreator::~ThreadCreator() + * { + * if (m_thread != 0) { + * PendingThreadsMaintainer::instance().append(m_thread); + * m_thread = 0; + * } + * } + * \endcode + * + * The thread will get automatically deleted after it (or has already) been finished. + * + * Implementation note: Connecting to the signal QThread::finished() is + * not sufficient, as it is possible that the thread has already emitted + * the signal, but the signal has not been received yet by the thread creator. + * Because of this a polling is done each 5 seconds to check, whether the + * thread has been finished. + */ +class LIBDOLPHINPRIVATE_EXPORT PendingThreadsMaintainer : public QObject +{ + Q_OBJECT + +public: + static PendingThreadsMaintainer& instance(); + virtual ~PendingThreadsMaintainer(); + + /** + * Appends the thread \p thread to the maintainer. The thread + * will be deleted by the maintainer after it has been finished. + */ + void append(QThread* thread); + +protected: + PendingThreadsMaintainer(); + +private slots: + void cleanup(); + +private: + QList m_threads; + QTimer* m_timer; + + friend class PendingThreadsMaintainerSingleton; +}; + +#endif diff --git a/src/views/versioncontrol/updateitemstatesthread.cpp b/src/views/versioncontrol/updateitemstatesthread.cpp new file mode 100644 index 000000000..57c4481c3 --- /dev/null +++ b/src/views/versioncontrol/updateitemstatesthread.cpp @@ -0,0 +1,101 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz * + * * + * 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 "updateitemstatesthread.h" + +#include + +UpdateItemStatesThread::UpdateItemStatesThread() : + QThread(), + m_globalPluginMutex(0), + m_plugin(0), + m_itemMutex(), + m_retrievedItems(false), + m_itemStates() +{ + // Several threads may share one instance of a plugin. A global + // mutex is required to serialize the retrieval of version control + // states inside run(). + static QMutex globalMutex; + m_globalPluginMutex = &globalMutex; +} + +UpdateItemStatesThread::~UpdateItemStatesThread() +{ +} + +void UpdateItemStatesThread::setData(KVersionControlPlugin* plugin, + const QList& itemStates) +{ + QMutexLocker itemLocker(&m_itemMutex); + m_itemStates = itemStates; + + QMutexLocker pluginLocker(m_globalPluginMutex); + m_plugin = plugin; +} + +void UpdateItemStatesThread::run() +{ + Q_ASSERT(!m_itemStates.isEmpty()); + Q_ASSERT(m_plugin != 0); + + // The items from m_itemStates may be located in different directory levels. The version + // plugin requires the root directory for KVersionControlPlugin::beginRetrieval(). Instead + // of doing an expensive search, we utilize the knowledge of the implementation of + // VersionControlObserver::addDirectory() to be sure that the last item contains the root. + QMutexLocker itemLocker(&m_itemMutex); + const QString directory = m_itemStates.last().item.url().directory(KUrl::AppendTrailingSlash); + itemLocker.unlock(); + + QMutexLocker pluginLocker(m_globalPluginMutex); + m_retrievedItems = false; + if (m_plugin->beginRetrieval(directory)) { + itemLocker.relock(); + const int count = m_itemStates.count(); + for (int i = 0; i < count; ++i) { + m_itemStates[i].version = m_plugin->versionState(m_itemStates[i].item); + } + m_plugin->endRetrieval(); + m_retrievedItems = true; + } +} + +bool UpdateItemStatesThread::lockPlugin() +{ + return m_globalPluginMutex->tryLock(300); +} + +void UpdateItemStatesThread::unlockPlugin() +{ + m_globalPluginMutex->unlock(); +} + +QList UpdateItemStatesThread::itemStates() const +{ + QMutexLocker locker(&m_itemMutex); + return m_itemStates; +} + +bool UpdateItemStatesThread::retrievedItems() const +{ + QMutexLocker locker(&m_itemMutex); + return m_retrievedItems; +} + +#include "updateitemstatesthread.moc" diff --git a/src/views/versioncontrol/updateitemstatesthread.h b/src/views/versioncontrol/updateitemstatesthread.h new file mode 100644 index 000000000..9fac6192c --- /dev/null +++ b/src/views/versioncontrol/updateitemstatesthread.h @@ -0,0 +1,84 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz * + * * + * 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 UPDATEITEMSTATESTHREAD_H +#define UPDATEITEMSTATESTHREAD_H + +#include +#include + +#include +#include + +class KVersionControlPlugin; + +/** + * The performance of updating the version state of items depends + * on the used plugin. To prevent that Dolphin gets blocked by a + * slow plugin, the updating is delegated to a thread. + */ +class LIBDOLPHINPRIVATE_EXPORT UpdateItemStatesThread : public QThread +{ + Q_OBJECT + +public: + UpdateItemStatesThread(); + virtual ~UpdateItemStatesThread(); + + /** + * @param plugin Version control plugin that is used to update the + * state of the items. Whenever the plugin is accessed + * from the thread creator after starting the thread, + * UpdateItemStatesThread::lockPlugin() and + * UpdateItemStatesThread::unlockPlugin() must be used. + * @param itemStates List of items, where the states get updated. + */ + void setData(KVersionControlPlugin* plugin, + const QList& itemStates); + + /** + * Whenever the plugin is accessed by the thread creator, lockPlugin() must + * be invoked. True is returned, if the plugin could be locked within 300 + * milliseconds. + */ + bool lockPlugin(); + + /** + * Must be invoked if lockPlugin() returned true and plugin has been accessed + * by the thread creator. + */ + void unlockPlugin(); + + QList itemStates() const; + + bool retrievedItems() const; + +protected: + virtual void run(); + +private: + QMutex* m_globalPluginMutex; // Protects the m_plugin globally + KVersionControlPlugin* m_plugin; + + mutable QMutex m_itemMutex; // Protects m_retrievedItems and m_itemStates + bool m_retrievedItems; + QList m_itemStates; +}; + +#endif // UPDATEITEMSTATESTHREAD_H diff --git a/src/views/versioncontrol/versioncontrolobserver.cpp b/src/views/versioncontrol/versioncontrolobserver.cpp new file mode 100644 index 000000000..51337e097 --- /dev/null +++ b/src/views/versioncontrol/versioncontrolobserver.cpp @@ -0,0 +1,335 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz * + * * + * 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 "versioncontrolobserver.h" + +#include "dolphin_versioncontrolsettings.h" + +#include +#include +#include +#include +#include + +#include "pendingthreadsmaintainer.h" +#include "updateitemstatesthread.h" + +#include +#include +#include +#include + +#include + +VersionControlObserver::VersionControlObserver(QAbstractItemView* view) : + QObject(view), + m_pendingItemStatesUpdate(false), + m_versionedDirectory(false), + m_silentUpdate(false), + m_view(view), + m_dirLister(0), + m_dolphinModel(0), + m_dirVerificationTimer(0), + m_plugin(0), + m_updateItemStatesThread(0) +{ + Q_ASSERT(view != 0); + + QAbstractProxyModel* proxyModel = qobject_cast(view->model()); + m_dolphinModel = (proxyModel == 0) ? + qobject_cast(view->model()) : + qobject_cast(proxyModel->sourceModel()); + if (m_dolphinModel != 0) { + m_dirLister = m_dolphinModel->dirLister(); + connect(m_dirLister, SIGNAL(completed()), + this, SLOT(delayedDirectoryVerification())); + + // The verification timer specifies the timeout until the shown directory + // is checked whether it is versioned. Per default it is assumed that users + // don't iterate through versioned directories and a high timeout is used + // The timeout will be decreased as soon as a versioned directory has been + // found (see verifyDirectory()). + m_dirVerificationTimer = new QTimer(this); + m_dirVerificationTimer->setSingleShot(true); + m_dirVerificationTimer->setInterval(500); + connect(m_dirVerificationTimer, SIGNAL(timeout()), + this, SLOT(verifyDirectory())); + } +} + +VersionControlObserver::~VersionControlObserver() +{ + if (m_updateItemStatesThread != 0) { + if (m_updateItemStatesThread->isFinished()) { + delete m_updateItemStatesThread; + m_updateItemStatesThread = 0; + } else { + // The version controller gets deleted, while a thread still + // is working to get the version information. To avoid a blocking + // user interface, the thread will be forwarded to the + // PendingThreadsMaintainer, which will delete the thread later. + disconnect(m_updateItemStatesThread, SIGNAL(finished()), + this, SLOT(slotThreadFinished())); + PendingThreadsMaintainer::instance().append(m_updateItemStatesThread); + m_updateItemStatesThread = 0; + } + } + + if (m_plugin != 0) { + m_plugin->disconnect(); + m_plugin = 0; + } +} + +QList VersionControlObserver::contextMenuActions(const KFileItemList& items) const +{ + QList actions; + if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { + actions = m_plugin->contextMenuActions(items); + m_updateItemStatesThread->unlockPlugin(); + } + return actions; +} + +QList VersionControlObserver::contextMenuActions(const QString& directory) const +{ + QList actions; + if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { + actions = m_plugin->contextMenuActions(directory); + m_updateItemStatesThread->unlockPlugin(); + } + + return actions; +} + +void VersionControlObserver::delayedDirectoryVerification() +{ + m_silentUpdate = false; + m_dirVerificationTimer->start(); +} + +void VersionControlObserver::silentDirectoryVerification() +{ + m_silentUpdate = true; + m_dirVerificationTimer->start(); +} + +void VersionControlObserver::verifyDirectory() +{ + const KUrl versionControlUrl = m_dirLister->url(); + if (!versionControlUrl.isLocalFile()) { + return; + } + + if (m_plugin != 0) { + m_plugin->disconnect(); + } + + m_plugin = searchPlugin(versionControlUrl); + if (m_plugin != 0) { + connect(m_plugin, SIGNAL(versionStatesChanged()), + this, SLOT(silentDirectoryVerification())); + connect(m_plugin, SIGNAL(infoMessage(QString)), + this, SIGNAL(infoMessage(QString))); + connect(m_plugin, SIGNAL(errorMessage(QString)), + this, SIGNAL(errorMessage(QString))); + connect(m_plugin, SIGNAL(operationCompletedMessage(QString)), + this, SIGNAL(operationCompletedMessage(QString))); + + if (!m_versionedDirectory) { + m_versionedDirectory = true; + + // The directory is versioned. Assume that the user will further browse through + // versioned directories and decrease the verification timer. + m_dirVerificationTimer->setInterval(100); + connect(m_dirLister, SIGNAL(refreshItems(const QList>&)), + this, SLOT(delayedDirectoryVerification())); + connect(m_dirLister, SIGNAL(newItems(const KFileItemList&)), + this, SLOT(delayedDirectoryVerification())); + } + updateItemStates(); + } else if (m_versionedDirectory) { + m_versionedDirectory = false; + + // The directory is not versioned. Reset the verification timer to a higher + // value, so that browsing through non-versioned directories is not slown down + // by an immediate verification. + m_dirVerificationTimer->setInterval(500); + disconnect(m_dirLister, SIGNAL(refreshItems(const QList>&)), + this, SLOT(delayedDirectoryVerification())); + disconnect(m_dirLister, SIGNAL(newItems(const KFileItemList&)), + this, SLOT(delayedDirectoryVerification())); + } +} + +void VersionControlObserver::slotThreadFinished() +{ + if (m_plugin == 0) { + return; + } + + if (!m_updateItemStatesThread->retrievedItems()) { + // ignore m_silentUpdate for an error message + emit errorMessage(i18nc("@info:status", "Update of version information failed.")); + return; + } + + // QAbstractItemModel::setData() triggers a bottleneck in combination with QListView + // (a detailed description of the root cause is given in the class KFilePreviewGenerator + // from kdelibs). To bypass this bottleneck, the signals of the model are temporary blocked. + // This works as the update of the data does not require a relayout of the views used in Dolphin. + const bool signalsBlocked = m_dolphinModel->signalsBlocked(); + m_dolphinModel->blockSignals(true); + + const QList itemStates = m_updateItemStatesThread->itemStates(); + foreach (const ItemState& itemState, itemStates) { + m_dolphinModel->setData(itemState.index, + QVariant(static_cast(itemState.version)), + Qt::DecorationRole); + } + + m_dolphinModel->blockSignals(signalsBlocked); + m_view->viewport()->repaint(); + + if (!m_silentUpdate) { + // Using an empty message results in clearing the previously shown information message and showing + // the default status bar information. This is useful as the user already gets feedback that the + // operation has been completed because of the icon emblems. + emit operationCompletedMessage(QString()); + } + + if (m_pendingItemStatesUpdate) { + m_pendingItemStatesUpdate = false; + updateItemStates(); + } +} + +void VersionControlObserver::updateItemStates() +{ + Q_ASSERT(m_plugin != 0); + if (m_updateItemStatesThread == 0) { + m_updateItemStatesThread = new UpdateItemStatesThread(); + connect(m_updateItemStatesThread, SIGNAL(finished()), + this, SLOT(slotThreadFinished())); + } + if (m_updateItemStatesThread->isRunning()) { + // An update is currently ongoing. Wait until the thread has finished + // the update (see slotThreadFinished()). + m_pendingItemStatesUpdate = true; + return; + } + + QList itemStates; + addDirectory(QModelIndex(), itemStates); + if (!itemStates.isEmpty()) { + if (!m_silentUpdate) { + emit infoMessage(i18nc("@info:status", "Updating version information...")); + } + m_updateItemStatesThread->setData(m_plugin, itemStates); + m_updateItemStatesThread->start(); // slotThreadFinished() is called when finished + } +} + +void VersionControlObserver::addDirectory(const QModelIndex& parentIndex, QList& itemStates) +{ + const int rowCount = m_dolphinModel->rowCount(parentIndex); + for (int row = 0; row < rowCount; ++row) { + const QModelIndex index = m_dolphinModel->index(row, DolphinModel::Version, parentIndex); + addDirectory(index, itemStates); + + ItemState itemState; + itemState.index = index; + itemState.item = m_dolphinModel->itemForIndex(index); + itemState.version = KVersionControlPlugin::UnversionedVersion; + + itemStates.append(itemState); + } +} + +KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const +{ + static bool pluginsAvailable = true; + static QList plugins; + + if (!pluginsAvailable) { + // A searching for plugins has already been done, but no + // plugins are installed + return 0; + } + + if (plugins.isEmpty()) { + // No searching for plugins has been done yet. Query the KServiceTypeTrader for + // all fileview version control plugins and remember them in 'plugins'. + const QStringList enabledPlugins = VersionControlSettings::enabledPlugins(); + + const KService::List pluginServices = KServiceTypeTrader::self()->query("FileViewVersionControlPlugin"); + for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) { + if (enabledPlugins.contains((*it)->name())) { + KVersionControlPlugin* plugin = (*it)->createInstance(); + Q_ASSERT(plugin != 0); + plugins.append(plugin); + } + } + if (plugins.isEmpty()) { + pluginsAvailable = false; + return 0; + } + } + + // Verify whether the current directory contains revision information + // like .svn, .git, ... + foreach (KVersionControlPlugin* plugin, plugins) { + // Use the KDirLister cache to check for .svn, .git, ... files + KUrl dirUrl(directory); + KUrl fileUrl = dirUrl; + fileUrl.addPath(plugin->fileName()); + const KFileItem item = m_dirLister->findByUrl(fileUrl); + if (!item.isNull()) { + return plugin; + } + + // Version control systems like Git provide the version information + // file only in the root directory. Check whether the version information file can + // be found in one of the parent directories. For performance reasons this + // step is only done, if the previous directory was marked as versioned by + // m_versionedDirectory. Drawback: Until e. g. Git is recognized, the root directory + // must be shown at least once. + if (m_versionedDirectory) { + KUrl upUrl = dirUrl.upUrl(); + while (upUrl != dirUrl) { + const QString filePath = dirUrl.pathOrUrl(KUrl::AddTrailingSlash) + plugin->fileName(); + QFileInfo file(filePath); + if (file.exists()) { + return plugin; + } + dirUrl = upUrl; + upUrl = dirUrl.upUrl(); + } + } + } + + return 0; +} + +bool VersionControlObserver::isVersioned() const +{ + return m_dolphinModel->hasVersionData() && (m_plugin != 0); +} + +#include "versioncontrolobserver.moc" diff --git a/src/views/versioncontrol/versioncontrolobserver.h b/src/views/versioncontrol/versioncontrolobserver.h new file mode 100644 index 000000000..08bb234b3 --- /dev/null +++ b/src/views/versioncontrol/versioncontrolobserver.h @@ -0,0 +1,149 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz * + * * + * 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 REVISIONCONTROLOBSERVER_H +#define REVISIONCONTROLOBSERVER_H + +#include + +#include +#include +#include +#include +#include +#include +#include + +class DolphinModel; +class KDirLister; +class KFileItemList; +class QAbstractItemView; +class QAction; +class QTimer; +class UpdateItemStatesThread; + +/** + * @brief Observes all version control plugins. + * + * The item view gets updated automatically if the currently shown + * directory is under version control. + * + * @see VersionControlPlugin + */ +class LIBDOLPHINPRIVATE_EXPORT VersionControlObserver : public QObject +{ + Q_OBJECT + +public: + VersionControlObserver(QAbstractItemView* view); + virtual ~VersionControlObserver(); + + QList contextMenuActions(const KFileItemList& items) const; + QList contextMenuActions(const QString& directory) const; + +signals: + /** + * Is emitted if an information message with the content \a msg + * should be shown. + */ + void infoMessage(const QString& msg); + + /** + * Is emitted if an error message with the content \a msg + * should be shown. + */ + void errorMessage(const QString& msg); + + /** + * Is emitted if an "operation completed" message with the content \a msg + * should be shown. + */ + void operationCompletedMessage(const QString& msg); + +private slots: + /** + * Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification() + * is invoked before the delay has been exceeded, the delay will be reset. This + * assures that a lot of short requests for directory verification only result + * in one (expensive) call. + */ + void delayedDirectoryVerification(); + + /** + * Invokes verifyDirectory() with a small delay. In opposite to + * delayedDirectoryVerification() it and assures that the verification of + * the directory is done silently without information messages. + */ + void silentDirectoryVerification(); + + void verifyDirectory(); + + /** + * Is invoked if the thread m_updateItemStatesThread has been finished + * and applys the item states. + */ + void slotThreadFinished(); + +private: + struct ItemState + { + QPersistentModelIndex index; + KFileItem item; + KVersionControlPlugin::VersionState version; + }; + + void updateItemStates(); + + /** + * Adds recursively all items from the directory \p parentIndex into + * the list \p itemStates. + */ + void addDirectory(const QModelIndex& parentIndex, QList& itemStates); + + /** + * Returns a matching plugin for the given directory. + * 0 is returned, if no matching plugin has been found. + */ + KVersionControlPlugin* searchPlugin(const KUrl& directory) const; + + /** + * Returns true, if the directory contains a version control information. + */ + bool isVersioned() const; + +private: + bool m_pendingItemStatesUpdate; + bool m_versionedDirectory; + bool m_silentUpdate; // if true, no messages will be send during the update + // of version states + + QAbstractItemView* m_view; + KDirLister* m_dirLister; + DolphinModel* m_dolphinModel; + + QTimer* m_dirVerificationTimer; + + KVersionControlPlugin* m_plugin; + UpdateItemStatesThread* m_updateItemStatesThread; + + friend class UpdateItemStatesThread; +}; + +#endif // REVISIONCONTROLOBSERVER_H + -- cgit v1.3