workspace/khotkeys/kcm_hotkeys/hotkeys_proxy_model.h

   1 /*
   2    Copyright (C) 2008 Michael Jansen <kde@michael-jansen.biz>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License as published by the Free Software Foundation; either
   7    version 2 of the License, or (at your option) any later version.
   8
   9    This library 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 GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public License
  15    along with this library; see the file COPYING.LIB.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18 */
  19 #ifndef KHOTKEYSPROXYMODEL_H
  20 #define KHOTKEYSPROXYMODEL_H
  21
  22 #include "libkhotkeysfwd.h"
  23
  24 #include <QtGui/QSortFilterProxyModel>
  25
  26
  27
  28 class KHotkeysProxyModelPrivate;
  29 class KHotkeysModel;
  30
  31
  32 /**
  33  * @author Michael Jansen <kde@michael-jansen.biz>
  34  */
  35 class KHotkeysProxyModel : public QSortFilterProxyModel
  36     {
  37     Q_OBJECT
  38
  39     public:
  40
  41         /**
  42          * Default constructor
  43          */
  44         KHotkeysProxyModel( QObject *parent );
  45
  46         /**
  47          * Destructor
  48          */
  49         virtual ~KHotkeysProxyModel();
  50
  51         /**
  52          * Returns true if the item in column @a column should be included in
  53          * the model.
  54          */
  55         bool filterAcceptsRow( int source_column, const QModelIndex &source_parent ) const;
  56
  57         /**
  58          * Get the KHotKeys::ActionDataBase behind the index.
  59          */
  60         KHotKeys::ActionDataBase *indexToActionDataBase( const QModelIndex &index ) const;
  61
  62         /**
  63          * Get the KHotKeys::ActionDataBase behind the index or 0.
  64          *
  65          * Getting 0 doesn't mean the index is invalid. It means you provided a
  66          * action object.
  67          */
  68         KHotKeys::ActionDataGroup *indexToActionDataGroup( const QModelIndex &index ) const;
  69
  70         /**
  71          * Return the source model. Casted to the correct class.
  72          */
  73         KHotkeysModel *sourceModel() const;
  74
  75   private:
  76
  77         //! Implementation details
  78         KHotkeysProxyModelPrivate *d;
  79 };
  80
  81 #endif /* #ifndef KHOTKEYSPROXYMODEL_HPP */