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
|
/*
* This file is part of KDevelop
* Copyright 2012 Milian Wolff <mail@milianw.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KDEVPLATFORM_PLUGIN_TEMPLATEPREVIEW_H
#define KDEVPLATFORM_PLUGIN_TEMPLATEPREVIEW_H
#include <QWidget>
#include <QHash>
#include <language/codegen/templaterenderer.h>
namespace KTextEditor {
class Document;
class View;
}
/**
* A renderer that adds some common variables for previewing purposes.
*/
class TemplatePreviewRenderer : public KDevelop::TemplateRenderer
{
public:
TemplatePreviewRenderer();
~TemplatePreviewRenderer() override;
};
/**
* A KTextEditor::View wrapper to show a preview of a template.
*/
class TemplatePreview : public QWidget
{
Q_OBJECT
public:
explicit TemplatePreview(QWidget* parent);
~TemplatePreview() override;
/**
* Set the template contents which will be rendered.
*
* @p text the template contents
* @p isProject set to true if the contents resemble a project template
* @return an error message, or an empty string if everything worked
*/
QString setText(const QString& text, bool isProject = false,
KDevelop::TemplateRenderer::EmptyLinesPolicy policy = KDevelop::TemplateRenderer::TrimEmptyLines);
/**
* @return The read-only document.
*/
KTextEditor::Document* document() const;
private:
Q_DISABLE_COPY(TemplatePreview)
QHash<QString, QString> m_variables;
QScopedPointer<KTextEditor::Document> m_preview;
KTextEditor::View* m_view;
};
#endif // KDEVPLATFORM_PLUGIN_TEMPLATEPREVIEW_H
|
