libs/text/KoFindStrategyBase.h

0001 /* This file is part of the KDE project
0002  * Copyright (C) 2008 Thorsten Zachmann <zachmann@kde.org>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public License
0015  * along with this library; see the file COPYING.LIB.  If not, write to
0016  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018  */
0019
0020 #ifndef KOFINDSTRATEGYBASE_H
0021 #define KOFINDSTRATEGYBASE_H
0022
0023 class KFindDialog;
0024 class QTextCursor;
0025 class FindDirection;
0026
0027 /**
0028  * Abstract base class for the different strategies
0029  * find and replace in KoFind.
0030  */
0031 class KoFindStrategyBase
0032 {
0033 public:
0034     KoFindStrategyBase() {}
0035     virtual ~KoFindStrategyBase() {}
0036
0037     /**
0038      * Get the find dialog
0039      */
0040     virtual KFindDialog * dialog() const = 0;
0041
0042     /**
0043      * Reset internal status
0044      *
0045      * E.g. set number of matches found to 0
0046      */
0047     virtual void reset() = 0;
0048
0049     /**
0050      * Displays the final dialog
0051      */
0052     virtual void displayFinalDialog() = 0;
0053
0054     /**
0055      * This get called when a match was found
0056      *
0057      * @param cursor The cursor
0058      * @param findDirection The find direction helper that can be used for highlighting
0059      */
0060     virtual bool foundMatch(QTextCursor & cursor, FindDirection * findDirection) = 0;
0061 };
0062
0063 #endif /* KOFINDSTRATEGYBASE_H */