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
|
/* This file is part of KDevelop
Copyright 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
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_TEMPLATEPREVIEWICON_H
#define KDEVPLATFORM_TEMPLATEPREVIEWICON_H
#include <QSharedDataPointer>
#include <QMetaType>
#include <language/languageexport.h>
class QPixmap;
namespace KDevelop {
class TemplatePreviewIconData;
/**
* @brief A class for loading preview images/icons as specified in a template description on demand
*
* It stores the icon name as extracted from the template description together with
* the path to the archive. Only on demand will the icon file tried to be loaded and
* returned as pixmap object.
* To support also legacy template installations with the preview image installed as separate file,
* the local directory prefix in the QStandardPaths::GenericDataLocation is stored as well
* to search also those paths as fallback.
*
* If the icon name is empty, no matching icon file could be found or no image successfully loaded,
* the returned pixmap will default to a themed "kdevelop" icon image (128x128).
**/
class KDEVPLATFORMLANGUAGE_EXPORT TemplatePreviewIcon
{
public:
/**
* Creates a new template preview icon object
*
* @param iconName the raw icon name as specified in the template description
* @param archivePath absolute path to the template archive the icon is used by
* @param dataDir local directory prefix of the icon file if searching it through QStandardPaths::GenericDataLocation
**/
TemplatePreviewIcon(const QString& iconName, const QString& archivePath, const QString& dataDir);
TemplatePreviewIcon();
TemplatePreviewIcon(const TemplatePreviewIcon& other);
~TemplatePreviewIcon();
TemplatePreviewIcon& operator=(const TemplatePreviewIcon& other);
public:
/**
* Generates a pixmap to be used as preview for a template.
* Either from the preview image file as specified, or falling back
* to a themed "kdevelop" icon image (128x128).
* The pixmap is not cached, .
*
* @return pixmap to be used as preview for a template
**/
QPixmap pixmap() const;
private:
QSharedDataPointer<TemplatePreviewIconData> d;
};
}
Q_DECLARE_METATYPE(KDevelop::TemplatePreviewIcon)
#endif // KDEVPLATFORM_TEMPLATEPREVIEWICON_H
|
