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
|
/*
* This file is part of KDevelop
* Copyright 2012 André Stein <andre.stein@rwth-aachen.de>
* Copyright 2014 Kevin Funk <kfunk@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_PLUGIN_SWITCHTOBUDDYPLUGIN_H
#define KDEVPLATFORM_PLUGIN_SWITCHTOBUDDYPLUGIN_H
#include <interfaces/iplugin.h>
#include <QVariantList>
/**
* @short Implements a context menu extension in an editor context which provides
* an action that allows switching to associated buddy documents.
*
* Using the @c IBuddyDocumentFinder interface, the current document's
* language plugin provides potential buddy candidates. Depending on their
* existence on the file system the @c SwitchToBuddyPlugin
* enables a 'Switch To XXX' action which opens that buddy document
* using the @c IDocumentController.
*
* If a language plugin either doesn't provide the @c IBuddyDocumentFinder
* interface or no buddy exists on the file system, no context menu
* extension is performed.
*
* @see IBuddyDocumentFinder
* @see IDocumentController
*/
class SwitchToBuddyPlugin : public KDevelop::IPlugin
{
Q_OBJECT
public:
explicit SwitchToBuddyPlugin( QObject *parent, const QVariantList & = QVariantList());
~SwitchToBuddyPlugin() override;
KDevelop::ContextMenuExtension contextMenuExtension(KDevelop::Context* context, QWidget* parent) override;
void createActionsForMainWindow(Sublime::MainWindow* window, QString& xmlFile, KActionCollection& actions) override;
private Q_SLOTS:
/**
* Context menu slot which switches to the QUrl provided
* in the data part of the sending QAction.
*/
void switchToBuddy(const QString& url);
/**
* Switch between header and source files
*/
void switchHeaderSource();
/**
* @brief Switch between definitions and declarations
*
* E.g. if the cursor in the currently active view points to an implementation file
* this shortcut will open the header document (or any buddy file).
*
* Furthermore, if the cursor points to a definition, and the buddy document contains its declaration,
* the cursor will be also set to the declaration's position when the buddy document is opened
*/
void switchDefinitionDeclaration();
};
#endif // KDEVPLATFORM_PLUGIN_SWITCHTOBUDDYPLUGIN_H
|
