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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/**
*
* This file is part of the kxsldbg package
* Copyright (c) 2008 Keith Isdale <keith@kdewebdev.org>
*
* This library is free software; you can redistribute it and/or
* This library 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) 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 XSLDBGSETTINGSMODEL_H
#define XSLDBGSETTINGSMODEL_H
#include <QVariant>
#include <QStringList>
#include <QAbstractTableModel>
#include <QHash>
#include <QMutex>
#include "kconfiggroup.h"
class XsldbgSettingsModelPrivate;
class XsldbgSettingData
{
public:
XsldbgSettingData();
XsldbgSettingData(const QString & name, const QVariant &value, int row);
XsldbgSettingData(int optionID, const QVariant &value, int row);
XsldbgSettingData & operator=(const XsldbgSettingData & other);
QString m_name;
QVariant m_value;
int m_type;
int m_id;
int m_row;
static QString myKey(const QString &name, int type);
};
typedef QHash<QString, XsldbgSettingData>::iterator XsldbgSettingDataIterator;
typedef QHash<QString, XsldbgSettingData>::const_iterator XsldbgSettingDataConstIterator;
QDebug operator<< ( QDebug stream, const XsldbgSettingData &item);
/**
* class XsldbgSettingsModel
*/
class XsldbgSettingsModel : public QAbstractTableModel
{
public:
enum SettingsType {
UnknownSettingType = -1,
BoolSettingType = 1,
IntSettingType = 2,
StringSettingType = 4,
ParamSettingType = 8,
HiddenSettingType = 16,
VisibleSettingType = BoolSettingType | IntSettingType | StringSettingType | ParamSettingType,
AnySimpleSettingType = BoolSettingType | IntSettingType | StringSettingType | HiddenSettingType,
AnySettingType = BoolSettingType | IntSettingType | StringSettingType | ParamSettingType | HiddenSettingType
};
enum SortType {
SortNone,
SortById = 1,
SortByName
};
static const int SettingTypeRole = Qt::UserRole + 2;
static const int SettingNameRole = Qt::UserRole + 3;
static const int SettingValueRole = Qt::UserRole + 4;
static const int SettingIDRole = Qt::UserRole + 5;
/**
* Empty Constructor
*/
XsldbgSettingsModel();
// perform setup of the settings, reverting to a pristine state
void init();
/**
* Empty Destructor
*/
virtual ~XsldbgSettingsModel();
/**
* Sets the role data for the item at index to value. Returns true if successful;
* otherwise returns false.
* @return Sets the role data for the item at index to value. Returns true if successful;
* otherwise returns false.
* @param index
* @param value
* @param role
*/
bool setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole);
/**
* Returns the data stored under the given role for the item referred to by the
* index.
* @return Returns the data stored under the given role for the item referred to by the
* index
* @param index
* @param role
*/
QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const;
/**
* Returns the number of columns for the children of the given parent. When the
* parent is valid it means that rowCount is returning the number of children of
* parent.
* @return Returns the number of columns for the children of the given parent. When the
* parent is valid it means that rowCount is returning the number of children of
* parent
* @param parent
*/
int columnCount(const QModelIndex & parent = QModelIndex()) const;
/**
* Returns the number of rows under the given parent. When the parent is valid it
* means that rowCount is returning the number of children of parent.
* @return Returns the number of rows under the given parent. When the parent is valid it
* means that rowCount is returning the number of children of parent.
* @param parent
*/
int rowCount(const QModelIndex & parent = QModelIndex()) const;
/**
* Add a XSLT parameter
* @return Returns true if able to add XSLT parameter with name @a name and value @a value
* otherwise return false
* @param name
* @param value
*/
bool addParameter(const QString & name, const QVariant & value);
/**
* Remove a XSLT parameter
*/
bool removeParameter(const QString & name);
void removeAllParameters();
/**
* Return a list of setting name that match type requested
* @return Return a list of setting name that match type requested
* @param settingtype
* @param sortType what sorting is required, if non required
*/
QStringList settingsList(SettingsType settingType, SortType sortType=SortNone) const;
/**
* Returns true if able to find the item named @a name that matches type @a settingType and
* sets outItem to the value of item found otherwise false
* @return Returns true if able to find the item named @a name that matches type @a type and
* sets outItem to the value of item found otherwise false
* @param name
* @param settingType
* @param outItem
*/
bool findSetting(const QString & name, SettingsType settingType, XsldbgSettingData &outItem) const;
/**
* Returns true if able to find the item with optionID @a optionID and
* sets outItem to the value of item found otherwise false
* @returns Returns true if able to find the item with optionID @a optionID and
* sets outItem to the value of item found otherwise false
* @param optionID
* @param outItem
*/
bool findSetting(int optionID, XsldbgSettingData &outItem) const;
int findModelRow(int optionID, bool isParameter=false) const;
bool updateSetting(int optionID, QVariant & value);
/**
* Return true if able to save settings to supplied configGroup
* @return bool
* @param configGroup
*/
bool saveSettings (KConfigGroup & configGroup ) const;
/**
* Return true if able to loadsettings from supplied configGroup
* @return bool
* @param configGroup
*/
bool loadSettings (const KConfigGroup & configGroup );
void lock(bool lockState);
private:
XsldbgSettingsModelPrivate *d_ptr;
QString optionPrefix;
QString paramPrefix;
QMutex mutext;
};
#endif // XSLDBGSETTINGSMODEL_H
|