• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • interfaces
  • ktexteditor
sessionconfiginterface.h
Go to the documentation of this file.
1/* This file is part of the KDE libraries
2 Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
3 Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)
4 Copyright (C) 2009 Michel Ludwig (michel.ludwig@kdemail.net)
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
21
22#ifndef KDELIBS_KTEXTEDITOR_SESSIONCONFIGINTERFACE_H
23#define KDELIBS_KTEXTEDITOR_SESSIONCONFIGINTERFACE_H
24
25#include <ktexteditor/ktexteditor_export.h>
26
27class KConfigGroup;
28
29#include <QtCore/QObject>
30
31namespace KTextEditor
32{
33
82class KTEXTEDITOR_EXPORT SessionConfigInterface
83{
84 public:
85 SessionConfigInterface();
86
90 virtual ~SessionConfigInterface();
91
92 //
93 // SLOTS !!!
94 //
95 public:
110 virtual void readSessionConfig (const KConfigGroup& config) = 0;
111
119 virtual void writeSessionConfig (KConfigGroup& config) = 0;
120
121 private:
122 class SessionConfigInterfacePrivate* const d;
123};
124
125
176class KTEXTEDITOR_EXPORT ParameterizedSessionConfigInterface
177{
178 public:
179 ParameterizedSessionConfigInterface();
180
184 virtual ~ParameterizedSessionConfigInterface();
185
186 public:
187
192 enum SessionConfigParameter {
193 SkipNone = 0,
194 SkipUrl = 1 << 0,
195 SkipMode = 1 << 1,
196 SkipHighlighting = 1 << 2,
197 SkipEncoding = 1 << 3,
198 SkipFolding = 1 << 4
199 };
200
217 virtual void readParameterizedSessionConfig (const KConfigGroup& config,
218 unsigned long parameters) = 0;
219
229 virtual void writeParameterizedSessionConfig (KConfigGroup& config,
230 unsigned long parameters) = 0;
231};
232
233
234}
235
236Q_DECLARE_INTERFACE(KTextEditor::SessionConfigInterface, "org.kde.KTextEditor.SessionConfigInterface")
237Q_DECLARE_INTERFACE(KTextEditor::ParameterizedSessionConfigInterface, "org.kde.KTextEditor.ParameterizedSessionConfigInterface")
238
239#endif
240
241// kate: space-indent on; indent-width 2; replace-tabs on;
KConfigGroup
KTextEditor::ParameterizedSessionConfigInterface
Parameterized session config interface extension for the Document.
Definition: sessionconfiginterface.h:177
KTextEditor::ParameterizedSessionConfigInterface::readParameterizedSessionConfig
virtual void readParameterizedSessionConfig(const KConfigGroup &config, unsigned long parameters)=0
Read session settings from the given config excluding the settings specified in parameters.
KTextEditor::ParameterizedSessionConfigInterface::SessionConfigParameter
SessionConfigParameter
Flags for session restore.
Definition: sessionconfiginterface.h:192
KTextEditor::ParameterizedSessionConfigInterface::writeParameterizedSessionConfig
virtual void writeParameterizedSessionConfig(KConfigGroup &config, unsigned long parameters)=0
Write session settings to the config excluding the settings specified in parameters.
KTextEditor::SessionConfigInterface
Session config interface extension for the Document, View and Plugin.
Definition: sessionconfiginterface.h:83
KTextEditor::SessionConfigInterface::readSessionConfig
virtual void readSessionConfig(const KConfigGroup &config)=0
Read session settings from the given config.
KTextEditor::SessionConfigInterface::writeSessionConfig
virtual void writeSessionConfig(KConfigGroup &config)=0
Write session settings to the config.
ktexteditor_export.h
KTextEditor
Namespace for the KDE Text Editor Interfaces.
Definition: annotationinterface.h:31
org
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal