Differential D16484 Diff 44608 plugins/scratchpad/scratchpadview.cpp

Changeset View

Standalone View

View Options

plugins/scratchpad/scratchpadview.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ *
3​ * Copyright 2018 Amish K. Naidu <amhndu@gmail.com>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License
7​ * as published by the Free Software Foundation; either version 2
8​ * of the License, or (at your option) any later version.
9​ *
10​ * This program 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
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License
16​ * along with this program; if not, write to the Free Software
17​ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18​ * 02110-1301, USA.
19​ */
20​
21​#include "scratchpadview.h"
22​#include "scratchpad.h"
23​
24​#include <debug.h>
25​
26​#include <interfaces/icore.h>
27​#include <interfaces/idocumentcontroller.h>
28​#include <interfaces/idocument.h>
29​
30​#include <KLocalizedString>
31​#include <KMessageBox>
32​
33​#include <QAction>
34​#include <QStandardItemModel>
35​#include <QSortFilterProxyModel>
36​#include <QStyledItemDelegate>
37​#include <QWidgetAction>
38​#include <QLineEdit>
39​#include <QInputDialog>
40​
41​// Use a delegate because the dataChanged signal doesn't tell us the previous name
42​class FileRenameDelegate
43​ : public QStyledItemDelegate
44​{
45​public:
46​ FileRenameDelegate(QObject* parent, Scratchpad* scratchpad)
47​ : QStyledItemDelegate(parent)
48​ , m_scratchpad(scratchpad)
49​ {
50​ }
51​
52​ void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override
53​ {
54​ const QString previousName = index.data().toString();
55​ QStyledItemDelegate::setModelData(editor, model, index);
56​ const auto* proxyModel = static_cast<QAbstractProxyModel*>(model);
57​ m_scratchpad->renameScratch(proxyModel->mapToSource(index), previousName);
58​ }
59​
60​private:
61​ Scratchpad* m_scratchpad;
62​};
63​
64​ScratchpadView::ScratchpadView(QWidget* parent, Scratchpad* scratchpad)
65​ : QWidget(parent)
66​ , m_scratchpad(scratchpad)
67​{
68​ setupUi(this);
69​
70​ setupActions();
71​
72​ setWindowTitle(i18n("Scratchpad"));
73​ setWindowIcon(QIcon::fromTheme(QStringLiteral("note")));
74​
75​ auto* const modelProxy = new QSortFilterProxyModel(this);
76​ modelProxy->setSourceModel(m_scratchpad->model());
77​ modelProxy->setFilterCaseSensitivity(Qt::CaseInsensitive);
78​ modelProxy->setSortCaseSensitivity(Qt::CaseInsensitive);
79​ modelProxy->setSortRole(Qt::DisplayRole);
80​ connect(m_filter, &QLineEdit::textEdited,
81​ modelProxy, &QSortFilterProxyModel::setFilterWildcard);
82​
83​ scratchTree->setModel(modelProxy);
84​ scratchTree->setItemDelegate(new FileRenameDelegate(this, m_scratchpad));
85​
86​ connect(scratchTree, &QListView::activated, this, &ScratchpadView::scratchActivated);
87​
88​ connect(m_scratchpad, &Scratchpad::actionFailed, [this](const QString& message) {
89​ KMessageBox::sorry(this, message);
90​ });
91​
92​ connect(commandWidget, &QLineEdit::returnPressed, this, &ScratchpadView::runSelectedScratch);
93​ connect(commandWidget, &QLineEdit::returnPressed, [this] {
94​ m_scratchpad->setCommand(proxyModel()->mapToSource(currentIndex()), commandWidget->text());
95​ });
96​ commandWidget->setToolTip(i18n("Command to run this scratch. $f will expand to the scratch path"));
97​ commandWidget->setPlaceholderText(commandWidget->toolTip());
98​
99​ // change active scratch when changing document
100​ connect(KDevelop::ICore::self()->documentController(), &KDevelop::IDocumentController::documentActivated,
101​ [this](const KDevelop::IDocument* document) {
102​ if (document->url().isLocalFile()) {
103​ const auto* model = scratchTree->model();
104​ const auto index = model->match(model->index(0, 0), Scratchpad::FullPathRole,
105​ document->url().toLocalFile()).value({});
106​ if (index.isValid()) {
107​ scratchTree->setCurrentIndex(index);
108​ }
109​ }
110​ });
111​
112​ validateItemActions();
113​}
114​
115​void ScratchpadView::setupActions()
116​{
117​ QAction* action = new QAction(QIcon::fromTheme(QStringLiteral("list-add")), i18n("New Scratch"), this);
118​ connect(action, &QAction::triggered, this, &ScratchpadView::createScratch);
119​ addAction(action);
120​
121​ action = new QAction(QIcon::fromTheme(QStringLiteral("list-remove")), i18n("Remove Scratch"), this);
122​ connect(action, &QAction::triggered, [this] {
123​ m_scratchpad->removeScratch(proxyModel()->mapToSource(currentIndex()));
124​ });
125​ addAction(action);
126​ m_itemActions.push_back(action);
127​
128​ action = new QAction(QIcon::fromTheme(QStringLiteral("edit-rename")), i18n("Rename Scratch"), this);
129​ connect(action, &QAction::triggered, [this] {
130​ scratchTree->edit(scratchTree->currentIndex());
131​ });
132​ addAction(action);
133​ m_itemActions.push_back(action);
134​
135​ action = new QAction(QIcon::fromTheme(QStringLiteral("media-playback-start")), i18n("Run Scratch"), this);
136​ connect(action, &QAction::triggered, this, &ScratchpadView::runSelectedScratch);
137​ addAction(action);
138​ m_itemActions.push_back(action);
139​
140​ m_filter = new QLineEdit(this);
141​ m_filter->setPlaceholderText(i18n("Filter..."));
142​ auto filterAction = new QWidgetAction(this);
143​ filterAction->setDefaultWidget(m_filter);
144​ addAction(filterAction);
145​}
146​
147​void ScratchpadView::validateItemActions()
148​{
149​ bool enable = currentIndex().isValid();
150​
151​ for (auto* action : m_itemActions) {
152​ action->setEnabled(enable);
153​ }
154​
155​ commandWidget->setReadOnly(!enable);
brauchUnsubmitted
Done

You can omit the arguments of slots if you do not need them.

brauch: You can omit the arguments of slots if you do not need them.
156​}
157​
158​void ScratchpadView::runSelectedScratch()
159​{
160​ const auto sourceIndex = proxyModel()->mapToSource(currentIndex());
brauchUnsubmitted
Done

"auto" is sufficient, you do not need "auto*"

brauch: "auto" is sufficient, you do not need "auto*"
161​ m_scratchpad->setCommand(sourceIndex, commandWidget->text());
162​ m_scratchpad->runScratch(sourceIndex);
163​}
164​
165​void ScratchpadView::scratchActivated(const QModelIndex& index)
166​{
167​ validateItemActions();
168​ m_scratchpad->openScratch(proxyModel()->mapToSource(index));
169​ commandWidget->setText(index.data(Scratchpad::RunCommandRole).toString());
170​}
171​
172​void ScratchpadView::createScratch()
173​{
174​ QString name = QInputDialog::getText(this, i18n("Create New Scratch"),
175​ i18n("Enter name for scratch file:"),
176​ QLineEdit::Normal,
177​ QStringLiteral("example.cpp"));
brauchUnsubmitted
Done

probably the command should be per scratch ...?

brauch: probably the command should be per scratch ...?
178​ if (!name.isEmpty()) {
179​ m_scratchpad->createScratch(name);
180​ }
181​}
182​
183​QAbstractProxyModel* ScratchpadView::proxyModel() const
184​{
185​ return static_cast<QAbstractProxyModel*>(scratchTree->model());
186​}
187​
188​QModelIndex ScratchpadView::currentIndex() const
189​{
190​ return scratchTree->currentIndex();
191​}