interfaces Library API Documentation

cursorinterface.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_cursorinterface_h__
00020 #define __ktexteditor_cursorinterface_h__
00021 
00022 #include <qptrlist.h>
00023 #include <qstring.h>
00024 
00025 namespace KTextEditor
00026 {
00027 
00028 class Cursor
00029 {
00030   public:
00031     virtual void position ( unsigned int *line, unsigned int *col ) const = 0;
00032 
00033     virtual bool setPosition ( unsigned int line, unsigned int col ) = 0;
00034 
00035     virtual bool insertText ( const QString& text ) = 0;
00036 
00037     virtual bool removeText ( unsigned int numberOfCharacters ) = 0;
00038 
00039     virtual QChar currentChar () const = 0;
00040 };
00041 
00042 /*
00043 *  This is an interface for the KTextEditor::Document class !!!
00044 */
00045 class CursorInterface
00046 {
00047   friend class PrivateCursorInterface;
00048 
00049   public:
00050     CursorInterface ();
00051     virtual ~CursorInterface ();
00052 
00053     unsigned int cursorInterfaceNumber () const;
00054     
00055   protected:  
00056     void setCursorInterfaceDCOPSuffix (const QCString &suffix);  
00057 
00058   public:
00062     virtual Cursor *createCursor ( ) = 0;
00063 
00064     /*
00065     * Accessor to the list of views.
00066     */
00067     virtual QPtrList<Cursor> cursors () const = 0;
00068 
00069     private:
00070       class PrivateCursorInterface *d;
00071       static unsigned int globalCursorInterfaceNumber;
00072       unsigned int myCursorInterfaceNumber;
00073 };
00074 
00075 CursorInterface *cursorInterface (class Document *doc);
00076 
00077 }
00078 
00079 #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:49 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001