summaryrefslogtreecommitdiffstats
path: root/kate/interfaces/pluginconfiginterface.h
blob: f626b1cdebdaaf55357c16071f1de5d042986589 (plain)
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
/* This file is part of the KDE project
   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 __kate_pluginconfiginterface_h__
#define __kate_pluginconfiginterface_h__

#include <kdemacros.h>

namespace Kate
{

/*
*  This is an interface for the KTextEditor::Document/Plugin/ViewPlugin classes !!!
*/
class KDE_EXPORT PluginConfigInterface
{
  friend class PrivatePluginConfigInterface;

  public:
    PluginConfigInterface();
    virtual ~PluginConfigInterface();

    unsigned int pluginConfigInterfaceNumber () const;

  //
  // 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
    */
    virtual void readConfig () = 0;
    virtual void writeConfig () = 0;           
                                                                             
  private:
    class PrivatePluginConfigInterface *d;
    static unsigned int globalPluginConfigInterfaceNumber;
    unsigned int myPluginConfigInterfaceNumber;
};

class Plugin;
KDE_EXPORT PluginConfigInterface *pluginConfigInterface (Plugin *plugin);

}

#endif