1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
SPDX-FileCopyrightText: 2013 Sven Brauch <svenbrauch@gmail.com>
SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
#include "docfilemanagerwidget.h"
#include "kcm_docfiles.h"
#include "docfilewizard.h"
#include <interfaces/idocumentcontroller.h>
#include <interfaces/icore.h>
#include <QBoxLayout>
#include <QFileSystemModel>
#include <QDialogButtonBox>
#include <QTreeView>
#include <QPushButton>
#include <QSplitter>
#include <QLabel>
#include <QTextEdit>
#include <QUrl>
#include <QDebug>
#include <QTemporaryFile>
#include <QStandardPaths>
#include <QDesktopServices>
#include <QIcon>
#include <KMessageBox>
#include <KLocalizedString>
#include <KTextEditor/Document>
DocfileManagerWidget::DocfileManagerWidget(QWidget* parent)
: QWidget(parent)
{
QString dir = docfilePath();
if ( dir.isEmpty() ) {
KMessageBox::error(this, i18n("Failed to find a valid data directory for kdevpythonsupport."));
return;
}
// construct the tree view which displays the currently installed files
QFileSystemModel* model = new QFileSystemModel(this);
model->setRootPath(dir);
filesTreeView = new QTreeView;
filesTreeView->setSelectionMode(QAbstractItemView::MultiSelection);
filesTreeView->setModel(model);
filesTreeView->setRootIndex(model->index(dir));
// construct the buttons for up/download
QVBoxLayout* buttonsLayout = new QVBoxLayout;
QPushButton* generateButton = new QPushButton(i18n("Generate..."));
generateButton->setIcon(QIcon::fromTheme(QStringLiteral("tools-wizard")));
QPushButton* importButton = new QPushButton(i18n("Import From Editor"));
importButton->setToolTip(i18n("Copy the contents of the active editor window "
"to a new file in the documentation directory"));
buttonsLayout->addWidget(generateButton);
buttonsLayout->addWidget(importButton);
QObject::connect(generateButton, &QAbstractButton::clicked, this, &DocfileManagerWidget::runWizard);
QObject::connect(importButton, &QAbstractButton::clicked, this, &DocfileManagerWidget::copyEditorContents);
// construct the buttons for the remaining actions
QFrame* separator = new QFrame();
separator->setFrameShape(QFrame::HLine);
QFrame* separator2 = new QFrame();
separator2->setFrameShape(QFrame::HLine);
QPushButton* openFileManagerButton = new QPushButton(i18n("Open File Manager"));
openFileManagerButton->setIcon(QIcon::fromTheme(QStringLiteral("system-file-manager")));
QPushButton* openTextEditorButton = new QPushButton(i18nc("Edit selected files", "Edit Selected"));
openTextEditorButton->setIcon(QIcon::fromTheme(QStringLiteral("document-edit")));
QPushButton* searchPathsButton = new QPushButton(i18n("Search Paths..."));
searchPathsButton->setIcon(QIcon::fromTheme(QStringLiteral("search")));
buttonsLayout->addWidget(separator);
buttonsLayout->addWidget(openFileManagerButton);
buttonsLayout->addWidget(openTextEditorButton);
buttonsLayout->addWidget(separator2);
buttonsLayout->addWidget(searchPathsButton);
QObject::connect(openFileManagerButton, &QAbstractButton::clicked, this, &DocfileManagerWidget::openDocfilePath);
QObject::connect(openTextEditorButton, &QAbstractButton::clicked, this, &DocfileManagerWidget::openSelectedInTextEditor);
QObject::connect(searchPathsButton, &QAbstractButton::clicked, this, &DocfileManagerWidget::showSearchPaths);
buttonsLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding, QSizePolicy::Expanding));
// arrange the results nicely around a splitter
QSplitter* splitter = new QSplitter;
QWidget* w = new QWidget;
w->setLayout(buttonsLayout);
splitter->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
splitter->addWidget(filesTreeView);
splitter->addWidget(w);
splitter->setSizes(QList<int>() << 800 << 100);
setLayout(new QVBoxLayout);
layout()->addWidget(splitter);
layout()->setContentsMargins(0, 0, 0, 0);
}
void DocfileManagerWidget::showSearchPaths()
{
QStringList dirs = QStandardPaths::locateAll(QStandardPaths::GenericDataLocation, QStringLiteral("kdevpythonsupport/documentation_files"), QStandardPaths::LocateDirectory);
QLabel* dirsMessageLabel = new QLabel(i18nc("displays a list of search paths below",
"Paths searched for documentation by kdev-python (in this order):"));
QTextEdit* paths = new QTextEdit;
paths->setPlainText(dirs.join(QLatin1Char('\n')));
paths->setReadOnly(true);
QDialog* message = new QDialog(this);
message->setLayout(new QVBoxLayout);
message->layout()->addWidget(dirsMessageLabel);
message->layout()->addWidget(paths);
QWidget* closeWidget = new QWidget;
QPushButton* closeButton = new QPushButton(QStringLiteral("Close"));
closeWidget->setLayout(new QHBoxLayout);
closeWidget->layout()->addItem(new QSpacerItem(1, 1, QSizePolicy::Expanding, QSizePolicy::Expanding));
closeWidget->layout()->addWidget(closeButton);
message->layout()->addWidget(closeWidget);
QObject::connect(closeButton, &QAbstractButton::clicked, message, &QWidget::close);
message->resize(600, 200);
message->exec();
}
void DocfileManagerWidget::openDocfilePath()
{
if ( QDir(docfilePath()).exists() ) {
QDesktopServices::openUrl(QUrl::fromLocalFile(docfilePath()));
}
}
void DocfileManagerWidget::copyEditorContents()
{
KDevelop::IDocumentController* documentController = KDevelop::ICore::self()->documentController();
if ( documentController->activeDocument() ) {
if ( KTextEditor::Document* doc = documentController->activeDocument()->textDocument() ) {
auto dialog = new QDialog(this);
auto buttonbox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel, dialog);
connect(buttonbox->button(QDialogButtonBox::Ok), &QPushButton::clicked,
dialog, &QDialog::accept);
connect(buttonbox->button(QDialogButtonBox::Cancel), &QPushButton::clicked,
dialog, &QDialog::reject);
dialog->setLayout(new QVBoxLayout);
dialog->layout()->addWidget(new QLabel(i18n("Enter a relative target path to copy %1 to:", doc->url().path())));
QLineEdit* lineEdit = new QLineEdit;
lineEdit->setText(doc->documentName());
dialog->layout()->addWidget(lineEdit);
dialog->layout()->addWidget(new QLabel(i18n("This path must match what you use in Python to import "
"this module. For example, enter \"numpy/fft.py\" for numpy.fft")));
dialog->layout()->addWidget(new QLabel(i18n("After copying, you will be editing the new document.")));
dialog->layout()->addWidget(buttonbox);
if ( dialog->exec() == QDialog::Accepted ) {
auto target = QUrl::fromLocalFile(docfilePath() + QStringLiteral("/") + lineEdit->text());
// TODO QUrl: cleanPath?
QDir d(target.url());
if ( ! d.exists() ) {
d.mkpath(d.absolutePath());
}
doc->saveAs(target);
}
}
}
}
void DocfileManagerWidget::openSelectedInTextEditor()
{
const QList<QUrl> selected = selectedItems();
if ( selected.isEmpty() ) {
KMessageBox::information(this, i18n("Please select at least one file from the list for editing."));
}
for ( const QUrl& item : selected ) {
KDevelop::ICore::self()->documentController()->openDocument(item);
}
}
QString DocfileManagerWidget::docfilePath()
{
// finds a local directory which is contained in the dirs searched by the parser, code
// and creates it if it doesn't exist
QString path = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QStringLiteral("/") + QStringLiteral("kdevpythonsupport/documentation_files/");
QDir dir(path);
dir.mkpath(path);
return path;
}
const QList<QUrl> DocfileManagerWidget::selectedItems() const
{
const QModelIndexList items = filesTreeView->selectionModel()->selectedRows();
QList<QUrl> urls;
const QFileSystemModel* fsmodel = qobject_cast<QFileSystemModel*>(filesTreeView->model());
for ( const QModelIndex& index : items ) {
urls << QUrl::fromLocalFile(fsmodel->filePath(index));
}
return urls;
}
void DocfileManagerWidget::runWizard()
{
DocfileWizard wizard(docfilePath(), this);
wizard.exec();
}
#include "moc_docfilemanagerwidget.cpp"
|
