interfaces

highlightinginterface.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., 51 Franklin Street, Fifth Floor,
00017    Boston, MA 02110-1301, USA.
00018 */
00019 
00020 #ifndef __ktexteditor_highlightinginterface_h__
00021 #define __ktexteditor_highlightinginterface_h__
00022 
00023 #include <kdelibs_export.h>
00024 
00025 class QString;
00026 class QCString;
00027 
00028 namespace KTextEditor
00029 {
00030 
00034 class KTEXTEDITOR_EXPORT HighlightingInterface
00035 {
00036   friend class PrivateHighlightingInterface;
00037 
00038   public:
00039     HighlightingInterface ();
00040     virtual ~HighlightingInterface ();
00041 
00042     unsigned int highlightingInterfaceNumber () const;
00043     
00044   protected:  
00045     void setHighlightingInterfaceDCOPSuffix (const QCString &suffix);  
00046 
00047   //
00048     // slots !!!
00049     //
00050   public:
00054     virtual unsigned int hlMode () = 0;
00055 
00059     virtual bool setHlMode (unsigned int mode) = 0;
00060   
00064   virtual unsigned int hlModeCount () = 0;
00065     
00069     virtual QString hlModeName (unsigned int mode) = 0;
00070     
00074   virtual QString hlModeSectionName (unsigned int mode) = 0;
00075 
00076     //
00077     // signals !!!
00078     //
00079     public:
00080       virtual void hlChanged () = 0;
00081 
00082   private:
00083     class PrivateHighlightingInterface *d;
00084     static unsigned int globalHighlightingInterfaceNumber;
00085     unsigned int myHighlightingInterfaceNumber;
00086 };
00087 
00088 KTEXTEDITOR_EXPORT HighlightingInterface *highlightingInterface (class Document *doc);
00089 
00090 }
00091 
00092 #endif
interfaces

highlightinginterface.h

interfaces

API Reference
