1 /* This file is part of the KDE project
2  * Copyright (C) 2008 Thorsten Zachmann <zachmann@kde.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef KOFINDSTRATEGYBASE_H
21 #define KOFINDSTRATEGYBASE_H
22 
23 class KFindDialog;
24 class QTextCursor;
25 class FindDirection;
26 
27 /**
28  * Abstract base class for the different strategies
29  * find and replace in KoFind.
30  */
31 class KoFindStrategyBase
32 {
33 public:
KoFindStrategyBase()34     KoFindStrategyBase() {}
~KoFindStrategyBase()35     virtual ~KoFindStrategyBase() {}
36 
37     /**
38      * Get the find dialog
39      */
40     virtual KFindDialog * dialog() const = 0;
41 
42     /**
43      * Reset internal status
44      *
45      * E.g. set number of matches found to 0
46      */
47     virtual void reset() = 0;
48 
49     /**
50      * Displays the final dialog
51      */
52     virtual void displayFinalDialog() = 0;
53 
54     /**
55      * This get called when a match was found
56      *
57      * @param cursor The cursor
58      * @param findDirection The find direction helper that can be used for highlighting
59      */
60     virtual bool foundMatch(QTextCursor & cursor, FindDirection * findDirection) = 0;
61 };
62 
63 #endif /* KOFINDSTRATEGYBASE_H */
64