Differential D20958 Diff 57905 src/mode/katemodemenulist.h

Changeset View

Standalone View

src/mode/katemodemenulist.h

This file was added.

1		/* This file is part of the KDE libraries and the Kate part.
2		*
3		* Copyright (C) 2019 Nibaldo González S. <nibgonz@gmail.com>
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
21		#ifndef KATEMODEMENULIST_H
22		#define KATEMODEMENULIST_H
23
24		#include <QMenu>
25		#include <QPushButton>
26		#include <QListWidget>
27		#include <QScrollBar>
28		#include <QGridLayout>
29		#include <QString>
30		#include <QLabel>
31		#include <QIcon>
32		#include <QKeyEvent>
33
34		#include <KListWidgetSearchLine>
35
36		#include "katemodemanager.h"
37
38		namespace KTextEditor { class DocumentPrivate; }
39
40		/**
41		* Class of menu to select the
42		* syntax highlighting language (mode menu).
43		* Provides a menu with a scrollable list plus search bar.
44		*
45		* This is an alternative to the classic mode menu of the KateModeMenu class.
46		*
47		* @see KateModeManager, KateFileType, KateModeMenu
48		*/
49		class KateModeMenuList : public QMenu
50		{
51		Q_OBJECT
52
53		public:
54		/**
55		* Alignment with respect to the trigger button.
56		* "Default" is the normal alignment (left alignment in Left-to-right layouts).
57		* "Inverse" uses right alignment in Left-to-right layouts and left
58		* alignment in Right-to-left layouts (used in some languages).
59		* "Left" or "Right" forces the alignment.
60		* @see setButton(), QWidget::layoutDirection(), Qt::LayoutDirection
61		*/
62		enum AlignmentButton {
63		Default,
64		Inverse,
65		Left,
66		Right
67		};
68		/**
69		* Search bar position, above or below the list.
70		*/
71		enum SearchBarPosition {
72		Top,
73		Bottom
74		};
75
76		/**
77		* @param searchBarPos Search bar position, can be top or bottom.
78		* @see SearchBarPosition
79		*/
80		KateModeMenuList(const SearchBarPosition searchBarPos = Bottom) : QMenu()
81		{
82		init(searchBarPos);
83		}
84		KateModeMenuList(const QString &title, const SearchBarPosition searchBarPos = Bottom) : QMenu(title)
85		{
86		init(searchBarPos);
87		}
88		KateModeMenuList(QWidget *parent, const SearchBarPosition searchBarPos = Bottom) : QMenu(parent)
89		{
90		init(searchBarPos);
91		}
92		KateModeMenuList(const QString &title, QWidget *parent, const SearchBarPosition searchBarPos = Bottom) : QMenu(title, parent)
93		{
94		init(searchBarPos);
95		}
96		~KateModeMenuList() { }
97
98		/**
99		* Update the selected item in the list widget, but without changing
100		* the syntax highlighting in the document.
101		* This is useful for updating this menu, when changing the syntax highlighting
102		* from another menu, or from an external one. This doesn't hide or show the menu.
103		* @param nameMode Raw name of the syntax highlight definition. If it's empty,
104		* the "Normal" mode will be used.
105		*/
106		void selectHighlightingFromExternal(const QString &nameMode);
107		/**
108		* Update the selected item in the list widget, but without changing
109		* the syntax highlighting in the document. This doesn't hide or show the menu.
110		* The menu is kept updated according to the active syntax highlighting,
111		* obtained from the KTextEditor::DocumentPrivate class.
112		* @see KTextEditor::DocumentPrivate::fileType()
113		*/
114		void selectHighlightingFromExternal();
115
116		/**
117		* Set the button that shows this menu. It allows to update the label
118		* of the button and define the alignment of the menu with respect to it.
119		* @param button Trigger button.
120		* @param bAutoUpdateTextButton Determines whether the text of the button should be
121		* changed when selecting an item from the menu.
122		* @param position Position of the menu with respect to the trigger button.
123		* See KateModeMenuList::AlignmentButton.
124		*
125		* @see AlignmentButton
126		*/
127		void setButton(QPushButton *button, const bool bAutoUpdateTextButton = false, AlignmentButton position = Inverse);
128
129		/**
130		* Define the size of the list widget, in pixels.
131		*/
132		inline void setSizeList(const int height, const int width = 260)
133		{
134		m_list->setSizeList(height, width);
135		}
136
137		/**
138		* Set document to apply the syntax highlighting.
139		* @see KTextEditor::DocumentPrivate
140		*/
141		void updateMenu(KTextEditor::Document *doc);
142
	dhaumannUnsubmitted Done Can you make this a QListView? I once heard the QListWidget will be deprecated in Qt6, rule of thumb is: always use QView instead of QWidget, since this then will also work in QML. dhaumann: Can you make this a QListView? I once heard the QListWidget will be deprecated in Qt6, rule of…
143		protected:
144
145		/**
146		* Class of List Widget.
147		*/
148		class ModeListWidget : public QListWidget
149		{
150		public:
151		ModeListWidget(KateModeMenuList *menu) : QListWidget(menu)
152		{
153		m_parentMenu = menu;
154		}
155
156		/**
157		* Add item, setting the default properties.
158		*/
159		void addDefaultItem(QListWidgetItem *item);
160
161		/**
162		* Define the size of the widget list.
163		* @p height and @p width are values in pixels.
164		*/
165		void setSizeList(const int height, const int width = 260);
166
167		protected:
168		/**
169		* Override from QListWidget.
170		*/
171		void keyPressEvent(QKeyEvent *event) override;
172
173		private:
174		KateModeMenuList *m_parentMenu = nullptr;
175		};
176
	dhaumannUnsubmitted Done This should use QStandardItem, iiuc. dhaumann: This should use QStandardItem, iiuc.
177
178		/**
179		* Class of an Item of the List Widget.
180		* @see ModeListWidget, KateFileType
181		*/
182		class ModeListWidgetItem : public QListWidgetItem
183		{
184		public:
185		ModeListWidgetItem() : QListWidgetItem() { }
186
187		/**
188		* Associate this item with a KateFileType object.
189		*/
190		inline void setMode(KateFileType *type)
191		{
192		m_type = type;
193		return;
194		}
195		inline const KateFileType* getMode()
196		{
197		return m_type;
198		}
199		inline bool hasMode() const
200		{
201		return m_type;
202		}
203
204		/**
205		* Generate name of the item used for the search.
206		* @param itemName Pointer to the item name, can be an attribute of a KateFileType object.
207		* @return True if a new name is generated for the search.
208		*/
209		bool generateSearchName(const QString *itemName);
210
211		/**
212		* Find matches in the extensions of the item mode, with a @p text.
213		* @param text Text to match, without dots or asterisks. For example, in
214		* a common extension, it corresponds to the text after "*."
215		* @return True if a match is found, false if not.
216		*/
217		bool matchExtension(const QString &text);
218
219		inline const QString* getSearchName()
220		{
221		return m_searchName;
222		}
223
224		private:
225		const KateFileType *m_type = nullptr;
226		const QString *m_searchName = nullptr;
227		};
228
229
230		/**
231		* Class of Search Bar Widget.
232		*/
233		class ModeLineEdit : public KListWidgetSearchLine
234		{
235		public:
236		ModeLineEdit(KateModeMenuList menu, QListWidget listWidget) : KListWidgetSearchLine(menu, listWidget)
237		{
238		m_parentMenu = menu;
239		}
240		~ModeLineEdit() { };
241
242		/**
243		* Override from KListWidgetSearchLine.
244		*/
245		void updateSearch(const QString &s = QString()) override;
246		void clear();
247
248		private:
249		/**
250		* Select result of the items search.
251		* Used only by ModeLineEdit::updateSearch().
252		*/
253		void setSearchResult(const int rowItem, bool &bEmptySection, int &lastSection, int &lastItem);
254
255		KateModeMenuList *m_parentMenu = nullptr;
256
257		bool m_bSearchStateClear = true;
258		bool m_bSearchStateAutoScroll = false;
259		};
260
261
262		/**
263		* Action when displaying the menu.
264		* Override from QWidget.
265		*/
266		void showEvent(QShowEvent *event) override;
267
268		private:
269		void init(const SearchBarPosition searchBarPos);
270
271		/**
272		* Load the syntax highlighting definitions in the widget of list of items.
273		*/
274		void loadHighlightingList();
275
276		/**
277		* Set a custom word wrap on a text line, according to a maximum width (in pixels).
278		* @param text Line of text
279		* @param maxWidth Width of the text container, in pixels.
280		* @param fontMetrics Font metrics. See QWidget::fontMetrics()
281		*/
282		QString setWordWrap(const QString &text, const int maxWidth, const QFontMetrics &fontMetrics) const;
283
284		/**
285		* Update the selected item in the list widget.
286		* This method only changes the selected item, doesn't apply
287		* syntax highlighting in the document, or hides the menu.
288		* @see selectHighlighting(), selectHighlightingFromExternal(), selectHighlightingSetVisibility()
289		*/
290		void updateSelectedItem(ModeListWidgetItem *item);
291
292		/**
293		* Select an item from the list and apply the syntax highlighting in the document.
294		* This is equivalent to KateModeMenuList::selectHighlighting().
295		* @param bHideMenu If the menu should be hidden after applying the highlight.
296		* @see selectHighlighting()
297		*/
298		void selectHighlightingSetVisibility(QListWidgetItem *pItem, const bool bHideMenu);
299
300		/**
301		* Load message when the list is empty in the search.
302		*/
303		inline void loadEmptyMsg();
304
305		QPushButton *m_pushButton = nullptr;
306		AlignmentButton m_position;
307		bool m_bAutoUpdateTextButton;
308
309		QGridLayout *m_layoutList = nullptr;
310		QLabel *m_emptyListMsg = nullptr;
311
312		ModeLineEdit *m_searchBar = nullptr;
313		ModeListWidget *m_list = nullptr;
314		QScrollBar *m_scroll = nullptr;
315
316		/**
317		* Item with active syntax highlighting.
318		*/
319		ModeListWidgetItem *m_selectedItem = nullptr;
320
321		/**
322		* Icon for selected item (checkbox).
323		* NOTE: Selected and inactive items show an icon with incorrect color,
324		* however, this isn't a problem, since the list widget is never inactive.
325		*/
326		const QIcon m_checkIcon = QIcon::fromTheme(QStringLiteral("checkbox"));
327		static const int m_iconSize = 16;
328
329		QPointer<KTextEditor::DocumentPrivate> m_doc;
330
331		private Q_SLOTS:
332		/**
333		* Action when selecting a item in the list. This also applies
334		* the syntax highlighting in the document and hides the menu.
335		* This is equivalent to KateModeMenuList::selectHighlightingSetVisibility().
336		* @see selectHighlightingSetVisibility(), updateSelectedItem()
337		*/
338		void selectHighlighting(QListWidgetItem *pItem);
339		};
340
341		#endif // KATEMODEMENULIST_H