src/iconmanager.h

   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 #ifndef ICONMANAGER_H
  21 #define ICONMANAGER_H
  22
  23 #include <kfileitem.h>
  24 #include <kurl.h>
  25
  26 #include <QList>
  27 #include <QObject>
  28 #include <QPixmap>
  29
  30 class DolphinModel;
  31 class DolphinSortFilterProxyModel;
  32 class KJob;
  33 class QAbstractItemView;
  34
  35 /**
  36  * @brief Manages the icon state of a directory model.
  37  *
  38  * Per default a preview is generated for each item.
  39  * Additionally the clipboard is checked for cut items.
  40  * The icon state for cut items gets dimmed automatically.
  41  */
  42 class IconManager : public QObject
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     IconManager(QAbstractItemView* parent, DolphinSortFilterProxyModel* model);
  48     virtual ~IconManager();
  49     void setShowPreview(bool show);
  50     bool showPreview() const;
  51
  52 private slots:
  53     /**
  54      * Updates the icons of for each item in \a items by making hidden
  55      * items semitransparent and generating previews. The current preview
  56      * settings (maximum size, 'Show Preview' menu) are respected.
  57      */
  58     void updateIcons(const KFileItemList& items);
  59
  60     /**
  61      * Replaces the icon of the item \a item by the preview pixmap
  62      * \a pixmap.
  63      */
  64     void replaceIcon(const KFileItem& item, const QPixmap& pixmap);
  65
  66     /**
  67      * Is invoked when the preview job has been finished and
  68      * set m_previewJob to 0.
  69      */
  70     void slotPreviewJobFinished(KJob* job);
  71
  72     /** Synchronizes the item icon with the clipboard of cut items. */
  73     void updateCutItems();
  74
  75 private:
  76     /**
  77      * Returns true, if the item \a item has been cut into
  78      * the clipboard.
  79      */
  80     bool isCutItem(const KFileItem& item) const;
  81
  82     /** Applies an item effect to all cut items. */
  83     void applyCutItemEffect();
  84
  85     /** Applies an item effect to the hidden item \a hiddenItem. */
  86     void applyHiddenItemEffect(const KFileItem& hiddenItem);
  87
  88     /**
  89      * Applies a frame around the icon. False is returned if
  90      * no frame has been added because the icon is too small.
  91      */
  92     bool applyImageFrame(QPixmap& icon);
  93
  94     /**
  95      * Resizes the icon to \a maxSize if the icon size does not
  96      * fit into the maximum size. The aspect ratio of the icon
  97      * is kept.
  98      */
  99     void limitToSize(QPixmap& icon, const QSize& maxSize);
 100
 101 private:
 102     /**
 103      * Remembers the original pixmap for an item before
 104      * the cut effect is applied.
 105      */
 106     struct CutItem
 107     {
 108         KUrl url;
 109         QPixmap pixmap;
 110     };
 111
 112     bool m_showPreview;
 113
 114     QAbstractItemView* m_view;
 115     QList<KJob*> m_previewJobs;
 116     DolphinModel* m_dolphinModel;
 117     DolphinSortFilterProxyModel* m_proxyModel;
 118
 119     QList<CutItem> m_cutItemsCache;
 120 };
 121
 122 inline bool IconManager::showPreview() const
 123 {
 124     return m_showPreview;
 125 }
 126
 127 #endif