src/plugins/help/docsettingspage.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 DOCSETTINGSPAGE_H
  34 #define DOCSETTINGSPAGE_H
  35
  36 #include "ui_docsettingspage.h"
  37 #include <coreplugin/dialogs/ioptionspage.h>
  38
  39 namespace Help {
  40 namespace Internal {
  41
  42 class DocSettingsPage : public Core::IOptionsPage
  43 {
  44     Q_OBJECT
  45     typedef QHash<QString, QString> NameSpaceToPathHash;
  46
  47 public:
  48     DocSettingsPage();
  49
  50     QString id() const;
  51     QString displayName() const;
  52     QString category() const;
  53     QString displayCategory() const;
  54     QIcon categoryIcon() const;
  55
  56     QWidget *createPage(QWidget *parent);
  57     void apply();
  58     void finish() {}
  59     virtual bool matches(const QString &s) const;
  60
  61 private slots:
  62     void addDocumentation();
  63     void removeDocumentation();
  64
  65 private:
  66     bool eventFilter(QObject *object, QEvent *event);
  67     void removeDocumentation(const QList<QListWidgetItem*> items);
  68     void addItem(const QString &nameSpace, const QString &fileName);
  69
  70 private:
  71     Ui::DocSettingsPage m_ui;
  72
  73     QString m_searchKeywords;
  74     QString m_recentDialogPath;
  75
  76     NameSpaceToPathHash m_filesToRegister;
  77     NameSpaceToPathHash m_filesToUnregister;
  78 };
  79
  80 } // namespace Help
  81 } // namespace Internal
  82
  83 #endif // DOCSETTINGSPAGE_H