src/plugins/find/ifindfilter.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 IFINDFILTER_H
  35 #define IFINDFILTER_H
  36
  37 #include "find_global.h"
  38 #include "textfindconstants.h"
  39
  40 #include <QtGui/QTextDocument>
  41 #include <QtGui/QKeySequence>
  42
  43 QT_BEGIN_NAMESPACE
  44 class QWidget;
  45 class QSettings;
  46 QT_END_NAMESPACE
  47
  48 namespace Find {
  49
  50 class FIND_EXPORT IFindFilter : public QObject
  51 {
  52     Q_OBJECT
  53 public:
  54
  55     virtual ~IFindFilter() {}
  56
  57     virtual QString id() const = 0;
  58     virtual QString displayName() const = 0;
  59     ///
  60     virtual bool isEnabled() const = 0;
  61     virtual bool canCancel() const = 0;
  62     virtual void cancel() = 0;
  63     virtual QKeySequence defaultShortcut() const { return QKeySequence(); }
  64     virtual bool isReplaceSupported() const { return false; }
  65     virtual FindFlags supportedFindFlags() const;
  66
  67     virtual void findAll(const QString &txt, Find::FindFlags findFlags) = 0;
  68     virtual void replaceAll(const QString &txt, Find::FindFlags findFlags)
  69     { Q_UNUSED(txt) Q_UNUSED(findFlags) }
  70
  71     virtual QWidget *createConfigWidget() { return 0; }
  72     virtual void writeSettings(QSettings *settings) { Q_UNUSED(settings) }
  73     virtual void readSettings(QSettings *settings) { Q_UNUSED(settings) }
  74
  75 signals:
  76     void changed();
  77 };
  78
  79 } // namespace Find
  80
  81 #endif // IFINDFILTER_H