1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/* This file is part of the KDE libraries
Copyright (C) 2001 Christoph Cullmann <[email protected]>
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 __ktexteditor_configinterface_h__
#define __ktexteditor_configinterface_h__
#include <kdelibs_export.h>
class QCString;
class KConfig;
namespace KTextEditor
{
/**
* This is an interface for accessing the configuration of the
* Document and Plugin classes.
*/
class KTEXTEDITOR_EXPORT ConfigInterface
{
friend class PrivateConfigInterface;
public:
ConfigInterface();
virtual ~ConfigInterface();
unsigned int configInterfaceNumber () const;
protected:
void setConfigInterfaceDCOPSuffix (const QCString &suffix);
//
// slots !!!
//
public:
/**
Read/Write the config to the standard place where this editor
part saves it config, say: read/save default values for that
editor part, which means for all current open documents
*/
virtual void readConfig () = 0;
virtual void writeConfig () = 0;
/**
Read/Write the config of the part to a given kconfig object
to store the settings in a different place than the standard
*/
virtual void readConfig (KConfig *) = 0;
virtual void writeConfig (KConfig *) = 0;
/**
Read/Write session config of only this document/view/plugin
*/
virtual void readSessionConfig (KConfig *) = 0;
virtual void writeSessionConfig (KConfig *) = 0;
/**
Shows a config dialog for the part, changes will be applied
to the part, but not saved anywhere automagically, call
writeConfig to save it
*/
virtual void configDialog () = 0;
private:
class PrivateConfigInterface *d;
static unsigned int globalConfigInterfaceNumber;
unsigned int myConfigInterfaceNumber;
};
class Plugin;
class Document;
KTEXTEDITOR_EXPORT ConfigInterface *configInterface (Document *doc);
KTEXTEDITOR_EXPORT ConfigInterface *configInterface (Plugin *plugin);
}
#endif
|
