interfaces Library API Documentation

editinterface.h

00001 /* This file is part of the KDE libraries
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 version 2 as published by the Free Software Foundation.
00007 
00008    This library is distributed in the hope that it will be useful,
00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011    Library General Public License for more details.
00012 
00013    You should have received a copy of the GNU Library General Public License
00014    along with this library; see the file COPYING.LIB.  If not, write to
00015    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00016    Boston, MA 02111-1307, USA.
00017 */
00018 
00019 #ifndef __ktexteditor_editinterface_h__
00020 #define __ktexteditor_editinterface_h__
00021 
00022 #include <qstring.h>
00023 
00024 namespace KTextEditor
00025 {
00026 
00030 class EditInterface
00031 {
00032   friend class PrivateEditInterface;
00033 
00034   public:
00035     EditInterface();
00036     virtual ~EditInterface();
00037 
00038     uint editInterfaceNumber () const;
00039 
00040   protected:  
00041     void setEditInterfaceDCOPSuffix (const QCString &suffix);  
00042     
00043   public:
00050     virtual QString text () const = 0;
00051 
00055     virtual QString text ( uint startLine, uint startCol, uint endLine, uint endCol ) const = 0;
00056 
00060     virtual QString textLine ( uint line ) const = 0;
00061 
00065     virtual uint numLines () const = 0;
00066 
00070     virtual uint length () const = 0;
00071 
00075     virtual int lineLength ( uint line ) const = 0;
00076 
00081     virtual bool setText ( const QString &text ) = 0;
00082 
00087     virtual bool clear () = 0;
00088 
00094     virtual bool insertText ( uint line, uint col, const QString &text ) = 0;
00095 
00100     virtual bool removeText ( uint startLine, uint startCol, uint endLine, uint endCol ) = 0;
00101 
00106     virtual bool insertLine ( uint line, const QString &text ) = 0;
00107 
00111     virtual bool removeLine ( uint line ) = 0;
00112 
00116   public:
00117     virtual void textChanged () = 0;
00118 
00119     virtual void charactersInteractivelyInserted(int ,int ,const QString&)=0; //line, col, characters if you don't support this, don't create a signal, just overload it.
00120 
00124   private:
00125     class PrivateEditInterface *d;
00126     static uint globalEditInterfaceNumber;
00127     uint myEditInterfaceNumber;
00128 };
00129 
00130 EditInterface *editInterface (class Document *doc);
00131 
00132 };
00133 
00134 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:22:15 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001