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 
00031 class EditInterface
00032 {
00033   friend class PrivateEditInterface;
00034 
00035   public:
00036     EditInterface();
00037     virtual ~EditInterface();
00038 
00039     uint editInterfaceNumber () const;
00040 
00041   protected:  
00042     void setEditInterfaceDCOPSuffix (const QCString &suffix);  
00043     
00044   public:
00051     virtual QString text () const = 0;
00052 
00056     virtual QString text ( uint startLine, uint startCol, uint endLine, uint endCol ) const = 0;
00057 
00061     virtual QString textLine ( uint line ) const = 0;
00062 
00066     virtual uint numLines () const = 0;
00067 
00071     virtual uint length () const = 0;
00072 
00076     virtual int lineLength ( uint line ) const = 0;
00077 
00082     virtual bool setText ( const QString &text ) = 0;
00083 
00088     virtual bool clear () = 0;
00089 
00095     virtual bool insertText ( uint line, uint col, const QString &text ) = 0;
00096 
00101     virtual bool removeText ( uint startLine, uint startCol, uint endLine, uint endCol ) = 0;
00102 
00107     virtual bool insertLine ( uint line, const QString &text ) = 0;
00108 
00112     virtual bool removeLine ( uint line ) = 0;
00113 
00117   public:
00118     virtual void textChanged () = 0;
00119 
00120     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.
00121 
00125   private:
00126     class PrivateEditInterface *d;
00127     static uint globalEditInterfaceNumber;
00128     uint myEditInterfaceNumber;
00129 };
00130 
00131 EditInterface *editInterface (class Document *doc);
00132 
00133 }
00134 
00135 #endif
KDE Logo
This file is part of the documentation for interfaces Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Jul 22 10:17:54 2005 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003