interfaces Library API Documentation

selectioninterface.h

00001 /* This file is part of the KDE project
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 as published by the Free Software Foundation; either
00007    version 2 of the License, or (at your option) any later version.
00008 
00009    This library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Library General Public License for more details.
00013 
00014    You should have received a copy of the GNU Library General Public License
00015    along with this library; see the file COPYING.LIB.  If not, write to
00016    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017    Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __ktexteditor_selectioninterface_h__
00021 #define __ktexteditor_selectioninterface_h__
00022 
00023 #include <qstring.h>
00024 
00025 namespace KTextEditor
00026 {
00027 
00028 /*
00029 *  This is an interface for the KTextEditor::Document class !!!
00030 */
00031 class SelectionInterface
00032 {
00033   friend class PrivateSelectionInterface;
00034 
00035   public:
00036     SelectionInterface();
00037     virtual ~SelectionInterface();
00038         
00039     unsigned int selectionInterfaceNumber () const;
00040     
00041   protected:  
00042     void setSelectionInterfaceDCOPSuffix (const QCString &suffix);  
00043     
00044   /*
00045   *  slots !!!
00046   */
00047   public:
00051     virtual bool setSelection ( unsigned int startLine, unsigned int startCol, unsigned int endLine, unsigned int endCol ) = 0;
00052 
00056     virtual bool clearSelection () = 0;
00057 
00061     virtual bool hasSelection () const = 0;
00062 
00066     virtual QString selection () const = 0;
00067 
00071     virtual bool removeSelectedText () = 0;
00072 
00076     virtual bool selectAll () = 0;
00077 
00078     //
00079     // signals !!!
00080     //
00081     public:
00082       virtual void selectionChanged () = 0;
00083   
00084   private:
00085     class PrivateSelectionInterface *d;
00086     static unsigned int globalSelectionInterfaceNumber;
00087     unsigned int mySelectionInterfaceNumber;
00088 };
00089 
00090 class Document;
00091 class View;
00092 
00093 SelectionInterface *selectionInterface (Document *doc);
00094 SelectionInterface *selectionInterface (View *view);
00095 
00096 }
00097 
00098 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 27 22:16:14 2005 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001