interfaces Library API Documentation

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., 59 Temple Place - Suite 330,
00017    Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __ktexteditor_searchinterface_h__
00021 #define __ktexteditor_searchinterface_h__
00022 
00023 class QRegExp;
00024 class QString;
00025 class QCString;
00026 
00027 namespace KTextEditor
00028 {
00029 
00030 /*
00031 *  This is an interface for the KTextEditor::Document class !!!
00032 */
00033 class SearchInterface
00034 {
00035   friend class PrivateSearchInterface;
00036 
00037   public:
00038     SearchInterface();
00039     virtual ~SearchInterface();
00040 
00041     unsigned int searchInterfaceNumber () const;
00042 
00043   protected:  
00044     void setSearchInterfaceDCOPSuffix (const QCString &suffix);  
00045     
00046   //
00047   // slots !!!
00048   //
00049   public:
00050     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;
00051     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;
00052 
00053   private:
00054     class PrivateSearchInterface *d;
00055     static unsigned int globalSearchInterfaceNumber;
00056     unsigned int mySearchInterfaceNumber;
00057 };
00058 
00059 SearchInterface *searchInterface (class Document *doc);
00060 
00061 }
00062 
00063 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:30:50 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001