Differential D17971 Diff 53482 addons/externaltools/kateexternaltoolsconfigwidget.h

Changeset View

Standalone View

addons/externaltools/kateexternaltoolsconfigwidget.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_CONFIGWIDGET_H
21		#define KTEXTEDITOR_EXTERNALTOOLS_CONFIGWIDGET_H
22
23		#include "ui_configwidget.h"
24		#include "ui_tooldialog.h"
25
26		#include <KTextEditor/Application>
27		#include <KTextEditor/ConfigPage>
28		#include <KTextEditor/MainWindow>
29		#include <KTextEditor/Plugin>
30
31		#include <QDialog>
32		#include <QStandardItemModel>
33		#include <QPixmap>
34
35		class KConfig;
36		class KateExternalToolsPlugin;
37		class KateExternalTool;
38
39		/**
40		* The config widget.
41		* The config widget allows the user to view a list of services of the type
42		* "Kate/ExternalTool" and add, remove or edit them.
	loh.tarUnsubmitted Not Done rm The config widget, starting with Allows loh.tar: rm The config widget, starting with Allows
43		*/
	loh.tarUnsubmitted Not Done and to loh.tar: and to
44		class KateExternalToolsConfigWidget : public KTextEditor::ConfigPage, public Ui::ExternalToolsConfigWidget
45		{
46		Q_OBJECT
47		public:
48		KateExternalToolsConfigWidget(QWidget* parent, KateExternalToolsPlugin* plugin);
49		virtual ~KateExternalToolsConfigWidget();
50
51		QString name() const override;
52		QString fullName() const override;
53		QIcon icon() const override;
54
55		public Q_SLOTS:
56		void apply() override;
57		void reset() override;
58		void defaults() override { reset(); }
59
60		private Q_SLOTS:
61		void slotAddCategory();
62		void slotAddTool();
63		void slotEdit();
64		void slotRemove();
65		void slotSelectionChanged();
66
67		/**
68		* Helper to open the ToolDialog.
69		* Returns true, if the user clicked OK.
70		*/
71		bool editTool(KateExternalTool* tool);
72
73		/**
74		* Creates a new category or returns existing one.
75		*/
76		QStandardItem * addCategory(const QString & category);
77
78		/**
79		* Returns the currently active category. The returned pointer is always valid.
80		*/
81		QStandardItem * currentCategory() const;
82
83		/**
84		* Clears the tools model.
85		*/
86		void clearTools();
87
88		private:
89		QPixmap blankIcon();
90
91		private:
92		KConfig* m_config = nullptr;
93		bool m_changed = false;
94		KateExternalToolsPlugin* m_plugin;
95		QStandardItemModel m_toolsModel;
96		QStandardItem * m_noCategory = nullptr;
97		};
98
99		/**
100		* A Dialog to edit a single KateExternalTool object
101		*/
102		class KateExternalToolServiceEditor : public QDialog
103		{
104		Q_OBJECT
105
106		public:
107		explicit KateExternalToolServiceEditor(KateExternalTool* tool = nullptr, QWidget* parent = nullptr);
108
109		private Q_SLOTS:
110		/**
111		* Run when the OK button is clicked, to ensure critical values are provided.
112		*/
113		void slotOKClicked();
114
115		/**
116		* show a mimetype chooser dialog
117		*/
	loh.tarUnsubmitted Not Done S loh.tar: S
118		void showMTDlg();
119
120		public:
121		Ui::ToolDialog* ui;
122
123		private:
124		KateExternalTool* m_tool;
125		};
126
127		/**
128		* Action that is only visible if QLineEdit has focus.
129		*/
130		class ContextAction : public QObject
131		{
132		Q_OBJECT
133
134		public:
135		/**
136		* Constructor that will add @p action to all attached QLineEdits.
137		*/
138		ContextAction(const QIcon & icon, const QString & text, QObject * parent = nullptr);
139
	loh.tarUnsubmitted Not Done Coding style says QIcon &icon, always to the right. You reformat by some clang command? There was a astyle command somewhere offered. There are much more other places affected. loh.tar: Coding style says QIcon &icon, always to the right. You reformat by some clang command? There…
140		/**
141		* Attaches the action provided in the constructor to @p lineEdit
142		* whenever the @p lineEdit has focus.
143		*/
144		void attachTo(QLineEdit * lineEdit);
145
146		Q_SIGNALS:
147		/**
148		* This signal is emitted whenever the action was triggered for
149		* the given @p lineEdit. The @p lineEdit is always a valid pointer.
150		*/
151		void triggered(QLineEdit * lineEdit);
152
153		protected:
154		/**
155		* Reimplemented to show/hide action for the currently focused
156		* line edit.
157		*/
158		bool eventFilter(QObject watched, QEvent event) override;
159
160		private:
161		QLineEdit * m_currentLineEdit = nullptr;
162		QAction * m_action;
163		};
164
165
166		#endif // KTEXTEDITOR_EXTERNALTOOLS_CONFIGWIDGET_H
167
168		// kate: space-indent on; indent-width 4; replace-tabs on;