src/iconmanager.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "iconmanager.h"
  21
  22 #include "dolphinmodel.h"
  23 #include "dolphinsortfilterproxymodel.h"
  24
  25 #include <kiconeffect.h>
  26 #include <kio/previewjob.h>
  27 #include <kdirlister.h>
  28 #include <konqmimedata.h>
  29
  30 #include <QApplication>
  31 #include <QAbstractItemView>
  32 #include <QClipboard>
  33 #include <QColor>
  34 #include <QPainter>
  35 #include <QIcon>
  36
  37 IconManager::IconManager(QAbstractItemView* parent, DolphinSortFilterProxyModel* model) :
  38     QObject(parent),
  39     m_showPreview(false),
  40     m_view(parent),
  41     m_previewTimer(0),
  42     m_previewJobs(),
  43     m_dolphinModel(0),
  44     m_proxyModel(model),
  45     m_cutItemsCache(),
  46     m_previews()
  47 {
  48     Q_ASSERT(m_view->iconSize().isValid());  // each view must provide its current icon size
  49
  50     m_dolphinModel = static_cast<DolphinModel*>(m_proxyModel->sourceModel());
  51     connect(m_dolphinModel->dirLister(), SIGNAL(newItems(const KFileItemList&)),
  52             this, SLOT(generatePreviews(const KFileItemList&)));
  53
  54     QClipboard* clipboard = QApplication::clipboard();
  55     connect(clipboard, SIGNAL(dataChanged()),
  56             this, SLOT(updateCutItems()));
  57
  58     m_previewTimer = new QTimer(this);
  59     connect(m_previewTimer, SIGNAL(timeout()), this, SLOT(dispatchPreviewQueue()));
  60 }
  61
  62 IconManager::~IconManager()
  63 {
  64     killJobs();
  65 }
  66
  67
  68 void IconManager::setShowPreview(bool show)
  69 {
  70     if (m_showPreview != show) {
  71         m_showPreview = show;
  72         m_cutItemsCache.clear();
  73         updateCutItems();
  74         if (show) {
  75             updatePreviews();
  76         }
  77     }
  78 }
  79
  80 void IconManager::updatePreviews()
  81 {
  82     if (!m_showPreview) {
  83         return;
  84     }
  85
  86     killJobs();
  87     KFileItemList itemList;
  88
  89     const int rowCount = m_dolphinModel->rowCount();
  90     for (int row = 0; row < rowCount; ++row) {
  91         const QModelIndex index = m_dolphinModel->index(row, 0);
  92         KFileItem item = m_dolphinModel->itemForIndex(index);
  93         itemList.append(item);
  94     }
  95
  96     generatePreviews(itemList);
  97 }
  98
  99 void IconManager::generatePreviews(const KFileItemList &items)
 100 {
 101     if (!m_showPreview) {
 102         return;
 103     }
 104
 105     const QRect visibleArea = m_view->viewport()->rect();
 106
 107     // Order the items in a way that the preview for the visible items
 108     // is generated first, as this improves the feeled performance a lot.
 109     KFileItemList orderedItems;
 110     foreach (const KFileItem &item, items) {
 111         const QModelIndex dirIndex = m_dolphinModel->indexForItem(item);
 112         const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
 113         const QRect itemRect = m_view->visualRect(proxyIndex);
 114         if (itemRect.intersects(visibleArea)) {
 115             orderedItems.insert(0, item);
 116         } else {
 117             orderedItems.append(item);
 118         }
 119     }
 120
 121     const QSize size = m_view->iconSize();
 122     KIO::PreviewJob* job = KIO::filePreview(orderedItems, 128, 128);
 123     connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
 124             this, SLOT(addToPreviewQueue(const KFileItem&, const QPixmap&)));
 125     connect(job, SIGNAL(finished(KJob*)),
 126             this, SLOT(slotPreviewJobFinished(KJob*)));
 127
 128     m_previewJobs.append(job);
 129     m_previewTimer->start(200);
 130 }
 131
 132 void IconManager::addToPreviewQueue(const KFileItem& item, const QPixmap& pixmap)
 133 {
 134     ItemInfo preview;
 135     preview.url = item.url();
 136     preview.pixmap = pixmap;
 137     m_previews.append(preview);
 138 }
 139
 140 void IconManager::slotPreviewJobFinished(KJob* job)
 141 {
 142     const int index = m_previewJobs.indexOf(job);
 143     m_previewJobs.removeAt(index);
 144 }
 145
 146 void IconManager::updateCutItems()
 147 {
 148     // restore the icons of all previously selected items to the
 149     // original state...
 150     foreach (const ItemInfo& cutItem, m_cutItemsCache) {
 151         const QModelIndex index = m_dolphinModel->indexForUrl(cutItem.url);
 152         if (index.isValid()) {
 153             m_dolphinModel->setData(index, QIcon(cutItem.pixmap), Qt::DecorationRole);
 154         }
 155     }
 156     m_cutItemsCache.clear();
 157
 158     // ... and apply an item effect to all currently cut items
 159     applyCutItemEffect();
 160 }
 161
 162 void IconManager::dispatchPreviewQueue()
 163 {
 164     int previewsCount = m_previews.count();
 165     if (previewsCount > 0) {
 166         // Applying the previews to the model must be done step by step
 167         // in larger blocks: Applying a preview immediately when getting the signal
 168         // 'gotPreview()' from the PreviewJob is too expensive, as a relayout
 169         // of the view would be triggered for each single preview.
 170
 171         int dispatchCount = 30;
 172         if (dispatchCount > previewsCount) {
 173             dispatchCount = previewsCount;
 174         }
 175
 176         for (int i = 0; i < dispatchCount; ++i) {
 177             const ItemInfo& preview = m_previews.first();
 178             replaceIcon(preview.url, preview.pixmap);
 179             m_previews.pop_front();
 180         }
 181
 182         previewsCount = m_previews.count();
 183     }
 184
 185     const bool workingPreviewJobs = (m_previewJobs.count() > 0);
 186     if (workingPreviewJobs) {
 187         // poll for previews as long as not all preview jobs are finished
 188         m_previewTimer->start(200);
 189     } else if (previewsCount > 0) {
 190         // all preview jobs are finished but there are still pending previews
 191         // in the queue -> poll more aggressively
 192         m_previewTimer->start(10);
 193     }
 194 }
 195
 196 void IconManager::replaceIcon(const KUrl& url, const QPixmap& pixmap)
 197 {
 198     Q_ASSERT(url.isValid());
 199     if (!m_showPreview) {
 200         // the preview has been canceled in the meantime
 201         return;
 202     }
 203
 204     // check whether the item is part of the directory lister (it is possible
 205     // that a preview from an old directory lister is received)
 206     KDirLister* dirLister = m_dolphinModel->dirLister();
 207     bool isOldPreview = true;
 208     const KUrl::List dirs = dirLister->directories();
 209     const QString itemDir = url.directory();
 210     foreach (const KUrl& url, dirs) {
 211         if (url.path() == itemDir) {
 212             isOldPreview = false;
 213             break;
 214         }
 215     }
 216     if (isOldPreview) {
 217         return;
 218     }
 219
 220     const QModelIndex idx = m_dolphinModel->indexForUrl(url);
 221     if (idx.isValid() && (idx.column() == 0)) {
 222         QPixmap icon = pixmap;
 223
 224         const KFileItem item = m_dolphinModel->itemForIndex(idx);
 225         const QString mimeType = item.mimetype();
 226         const QString mimeTypeGroup = mimeType.left(mimeType.indexOf('/'));
 227         if ((mimeTypeGroup != "image") || !applyImageFrame(icon)) {
 228             limitToSize(icon, m_view->iconSize());
 229         }
 230
 231         const QMimeData* mimeData = QApplication::clipboard()->mimeData();
 232         if (KonqMimeData::decodeIsCutSelection(mimeData) && isCutItem(item)) {
 233             KIconEffect iconEffect;
 234             icon = iconEffect.apply(icon, KIconLoader::Desktop, KIconLoader::DisabledState);
 235             m_dolphinModel->setData(idx, QIcon(icon), Qt::DecorationRole);
 236         } else {
 237             m_dolphinModel->setData(idx, QIcon(icon), Qt::DecorationRole);
 238         }
 239     }
 240 }
 241
 242 bool IconManager::isCutItem(const KFileItem& item) const
 243 {
 244     const QMimeData* mimeData = QApplication::clipboard()->mimeData();
 245     const KUrl::List cutUrls = KUrl::List::fromMimeData(mimeData);
 246
 247     const KUrl itemUrl = item.url();
 248     foreach (const KUrl& url, cutUrls) {
 249         if (url == itemUrl) {
 250             return true;
 251         }
 252     }
 253
 254     return false;
 255 }
 256
 257 void IconManager::applyCutItemEffect()
 258 {
 259     const QMimeData* mimeData = QApplication::clipboard()->mimeData();
 260     if (!KonqMimeData::decodeIsCutSelection(mimeData)) {
 261         return;
 262     }
 263
 264     KFileItemList items;
 265     KDirLister* dirLister = m_dolphinModel->dirLister();
 266     const KUrl::List dirs = dirLister->directories();
 267     foreach (const KUrl& url, dirs) {
 268         items << dirLister->itemsForDir(url);
 269     }
 270
 271     foreach (const KFileItem& item, items) {
 272         if (isCutItem(item)) {
 273             const QModelIndex index = m_dolphinModel->indexForItem(item);
 274             const QVariant value = m_dolphinModel->data(index, Qt::DecorationRole);
 275             if (value.type() == QVariant::Icon) {
 276                 const QIcon icon(qvariant_cast<QIcon>(value));
 277                 QPixmap pixmap = icon.pixmap(m_view->iconSize());
 278
 279                 // remember current pixmap for the item to be able
 280                 // to restore it when other items get cut
 281                 ItemInfo cutItem;
 282                 cutItem.url = item.url();
 283                 cutItem.pixmap = pixmap;
 284                 m_cutItemsCache.append(cutItem);
 285
 286                 // apply icon effect to the cut item
 287                 KIconEffect iconEffect;
 288                 pixmap = iconEffect.apply(pixmap, KIconLoader::Desktop, KIconLoader::DisabledState);
 289                 m_dolphinModel->setData(index, QIcon(pixmap), Qt::DecorationRole);
 290             }
 291         }
 292     }
 293 }
 294
 295 bool IconManager::applyImageFrame(QPixmap& icon)
 296 {
 297     const QSize maxSize = m_view->iconSize();
 298     const bool applyFrame = (maxSize.width()  > KIconLoader::SizeSmallMedium) &&
 299                             (maxSize.height() > KIconLoader::SizeSmallMedium) &&
 300                             ((icon.width()  > KIconLoader::SizeLarge) ||
 301                              (icon.height() > KIconLoader::SizeLarge));
 302     if (!applyFrame) {
 303         // the maximum size or the image itself is too small for a frame
 304         return false;
 305     }
 306
 307     const int frame = 4;
 308     const int doubleFrame = frame * 2;
 309
 310     // resize the icon to the maximum size minus the space required for the frame
 311     limitToSize(icon, QSize(maxSize.width() - doubleFrame, maxSize.height() - doubleFrame));
 312
 313     QPainter painter;
 314     const QPalette palette = m_view->palette();
 315     QPixmap framedIcon(icon.size().width() + doubleFrame, icon.size().height() + doubleFrame);
 316     framedIcon.fill(palette.color(QPalette::Normal, QPalette::Base));
 317     const int width = framedIcon.width() - 1;
 318     const int height = framedIcon.height() - 1;
 319
 320     painter.begin(&framedIcon);
 321     painter.drawPixmap(frame, frame, icon);
 322
 323     // add a border
 324     painter.setPen(palette.color(QPalette::Text));
 325     painter.setBrush(Qt::NoBrush);
 326     painter.drawRect(0, 0, width, height);
 327     painter.drawRect(1, 1, width - 2, height - 2);
 328
 329     // dim image frame by 12.5 %
 330     painter.setPen(QColor(0, 0, 0, 32));
 331     painter.drawRect(frame, frame, width - doubleFrame, height - doubleFrame);
 332     painter.end();
 333
 334     icon = framedIcon;
 335
 336     // provide an alpha channel for the border
 337     QPixmap alphaChannel(icon.size());
 338     alphaChannel.fill();
 339
 340     QPainter alphaPainter(&alphaChannel);
 341     alphaPainter.setBrush(Qt::NoBrush);
 342     alphaPainter.setPen(QColor(32, 32, 32));
 343     alphaPainter.drawRect(0, 0, width, height);
 344     alphaPainter.setPen(QColor(64, 64, 64));
 345     alphaPainter.drawRect(1, 1, width - 2, height - 2);
 346
 347     icon.setAlphaChannel(alphaChannel);
 348     return true;
 349 }
 350
 351 void IconManager::limitToSize(QPixmap& icon, const QSize& maxSize)
 352 {
 353     if ((icon.width() > maxSize.width()) || (icon.height() > maxSize.height())) {
 354         icon = icon.scaled(maxSize, Qt::KeepAspectRatio, Qt::SmoothTransformation);
 355     }
 356 }
 357
 358 void IconManager::killJobs()
 359 {
 360     foreach (KJob* job, m_previewJobs) {
 361         Q_ASSERT(job != 0);
 362         job->kill();
 363     }
 364     m_previewJobs.clear();
 365 }
 366
 367 #include "iconmanager.moc"