interfaces Library API Documentation

configinterface.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_configinterface_h__
00020 #define __ktexteditor_configinterface_h__
00021 
00022 class QCString;
00023 class KConfig;
00024 
00025 namespace KTextEditor
00026 {
00027 
00028 /*
00029 *  This is an interface for the KTextEditor::Document/Plugin classes !!!
00030 */
00031 class ConfigInterface
00032 {
00033   friend class PrivateConfigInterface;
00034 
00035   public:
00036     ConfigInterface();
00037     virtual ~ConfigInterface();
00038 
00039     unsigned int configInterfaceNumber () const;
00040     
00041   protected:  
00042     void setConfigInterfaceDCOPSuffix (const QCString &suffix); 
00043 
00044   //
00045   // slots !!!
00046   //
00047   public:    
00053     virtual void readConfig () = 0;
00054     virtual void writeConfig () = 0;           
00055                                                                          
00060     virtual void readConfig (KConfig *) = 0;
00061     virtual void writeConfig (KConfig *) = 0;
00062     
00066     virtual void readSessionConfig (KConfig *) = 0;
00067     virtual void writeSessionConfig (KConfig *) = 0;
00068     
00074     virtual void configDialog () = 0;
00075 
00076   private:
00077     class PrivateConfigInterface *d;
00078     static unsigned int globalConfigInterfaceNumber;
00079     unsigned int myConfigInterfaceNumber;
00080 };
00081 
00082 class Plugin;
00083 class Document;
00084 
00085 ConfigInterface *configInterface (Document *doc);
00086 ConfigInterface *configInterface (Plugin *plugin);
00087 
00088 }
00089 
00090 #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