Differential D17971 Diff 50912 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 QTextDocument;
31
32		class KActionCollection;
33		class KateExternalToolsPlugin;
34		class KateExternalTool;
35
36		namespace Ui { class ToolView; }
37
38		enum class ToolViewFocus {
39		OutputTab = 0,
40		StatusTab
41		};
42
43		/**
44		* Menu action that displays all KateExternalTool in a submenu.
45		* Enables/disables the tool actions whenever the view changes, depending on the mimetype.
46		*/
47		class KateExternalToolsMenuAction : public KActionMenu
48		{
49		Q_OBJECT
50		public:
51		KateExternalToolsMenuAction(const QString& text, KActionCollection* collection, KateExternalToolsPlugin* plugin,
52		class KTextEditor::MainWindow* mw = nullptr);
53		virtual ~KateExternalToolsMenuAction();
54
55		/**
56		* This will load all the configured services.
57		*/
58		void reload();
59
60		KActionCollection* actionCollection() const { return m_actionCollection; }
61
62		private Q_SLOTS:
63		/**
64		* Called whenever the current view changed.
65		* Required to enable/disable the tools that depend on specific mimetypes.
66		*/
67		void slotViewChanged(KTextEditor::View* view);
68
69		private:
70		KateExternalToolsPlugin* m_plugin;
71		KTextEditor::MainWindow* m_mainwindow; // for the actions to access view/doc managers
72		KActionCollection* m_actionCollection;
73		};
74
75		class KateExternalToolsPluginView : public QObject, public KXMLGUIClient
76		{
77		Q_OBJECT
78
79		public:
80		/**
81		* Constructor.
82		*/
83		KateExternalToolsPluginView(KTextEditor::MainWindow* mainWindow, KateExternalToolsPlugin* plugin);
84
85		/**
86		* Virtual destructor.
87		*/
88		~KateExternalToolsPluginView();
89
90		/**
91		* Returns the associated mainWindow
92		*/
	loh.tarUnsubmitted Not Done dot, also next comment loh.tar: dot, also next comment
93		KTextEditor::MainWindow* mainWindow() const;
94
95		public Q_SLOTS:
96		/**
97		* Called by the plugin view to reload the menu
98		*/
99		void rebuildMenu();
100
101		/**
102		* Creates the tool view. If already existing, does nothing.
103		*/
104		void createToolView();
105
106		/**
107		* Shows the tool view. The toolview will be created, if not yet existing.
108		*/
109		void showToolView(ToolViewFocus tab);
110
111		/**
112		* Clears the toolview data. If no toolview is around, nothing happens.
113		*/
114		void clearToolView();
115
116		/**
117		* Shows the External Tools toolview and points the error message along with
118		* some more info about the tool.
119		*/
120		void addToolStatus(const QString& message);
121
122		/**
123		* Sets the output data to data;
124		*/
	loh.tarUnsubmitted Not Done ; -> . some cases above toolview -> tool view loh.tar: ; -> . some cases above toolview -> tool view
125		void setOutputData(const QString& data);
126
127		/**
128		* Deletes the tool view, if existing.
129		*/
130		void deleteToolView();
131
132		private:
133		KateExternalToolsPlugin* m_plugin;
134		KTextEditor::MainWindow* m_mainWindow;
135		KateExternalToolsMenuAction* m_externalToolsMenu = nullptr;
136		QWidget* m_toolView = nullptr;
137		Ui::ToolView* m_ui = nullptr;
138		QTextDocument* m_outputDoc = nullptr;
139		QTextDocument* m_statusDoc = nullptr;
140		};
141
142		#endif // KTEXTEDITOR_EXTERNALTOOLS_H
143
144		// kate: space-indent on; indent-width 4; replace-tabs on;