src/kitemcategorizer.h

   1 /**
   2   * This file is part of the KDE project
   3   * Copyright (C) 2007 Rafael Fernández López <ereslibre@gmail.com>
   4   *
   5   * This library is free software; you can redistribute it and/or
   6   * modify it under the terms of the GNU Library General Public
   7   * License as published by the Free Software Foundation; either
   8   * version 2 of the License, or (at your option) any later version.
   9   *
  10   * This library is distributed in the hope that it will be useful,
  11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   * Library General Public License for more details.
  14   *
  15   * You should have received a copy of the GNU Library General Public License
  16   * along with this library; see the file COPYING.LIB.  If not, write to
  17   * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18   * Boston, MA 02110-1301, USA.
  19   */
  20
  21 #ifndef KITEMCATEGORIZER_H
  22 #define KITEMCATEGORIZER_H
  23
  24 #include <libdolphin_export.h>
  25
  26 class QString;
  27 class QPainter;
  28 class QModelIndex;
  29 class QStyleOption;
  30
  31 /**
  32   * @short Class for item categorizing on KListView
  33   *
  34   * This class is meant to be used with KListView class. Its purpose is
  35   * to decide to which category belongs a given index with the given role.
  36   * Additionally it will let you to customize the way categories are drawn,
  37   * only in the case that you want to do so
  38   *
  39   * @see KListView
  40   *
  41   * @author Rafael Fernández López <ereslibre@gmail.com>
  42   */
  43 class LIBDOLPHINPRIVATE_EXPORT KItemCategorizer
  44 {
  45 public:
  46     KItemCategorizer();
  47
  48     virtual ~KItemCategorizer();
  49
  50     /**
  51       * This method will return the category where @param index fit on with the
  52       * given @param sortRole role
  53       */
  54     virtual QString categoryForItem(const QModelIndex &index,
  55                                     int sortRole) const = 0;
  56
  57     /**
  58       * This method purpose is to draw a category represented by the given
  59       * @param index with the given @param sortRole sorting role
  60       *
  61       * @note This method will be called one time per category, always with the
  62       *       first element in that category
  63       */
  64     virtual void drawCategory(const QModelIndex &index,
  65                               int sortRole,
  66                               const QStyleOption &option,
  67                               QPainter *painter) const;
  68
  69     virtual int categoryHeight(const QStyleOption &option) const;
  70 };
  71
  72 #endif // KITEMCATEGORIZER_H