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
|
/*
SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef _OKULAR_CONFIGINTERFACE_H_
#define _OKULAR_CONFIGINTERFACE_H_
#include "../core/okularcore_export.h"
#include <QObject>
class KConfigDialog;
namespace Okular
{
/**
* @short Abstract interface for configuration control
*
* This interface defines a way to configure the Generator itself.
*
* How to use it in a custom Generator:
* @code
class MyGenerator : public Okular::Generator, public Okular::ConfigInterface
{
Q_OBJECT
Q_INTERFACES( Okular::ConfigInterface )
...
};
* @endcode
* and - of course - implementing its methods.
*/
class OKULARCORE_EXPORT ConfigInterface
{
public:
ConfigInterface()
{
}
/**
* Destroys the config interface.
*/
virtual ~ConfigInterface()
{
}
ConfigInterface(const ConfigInterface &) = delete;
ConfigInterface &operator=(const ConfigInterface &) = delete;
/**
* This method is called to tell the generator to re-parse its configuration.
*
* Returns true if something has changed.
*
* @note this method can be called also when the generator is not the
* active generator, or when there was not changed in the config added
* by the generator itself. So the suggestion is to @b check whether
* something changed, and only in that case return @p true
*/
virtual bool reparseConfig() = 0;
/**
* This method allows the generator to add custom configuration pages to the
* config @p dialog of okular.
*/
virtual void addPages(KConfigDialog *dialog) = 0;
};
}
Q_DECLARE_INTERFACE(Okular::ConfigInterface, "org.kde.okular.ConfigInterface/0.1")
#endif
|
