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
|
/*
SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef _OKULAR_GUIINTERFACE_H_
#define _OKULAR_GUIINTERFACE_H_
#include "../core/okularcore_export.h"
#include <QObject>
#include <KXMLGUIClient>
namespace Okular
{
/**
* @short Abstract interface for user interface control
*
* This interface defines an way to interact with the Okular user interface,
* e.g. adding actions in the menus.
*
* How to use it in a custom Generator:
* @code
class MyGenerator : public Okular::Generator, public Okular::GuiInterface
{
Q_OBJECT
Q_INTERFACES( Okular::GuiInterface )
...
};
* @endcode
* and - of course - implementing its methods.
*/
class OKULARCORE_EXPORT GuiInterface : protected KXMLGUIClient
{
public:
GuiInterface()
{
}
/**
* Destroys the gui interface.
*/
~GuiInterface() override
{
}
GuiInterface(const GuiInterface &) = delete;
GuiInterface &operator=(const GuiInterface &) = delete;
/**
* This method requests the XML GUI Client provided by the interface.
*/
KXMLGUIClient *guiClient()
{
return this;
}
};
}
Q_DECLARE_INTERFACE(Okular::GuiInterface, "org.kde.okular.GuiInterface/0.1")
#endif
|
