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
|
/* This file is part of KDevelop
Copyright 2007 Alexander Dymo <adymo@kdevelop.org>
Copyright 2012 Miha Čančula <miha@noughmad.eu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_TEMPLATESMODEL_H
#define KDEVPLATFORM_TEMPLATESMODEL_H
#include <QStandardItemModel>
#include <language/languageexport.h>
namespace KDevelop {
class TemplatesModelPrivate;
/**
* @brief A convenience class for loading templates using .kdevtemplate files
*
* It loads template archives, extracts and stores their description files, and
* displays them as a three-level tree structure.
*
* The locations for loading and storing files are determined by the typePrefix.
* We use QStandardPaths with the GenericData type and create a filter string as such:
* \li templates: typePrefix "/templates/"
* \li descriptions: typePrefix "/template_descriptions/"
*
* Preview images are directly read from the archives on demand (or for legacy
* template installations from typePrefix "/template_previews/").
*
* @sa ITemplateProvider::templatesModel()
**/
class KDEVPLATFORMLANGUAGE_EXPORT TemplatesModel
: public QStandardItemModel
{
Q_OBJECT
public:
/**
* Extra roles for template-specific properties
* @sa Qt::ItemDataRole
**/
enum TemplateRole
{
DescriptionFileRole = Qt::UserRole + 1, ///< Template description file name
PreviewIconRole = Qt::UserRole + 2, ///< Template preview icon, provides a TemplatePreviewIcon
CommentRole = Qt::UserRole + 3, ///< Template comment
ArchiveFileRole = Qt::UserRole + 4 ///< Template archive file name
};
/**
* Creates a new templates model
*
* @param typePrefix the type prefix used to determine resource locations.
* @param parent parent object, defaults to 0.
**/
explicit TemplatesModel(const QString& typePrefix, QObject* parent = nullptr);
/**
* Destructor
*
**/
~TemplatesModel() override;
/**
* Reloads all found templates
**/
virtual void refresh();
/**
* Loads template @p fileName and save it to the template storage directory.
*
* If the file is an archive, the whole archive will be copied.
* If the file has a .desktop or .kdevtemplate suffix, the contents
* of its containing directory will be archived and saved.
**/
QString loadTemplateFile(const QString& fileName);
/**
* Finds the model index of the template file @p fileName.
*
* For convenience, this function returns the found template index, as well as all of its ancestors.
* The indexes are ordered from the top-level ancestor to the actual index of the template.
* This is useful for managing selection when multiple views display different level of the model.
*
* @param fileName the template file name
**/
QModelIndexList templateIndexes(const QString& fileName) const;
/**
* Returns the type prefix used to find a template resource.
**/
QString typePrefix() const;
/**
* The model will include @p path during the search for template archives
*
* @param path Path to a directory that contains normal user data. The template model will search for a kdevappwizard/templates (or your model name prefix) directory
* inside @p path and will use them. Please note that the path has to end with a '/'.
*/
void addDataPath(const QString& path);
private:
const QScopedPointer<class TemplatesModelPrivate> d_ptr;
Q_DECLARE_PRIVATE(TemplatesModel)
};
}
#endif // KDEVPLATFORM_TEMPLATESMODEL_H
|
