searchinterface.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 2001 Christoph Cullmann (cullmann@kde.org)
00003 
00004    This library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Library General Public
00006    License as published by the Free Software Foundation; either
00007    version 2 of the License, or (at your option) any later version.
00008 
00009    This library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Library General Public License for more details.
00013 
00014    You should have received a copy of the GNU Library General Public License
00015    along with this library; see the file COPYING.LIB.  If not, write to
00016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00017    Boston, MA 02110-1301, USA.
00018 */
00019 
00020 #ifndef __ktexteditor_searchinterface_h__
00021 #define __ktexteditor_searchinterface_h__
00022 
00023 #include <kdelibs_export.h>
00024 
00025 class QRegExp;
00026 class QString;
00027 class QCString;
00028 
00029 namespace KTextEditor
00030 {
00031 
00035 class KTEXTEDITOR_EXPORT SearchInterface
00036 {
00037   friend class PrivateSearchInterface;
00038 
00039   public:
00040     SearchInterface();
00041     virtual ~SearchInterface();
00042 
00043     unsigned int searchInterfaceNumber () const;
00044 
00045   protected:  
00046     void setSearchInterfaceDCOPSuffix (const QCString &suffix);  
00047     
00048   //
00049   // slots !!!
00050   //
00051   public:
00052     virtual bool searchText (unsigned int startLine, unsigned int startCol, const QString &text, unsigned int *foundAtLine, unsigned int *foundAtCol, unsigned int *matchLen, bool casesensitive = true, bool backwards = false) = 0;
00053     virtual bool searchText (unsigned int startLine, unsigned int startCol, const QRegExp &regexp, unsigned int *foundAtLine, unsigned int *foundAtCol, unsigned int *matchLen, bool backwards = false) = 0;
00054 
00055   private:
00056     class PrivateSearchInterface *d;
00057     static unsigned int globalSearchInterfaceNumber;
00058     unsigned int mySearchInterfaceNumber;
00059 };
00060 
00061 KTEXTEDITOR_EXPORT SearchInterface *searchInterface (class Document *doc);
00062 
00063 }
00064 
00065 #endif
KDE Home | KDE Accessibility Home | Description of Access Keys