src/views/dolphinitemlistcontainer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   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 DOLPHINITEMLISTCONTAINER_H
  21 #define DOLPHINITEMLISTCONTAINER_H
  22
  23 #include <kitemviews/kfileitemlistview.h>
  24 #include <kitemviews/kitemlistcontainer.h>
  25
  26 #include <libdolphin_export.h>
  27
  28 class KDirLister;
  29 class KFileItemListView;
  30
  31 /**
  32  * @brief Extends KItemListContainer by Dolphin specific properties.
  33  *
  34  * The view and model for KFileItems are created automatically when
  35  * instantating KItemListContainer.
  36  *
  37  * The Dolphin settings of the icons-, compact- and details-view are
  38  * converted internally to properties that can be used to configure e.g.
  39  * the item-size and visible roles of the KItemListView.
  40  */
  41 class LIBDOLPHINPRIVATE_EXPORT DolphinItemListContainer : public KItemListContainer
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     DolphinItemListContainer(KDirLister* dirLister,
  47                              QWidget* parent = 0);
  48
  49     virtual ~DolphinItemListContainer();
  50
  51     void setPreviewsShown(bool show);
  52     bool previewsShown() const;
  53
  54     /**
  55      * Sets the visible roles to \p roles. The integer-value defines
  56      * the order of the visible role: Smaller values are ordered first.
  57      */
  58     void setVisibleRoles(const QHash<QByteArray, int>& roles);
  59     QHash<QByteArray, int> visibleRoles() const;
  60
  61     void setZoomLevel(int level);
  62     int zoomLevel() const;
  63
  64     void setItemLayout(KFileItemListView::Layout layout);
  65     KFileItemListView::Layout itemLayout() const;
  66
  67     void beginTransaction();
  68     void endTransaction();
  69
  70 private:
  71     void updateGridSize();
  72
  73 private:
  74     int m_zoomLevel;
  75     KFileItemListView* m_fileItemListView;
  76 };
  77
  78 #endif