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 #include <kdelibs_export.h> 00026 00027 namespace KTextEditor 00028 { 00029 00033 class KTEXTEDITOR_EXPORT Cursor 00034 { 00035 public: 00036 virtual void position ( unsigned int *line, unsigned int *col ) const = 0; 00037 00038 virtual bool setPosition ( unsigned int line, unsigned int col ) = 0; 00039 00040 virtual bool insertText ( const QString& text ) = 0; 00041 00042 virtual bool removeText ( unsigned int numberOfCharacters ) = 0; 00043 00044 virtual QChar currentChar () const = 0; 00045 }; 00046 00050 class KTEXTEDITOR_EXPORT CursorInterface 00051 { 00052 friend class PrivateCursorInterface; 00053 00054 public: 00055 CursorInterface (); 00056 virtual ~CursorInterface (); 00057 00058 unsigned int cursorInterfaceNumber () const; 00059 00060 protected: 00061 void setCursorInterfaceDCOPSuffix (const QCString &suffix); 00062 00063 public: 00067 virtual Cursor *createCursor ( ) = 0; 00068 00069 /* 00070 * Accessor to the list of cursors. 00071 */ 00072 virtual QPtrList<Cursor> cursors () const = 0; 00073 00074 private: 00075 class PrivateCursorInterface *d; 00076 static unsigned int globalCursorInterfaceNumber; 00077 unsigned int myCursorInterfaceNumber; 00078 }; 00079 00080 KTEXTEDITOR_EXPORT CursorInterface *cursorInterface (class Document *doc); 00081 00082 } 00083 00084 #endif
KDE Logo
This file is part of the documentation for interfaces Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 14 00:43:59 2005 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003