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
125
126
|
/* This file is part of the KDE project
Copyright (C) 2003,2004 Ariya Hidayat <ariya@kde.org>
Copyright (C) 2005 Tomas Mecir <mecirt@gmail.com>
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; only
version 2 of the License.
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 CALLIGRA_SHEETS_FUNCTION_DESCRIPTION
#define CALLIGRA_SHEETS_FUNCTION_DESCRIPTION
#include <QList>
#include <QStringList>
#include "sheets_odf_export.h"
class QDomElement;
namespace Calligra
{
namespace Sheets
{
enum ParameterType { KSpread_Int, KSpread_Float, KSpread_String, KSpread_Boolean, KSpread_Any, KSpread_Date };
/**
* \ingroup Value
* A function parameter.
*/
class CALLIGRA_SHEETS_ODF_EXPORT FunctionParameter
{
public:
FunctionParameter();
FunctionParameter(const FunctionParameter& param);
explicit FunctionParameter(const QDomElement& element);
QString helpText() const {
return m_help;
}
ParameterType type() const {
return m_type;
}
bool hasRange() const {
return m_range;
}
private:
QString m_help;
ParameterType m_type;
bool m_range;
};
/**
* \ingroup Value
* A function description.
*/
class CALLIGRA_SHEETS_ODF_EXPORT FunctionDescription
{
public:
FunctionDescription();
explicit FunctionDescription(const QDomElement& element);
FunctionDescription(const FunctionDescription& desc);
const QStringList& examples() {
return m_examples;
}
const QStringList& syntax() {
return m_syntax;
}
const QStringList& related() {
return m_related;
}
const QStringList& helpText() const {
return m_help;
}
QString name() const {
return m_name;
}
ParameterType type() const {
return m_type;
}
int params() const {
return m_params.count();
}
FunctionParameter& param(int i) {
return m_params[ i ];
}
void setGroup(const QString& g) {
m_group = g;
}
QString group() const {
return m_group;
}
QString toQML() const;
private:
QString m_group;
QStringList m_examples;
QStringList m_syntax;
QStringList m_related;
QStringList m_help;
QString m_name;
ParameterType m_type;
QList<FunctionParameter> m_params;
};
} // namespace Sheets
} // namespace Calligra
#endif // CALLIGRA_SHEETS_FUNCTION_DESCRIPTION
|
