KTextEditor

configinterface.h
1 /* SPDX-License-Identifier: LGPL-2.0-or-later
2 
3  Copyright (C) 2006 Matt Broadstone ([email protected])
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Library General Public
7  License as published by the Free Software Foundation; either
8  version 2 of the License, or (at your option) any later version.
9 
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Library General Public License for more details.
14 
15  You should have received a copy of the GNU Library General Public License
16  along with this library; see the file COPYING.LIB. If not, write to
17  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, USA.
19 */
20 
21 #ifndef KTEXTEDITOR_CONFIGINTERFACE_H
22 #define KTEXTEDITOR_CONFIGINTERFACE_H
23 
24 #include <QStringList>
25 #include <QVariant>
26 #include <ktexteditor_export.h>
27 
28 namespace KTextEditor
29 {
119 class KTEXTEDITOR_EXPORT ConfigInterface
120 {
121 public:
122  ConfigInterface();
123 
127  virtual ~ConfigInterface();
128 
129 public:
133  virtual QStringList configKeys() const = 0;
137  virtual QVariant configValue(const QString &key) = 0;
141  virtual void setConfigValue(const QString &key, const QVariant &value) = 0;
142 
143 private:
144  class ConfigInterfacePrivate *const d = nullptr;
145 };
146 
147 }
148 
149 Q_DECLARE_INTERFACE(KTextEditor::ConfigInterface, "org.kde.KTextEditor.ConfigInterface")
150 
151 #endif
QVariant configValue(const QString &key) override
Get a value for the key.
Config interface extension for the Document and View.
void setConfigValue(const QString &key, const QVariant &value) override
Set a the key&#39;s value to value.
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
QStringList configKeys() const override
Get a list of all available keys.
virtual ~ConfigInterface()
Virtual destructor.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 7 2020 22:55:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.