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
|
/*
This file is part of kdepim.
Copyright (c) 2004 Cornelius Schumacher <schumacher@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 KODE_LICENSE_H
#define KODE_LICENSE_H
#include <kode_export.h>
#include <QtCore/QArgument>
#include <QtCore/QString>
namespace KODE {
/**
* @brief Represent a license clause.
* Use this class to setup a license clause for your generated file.
*
* @author Cornelius Schumacher <schumacher@kde.org>
*/
class KODE_EXPORT License
{
Q_GADGET
public:
/**
* Possible types of licenses
* @li GPL - The GNU General Public License.
* @li LGPL - The GNU Lesser/Library General Public License.
* @li BSD - Berkeley Software Distribution
* @li GeneratedNoRestriction - Generated code with no restrictions.
* @li NoLicense - No license specified
*/
enum Type { GPL, LGPL, BSD, GeneratedNoRestriction, NoLicense };
Q_ENUM(Type)
/**
* Creates a new license.
*/
License();
/**
* Create a new license of the given @param type.
*/
License(Type type);
/**
* Creates a new license from @param other.
*/
License(const License &other);
/**
* Destroys the license.
*/
~License();
/**
* Assignment operator.
*/
License &operator=(const License &other);
/**
* Sets whether a Qt expection should be appended to
* the license statement.
*
* This is only useful for Qt3 based code.
*/
void setQtException(bool useQtException);
/**
* Returns the textual presentation of the license.
*/
QString text() const;
/**
* Returns type of license.
*/
Type type() const;
/**
* Return license name.
* @return name of license
*/
QString typeName() const;
/**
* Returns license Type element by name. If there no such license,
* NoLicense will be returned
* @param license_string Name of license
* @return one of Type elements
*/
static License licenseByTypeName(const QString &typeName);
/**
* Returns list of supported licenses
* @return vector of license names
*/
static QStringList getSupportedLicenses();
private:
class Private;
Private *d;
};
}
#endif
|
