mirror of
https://bitbucket.org/smil3y/kde-workspace.git
synced 2025-02-23 18:32:50 +00:00
104 lines
4.5 KiB
C++
104 lines
4.5 KiB
C++
/**************************************************************************
|
|
* Copyright (C) 2009 Ben Cooksley <bcooksley@kde.org> *
|
|
* Copyright (C) 2007 Will Stephenson <wstephenson@kde.org> *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License *
|
|
* as published by the Free Software Foundation; either version 2 *
|
|
* of the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program; if not, write to the Free Software *
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
|
|
* 02110-1301, USA. *
|
|
***************************************************************************/
|
|
|
|
#ifndef MENUPROXYMODEL_H
|
|
#define MENUPROXYMODEL_H
|
|
|
|
#include <KCategorizedSortFilterProxyModel>
|
|
#include "systemsettingsview_export.h"
|
|
|
|
/**
|
|
* @brief Provides a filter model for MenuModel
|
|
*
|
|
* Provides a standardised model to be used with views to filter a MenuModel.\n
|
|
* It automatically sorts the items appropriately depending on if it is categorised
|
|
* or not.
|
|
* Call setFilterRegExp(QString) with the desired text to filter to perform searching.
|
|
* Items that do not match the search parameters will be disabled, not hidden.
|
|
*
|
|
* @author Will Stephenson <wstephenson@kde.org>
|
|
* @author Ben Cooksley <bcooksley@kde.org>
|
|
*/
|
|
class SYSTEMSETTINGSVIEW_EXPORT MenuProxyModel : public KCategorizedSortFilterProxyModel
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Constructs a MenuProxyModel with the specified parent.
|
|
*
|
|
* @param parent The QObject to use as a parent.
|
|
*/
|
|
MenuProxyModel( QObject *parent = 0 );
|
|
|
|
/**
|
|
* Please see the Qt QSortFilterProxyModel documentation for further information.\n
|
|
* Provides information on whether or not the QModelIndex specified by left is below right.
|
|
*
|
|
* @param left the QModelIndex that is being used for comparing.
|
|
* @param right the QModelIndex to compare aganist.
|
|
* @returns true if the left is below the right.
|
|
*/
|
|
virtual bool lessThan( const QModelIndex &left, const QModelIndex &right ) const;
|
|
|
|
/**
|
|
* Please see the KDE KCategorizedSortFilterProxyModel documentation for futher information.\n
|
|
* Provides information on whether or not the QModelIndex specified by left is below right.
|
|
*
|
|
* @param left the QModelIndex that is being used for comparing.
|
|
* @param right the QModelIndex to compare aganist.
|
|
* @returns true if the left is below the right.
|
|
*/
|
|
virtual bool subSortLessThan( const QModelIndex &left, const QModelIndex &right ) const;
|
|
|
|
/**
|
|
* Please see the Qt QSortFilterProxyModel documentation for futher information.\n
|
|
* Provides additional filtering of the MenuModel to only show categories which contain modules.
|
|
*
|
|
* @param source_column Please see QSortFilterProxyModel documentation.
|
|
* @param source_parent Please see QSortFilterProxyModel documentation.
|
|
* @returns true if the row should be displayed, false if it should not.
|
|
*/
|
|
virtual bool filterAcceptsRow( int source_column, const QModelIndex &source_parent ) const;
|
|
|
|
/**
|
|
* Please see Qt QAbstractItemModel documentation for more details.\n
|
|
* Provides the status flags for the QModelIndex specified.
|
|
* The item will be selectable and enabled for its status unless invalid or filtered by search terms.
|
|
*
|
|
* @returns The flags for the QModelIndex provided.
|
|
*/
|
|
Qt::ItemFlags flags( const QModelIndex &index ) const;
|
|
|
|
/**
|
|
* Please see Qt QAbstractItemModel documentation for more details.\n
|
|
* Reimplemented for internal reasons.
|
|
*/
|
|
void setFilterRegExp ( const QRegExp & regExp );
|
|
|
|
/**
|
|
* Please see Qt QAbstractItemModel documentation for more details.\n
|
|
* Reimplemented for internal reasons.
|
|
*/
|
|
void setFilterRegExp ( const QString & pattern );
|
|
|
|
};
|
|
|
|
#endif
|