interfaces Library API Documentation

blockselectioninterface.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_blockselectioninterface_h__
00020 #define __ktexteditor_blockselectioninterface_h__
00021 
00022 class QCString;
00023 
00024 namespace KTextEditor
00025 {
00026 
00027 /*
00028 *  This is an interface for the KTextEditor::Document class !!!
00029 */
00030 class BlockSelectionInterface
00031 {
00032   friend class PrivateBlockSelectionInterface;
00033 
00034   public:
00035     BlockSelectionInterface ();
00036     virtual ~BlockSelectionInterface ();
00037 
00038     unsigned int blockSelectionInterfaceNumber () const;
00039     
00040   protected:  
00041     void setBlockSelectionInterfaceDCOPSuffix (const QCString &suffix);  
00042 
00043   /*
00044   *  slots !!!
00045   */
00046   public:
00055     virtual bool blockSelectionMode () = 0;
00056 
00060     virtual bool setBlockSelectionMode (bool on) = 0;
00061 
00065     virtual bool toggleBlockSelectionMode () = 0;
00066 
00067     private:
00068       class PrivateBlockSelectionInterface *d;
00069       static unsigned int globalBlockSelectionInterfaceNumber;
00070       unsigned int myBlockSelectionInterfaceNumber;
00071 };
00072 
00073 BlockSelectionInterface *blockSelectionInterface (class Document *doc);
00074 
00075 }
00076 
00077 #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