Differential D17971 Diff 50673 addons/externaltools/kateexternaltoolsview.h

Changeset View

Standalone View

addons/externaltools/kateexternaltoolsview.h

This file was added.

1		/* This file is part of the KDE project
2		*
3		* Copyright 2019 Dominik Haumann <dhaumann@kde.org>
4		*
5		* This library is free software; you can redistribute it and/or
6		* modify it under the terms of the GNU Library General Public
7		* License as published by the Free Software Foundation; either
8		* version 2 of the License, or (at your option) any later version.
9		*
10		* This library is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Library General Public License for more details.
14		*
15		* You should have received a copy of the GNU Library General Public License
16		* along with this library; see the file COPYING.LIB. If not, write to
17		* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18		* Boston, MA 02110-1301, USA.
19		*/
20		#ifndef KTEXTEDITOR_EXTERNALTOOLS_H
21		#define KTEXTEDITOR_EXTERNALTOOLS_H
22
23		namespace KTextEditor { class MainWindow; }
24		namespace KTextEditor { class View; }
25
26		#include <KActionMenu>
27		#include <KMacroExpander>
28		#include <KXMLGUIClient>
29
30		class KActionCollection;
31		class KateExternalToolsPlugin;
32		class KateExternalTool;
33
34		/**
35		* The external tools action
36		* This action creates a menu, in which each item will launch a process
37		* with the provided arguments, which may include the following macros:
38		* - %URLS: the URLs of all open documents.
39		* - %URL: The URL of the active document.
40		* - %filedir: The directory of the current document, if that is a local file.
41		* - %selection: The selection of the active document.
42		* - %text: The text of the active document.
43		* - %line: The line number of the cursor in the active view.
44		* - %column: The column of the cursor in the active view.
45		*
46		* Each item has the following properties:
47		* - Name: The friendly text for the menu
48		* - Exec: The command to execute, including arguments.
49		* - TryExec: the name of the executable, if not available, the
50		* item will not be displayed.
51		* - MimeTypes: An optional list of mimetypes. The item will be disabled or
52		* hidden if the current file is not of one of the indicated types.
53		*
54		*/
55		class KateExternalToolsMenuAction : public KActionMenu
56		{
57		Q_OBJECT
58		public:
59		KateExternalToolsMenuAction(const QString& text, KActionCollection* collection, KateExternalToolsPlugin* plugin,
60		class KTextEditor::MainWindow* mw = nullptr);
61		virtual ~KateExternalToolsMenuAction();
62
63		/**
64		* This will load all the configured services.
65		*/
66		void reload();
67
68		KActionCollection* actionCollection() { return m_actionCollection; }
69
70		private Q_SLOTS:
71		void slotViewChanged(KTextEditor::View* view);
72
73		private:
74		KateExternalToolsPlugin* m_plugin;
75		KTextEditor::MainWindow* m_mainwindow; // for the actions to access view/doc managers
76		KActionCollection* m_actionCollection;
77		};
78
79		class KateExternalToolsPluginView : public QObject, public KXMLGUIClient
80		{
81		Q_OBJECT
82
83		public:
84		/**
85		* Constructor.
86		*/
87		KateExternalToolsPluginView(KTextEditor::MainWindow* mainWindow, KateExternalToolsPlugin* plugin);
88
89		/**
90		* Virtual destructor.
91		*/
92		~KateExternalToolsPluginView();
	loh.tarUnsubmitted Not Done dot, also next comment loh.tar: dot, also next comment
93
94		/**
95		* Returns the associated mainWindow
96		*/
97		KTextEditor::MainWindow* mainWindow() const;
98
99		public Q_SLOTS:
100		/**
101		* Called by the plugin view to reload the menu
102		*/
103		void rebuildMenu();
104
105		private:
106		KateExternalToolsPlugin* m_plugin;
107		KTextEditor::MainWindow* m_mainWindow;
108		KateExternalToolsMenuAction* m_externalToolsMenu = nullptr;
109		};
110
111		#endif // KTEXTEDITOR_EXTERNALTOOLS_H
112
113		// kate: space-indent on; indent-width 4; replace-tabs on;
	loh.tarUnsubmitted Not Done ; -> . some cases above toolview -> tool view loh.tar: ; -> . some cases above toolview -> tool view