src/plugins/help/helpindexfilter.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef HELPINDEXFILTER_H
  34 #define HELPINDEXFILTER_H
  35
  36 #include <locator/ilocatorfilter.h>
  37
  38 #include <QtGui/QIcon>
  39
  40 namespace Help {
  41 namespace Internal {
  42
  43 class HelpIndexFilter : public Locator::ILocatorFilter
  44 {
  45     Q_OBJECT
  46
  47 public:
  48     HelpIndexFilter();
  49     ~HelpIndexFilter();
  50
  51     // ILocatorFilter
  52     QString displayName() const;
  53     QString id() const;
  54     Priority priority() const;
  55     QList<Locator::FilterEntry> matchesFor(QFutureInterface<Locator::FilterEntry> &future, const QString &entry);
  56     void accept(Locator::FilterEntry selection) const;
  57     void refresh(QFutureInterface<void> &future);
  58
  59 signals:
  60     void linkActivated(const QUrl &link) const;
  61
  62 private:
  63     QIcon m_icon;
  64 };
  65
  66 } // namespace Internal
  67 } // namespace Help
  68
  69 #endif // HELPINDEXFILTER_H