src/plugins/find/findplugin.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 FINDPLUGIN_H
  34 #define FINDPLUGIN_H
  35
  36 #include "find_global.h"
  37 #include "textfindconstants.h"
  38
  39 #include <extensionsystem/iplugin.h>
  40
  41 #include <QtGui/QTextDocument>
  42
  43 QT_BEGIN_NAMESPACE
  44 class QStringListModel;
  45 QT_END_NAMESPACE
  46
  47 namespace Find {
  48 class IFindFilter;
  49 struct FindPluginPrivate;
  50
  51 namespace Internal {
  52 class FindToolBar;
  53 class FindToolWindow;
  54 class CurrentDocumentFind;
  55 } // namespace Internal
  56
  57 class FIND_EXPORT FindPlugin : public ExtensionSystem::IPlugin
  58 {
  59     Q_OBJECT
  60
  61 public:
  62     FindPlugin();
  63     virtual ~FindPlugin();
  64     static FindPlugin *instance();
  65
  66     enum FindDirection {
  67         FindForward,
  68         FindBackward
  69     };
  70
  71     // IPlugin
  72     bool initialize(const QStringList &arguments, QString *error_message);
  73     void extensionsInitialized();
  74     ShutdownFlag aboutToShutdown();
  75
  76     Find::FindFlags findFlags() const;
  77     bool hasFindFlag(Find::FindFlag flag);
  78     void updateFindCompletion(const QString &text);
  79     void updateReplaceCompletion(const QString &text);
  80     QStringListModel *findCompletionModel() const;
  81     QStringListModel *replaceCompletionModel() const;
  82     void setUseFakeVim(bool on);
  83     void openFindToolBar(FindDirection direction);
  84
  85 public slots:
  86     void setCaseSensitive(bool sensitive);
  87     void setWholeWord(bool wholeOnly);
  88     void setBackward(bool backward);
  89     void setRegularExpression(bool regExp);
  90
  91 signals:
  92     void findFlagsChanged();
  93
  94 private slots:
  95     void filterChanged();
  96     void openFindFilter();
  97
  98 private:
  99     void setFindFlag(Find::FindFlag flag, bool enabled);
 100     void updateCompletion(const QString &text, QStringList &completions, QStringListModel *model);
 101     void setupMenu();
 102     void setupFilterMenuItems();
 103     void writeSettings();
 104     void readSettings();
 105
 106     //variables
 107     FindPluginPrivate *d;
 108 };
 109
 110 } // namespace Find
 111
 112 #endif // FINDPLUGIN_H