tests/auto/xmlpatternsview/view/TreeSortFilter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the test suite of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef PatternistSDK_TreeSortFilter_H
  43 #define PatternistSDK_TreeSortFilter_H
  44
  45 #include <QSortFilterProxyModel>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 namespace QPatternistSDK
  52 {
  53     /**
  54      * @short A sort & filter model for hierarchical item models.
  55      *
  56      * Features:
  57      * - When sorting, numbers are treated as a whole instead of on a
  58      *   character-per-character basis. For example, @c myFile-10 is sorted after @c myFile-9.
  59      * - When filtering, it behaves as usually is expected when the item model is hierarchical. That is,
  60      *   an item is shown if it matches or any of its children matches.
  61      *
  62      * @image html TreeSortFilter.png "TreeSortFilter in action on a QTreeView."
  63      *
  64      * @ingroup PatternistSDK
  65      * @author Frans Englich <frans.englich@nokia.com>
  66      */
  67     class TreeSortFilter : public QSortFilterProxyModel
  68     {
  69     public:
  70         /**
  71          * Creates a TreeSortFilter.
  72          *
  73          * @param parent the parent. Must not be @c null.
  74          */
  75         TreeSortFilter(QObject *parent);
  76
  77     protected:
  78         /**
  79          * Compares @p left and @p right. They are treated as QStrings.
  80          */
  81         virtual bool lessThan(const QModelIndex &left, const QModelIndex &right) const;
  82
  83         /**
  84          * Overridden to implement filtering.
  85          */
  86         virtual bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
  87
  88     private:
  89         inline bool numericLessThan(const QString &l, const QString &r) const;
  90     };
  91 }
  92
  93 QT_END_NAMESPACE
  94
  95 QT_END_HEADER
  96
  97 #endif
  98 // vim: et:ts=4:sw=4:sts=4