editinterface.h

/* This file is part of the KDE libraries
   Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef __tdetexteditor_editinterface_h__
#define __tdetexteditor_editinterface_h__
 
#include <tqstring.h>
 
#include <tdelibs_export.h>
 
namespace KTextEditor
{
 
class KTEXTEDITOR_EXPORT EditInterface
{
  friend class PrivateEditInterface;
 
  public:
    EditInterface();
    virtual ~EditInterface();
 
    uint editInterfaceNumber () const;
 
  protected:  
    void setEditInterfaceDCOPSuffix (const TQCString &suffix);  
    
  public:
    virtual TQString text () const = 0;
 
    virtual TQString text ( uint startLine, uint startCol, uint endLine, uint endCol ) const = 0;
 
    virtual TQString textLine ( uint line ) const = 0;
 
    virtual uint numLines () const = 0;
 
    virtual uint length () const = 0;
 
    virtual int lineLength ( uint line ) const = 0;
 
    virtual bool setText ( const TQString &text ) = 0;
 
    virtual bool clear () = 0;
 
    virtual bool insertText ( uint line, uint col, const TQString &text ) = 0;
 
    virtual bool removeText ( uint startLine, uint startCol, uint endLine, uint endCol ) = 0;
 
    virtual bool insertLine ( uint line, const TQString &text ) = 0;
 
    virtual bool removeLine ( uint line ) = 0;
 
  public:
    virtual void textChanged () = 0;
 
    virtual void charactersInteractivelyInserted(int ,int ,const TQString&)=0; //line, col, characters if you don't support this, don't create a signal, just overload it.
 
  private:
    class PrivateEditInterface *d;
    static uint globalEditInterfaceNumber;
    uint myEditInterfaceNumber;
};
 
KTEXTEDITOR_EXPORT EditInterface *editInterface (class Document *doc);
 
}
 
#endif