src/shared/help/indexwindow.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 (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef INDEXWINDOW_H
  35 #define INDEXWINDOW_H
  36
  37 #include <QtCore/QUrl>
  38 #include <QtGui/QWidget>
  39 #include <QtGui/QLineEdit>
  40
  41 QT_BEGIN_NAMESPACE
  42
  43 class QHelpIndexWidget;
  44 class QModelIndex;
  45
  46 QT_END_NAMESPACE
  47
  48 class IndexWindow : public QWidget
  49 {
  50     Q_OBJECT
  51
  52 public:
  53     IndexWindow();
  54     ~IndexWindow();
  55
  56     void setSearchLineEditText(const QString &text);
  57     QString searchLineEditText() const
  58     {
  59         return m_searchLineEdit->text();
  60     }
  61
  62 signals:
  63     void linkActivated(const QUrl &link);
  64     void linksActivated(const QMap<QString, QUrl> &links,
  65         const QString &keyword);
  66
  67 private slots:
  68     void filterIndices(const QString &filter);
  69     void enableSearchLineEdit();
  70     void disableSearchLineEdit();
  71
  72 private:
  73     bool eventFilter(QObject *obj, QEvent *e);
  74     void open(QHelpIndexWidget* indexWidget, const QModelIndex &index);
  75
  76     QLineEdit *m_searchLineEdit;
  77     QHelpIndexWidget *m_indexWidget;
  78 };
  79
  80 #endif // INDEXWINDOW_H