diff options
Diffstat (limited to 'interfaces/tdetexteditor/sessionconfiginterface.h')
-rw-r--r-- | interfaces/tdetexteditor/sessionconfiginterface.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/interfaces/tdetexteditor/sessionconfiginterface.h b/interfaces/tdetexteditor/sessionconfiginterface.h new file mode 100644 index 000000000..f92502b36 --- /dev/null +++ b/interfaces/tdetexteditor/sessionconfiginterface.h @@ -0,0 +1,71 @@ +/* This file is part of the KDE libraries + Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License version 2 as published by the Free Software Foundation. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef __tdetexteditor_sessionconfiginterface_h__ +#define __tdetexteditor_sessionconfiginterface_h__ + +#include <tdelibs_export.h> + +class TQCString; +class TDEConfig; + +namespace KTextEditor +{ + +/** +* This is an interface to session-specific configuration of the +* Document, Plugin and PluginViewInterface classes. +*/ +class KTEXTEDITOR_EXPORT SessionConfigInterface +{ + friend class PrivateSessionConfigInterface; + + public: + SessionConfigInterface(); + virtual ~SessionConfigInterface(); + + unsigned int configInterfaceNumber () const; + + protected: + void setSessionConfigInterfaceDCOPSuffix (const TQCString &suffix); + + // + // slots !!! + // + public: + /** + * Read/Write session config of only this document/view/plugin + * In case of the document, that means for example it should reload the file, + * restore all marks, ... + */ + virtual void readSessionConfig (TDEConfig *) = 0; + virtual void writeSessionConfig (TDEConfig *) = 0; + + private: + class PrivateSessionConfigInterface *d; + static unsigned int globalSessionConfigInterfaceNumber; + unsigned int mySessionConfigInterfaceNumber; +}; + +KTEXTEDITOR_EXPORT SessionConfigInterface *sessionConfigInterface (class Document *doc); +KTEXTEDITOR_EXPORT SessionConfigInterface *sessionConfigInterface (class View *view); +KTEXTEDITOR_EXPORT SessionConfigInterface *sessionConfigInterface (class Plugin *plugin); + +} + +#endif |