1 /*
2 SPDX-FileCopyrightText: 2010 Yannick Motta <yannick.motta@gmail.com>
3 SPDX-FileCopyrightText: 2010 Benjamin Port <port.benjamin@gmail.com>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7
8 #include "manpagedocumentation.h"
9
10 #include "manpageplugin.h"
11 #include "manpagedocumentationwidget.h"
12
13 #include <documentation/standarddocumentationview.h>
14
15 #include <KIO/TransferJob>
16 #include <KLocalizedString>
17
18 #include <QStandardPaths>
19
20
21 ManPagePlugin* ManPageDocumentation::s_provider=nullptr;
22
ManPageDocumentation(const QString & name,const QUrl & url)23 ManPageDocumentation::ManPageDocumentation(const QString& name, const QUrl& url)
24 : m_url(url), m_name(name)
25 {
26 KIO::StoredTransferJob* transferJob = KIO::storedGet(m_url, KIO::NoReload, KIO::HideProgressInfo);
27 connect( transferJob, &KIO::StoredTransferJob::finished, this, &ManPageDocumentation::finished);
28 transferJob->start();
29 }
30
finished(KJob * j)31 void ManPageDocumentation::finished(KJob* j)
32 {
33 auto* job = qobject_cast<KIO::StoredTransferJob*>(j);
34 if(job && job->error()==0) {
35 m_description = QString::fromUtf8(job->data());
36 } else {
37 m_description.clear();
38 }
39 emit descriptionChanged();
40 }
41
provider() const42 KDevelop::IDocumentationProvider* ManPageDocumentation::provider() const
43 {
44 return s_provider;
45 }
46
description() const47 QString ManPageDocumentation::description() const
48 {
49 return m_description;
50 }
51
documentationWidget(KDevelop::DocumentationFindWidget * findWidget,QWidget * parent)52 QWidget* ManPageDocumentation::documentationWidget(KDevelop::DocumentationFindWidget* findWidget, QWidget* parent )
53 {
54 auto* view = new KDevelop::StandardDocumentationView(findWidget, parent);
55 view->initZoom(provider()->name());
56 view->setDocumentation(IDocumentation::Ptr(this));
57 view->setDelegateLinks(true);
58 QObject::connect(view, &KDevelop::StandardDocumentationView::linkClicked, ManPageDocumentation::s_provider->model(), &ManPageModel::showItemFromUrl);
59
60 // apply custom style-sheet to normalize look of the page
61 const QString cssFile = QStandardPaths::locate(QStandardPaths::GenericDataLocation, QStringLiteral("kdevmanpage/manpagedocumentation.css"));
62 view->setOverrideCss(QUrl::fromLocalFile(cssFile));
63 return view;
64 }
65
providesWidget() const66 bool ManPageDocumentation::providesWidget() const
67 {
68 return false;
69 }
70
documentationWidget(KDevelop::DocumentationFindWidget * findWidget,QWidget * parent)71 QWidget* ManPageHomeDocumentation::documentationWidget(KDevelop::DocumentationFindWidget *findWidget, QWidget *parent){
72 Q_UNUSED(findWidget);
73 return new ManPageDocumentationWidget(parent);
74 }
75
76
name() const77 QString ManPageHomeDocumentation::name() const
78 {
79 return i18n("Man Content Page");
80 }
81
provider() const82 KDevelop::IDocumentationProvider* ManPageHomeDocumentation::provider() const
83 {
84 return ManPageDocumentation::s_provider;
85 }
86
87