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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
/* This file is part of the KDE project
Copyright (C) 2000 Waldo Bastian <bastian@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 version 2 as published by the Free Software Foundation.
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 __kservicegroup_h__
#define __kservicegroup_h__
#include <tqptrlist.h>
#include <tqstring.h>
#include <tqshared.h>
#include <tqdatastream.h>
#include <tqvariant.h>
#include <kdesktopfile.h>
#include <ksortablevaluelist.h>
#include "ksycocaentry.h"
#include "ksycocatype.h"
#include "kservice.h"
class KBuildServiceGroupFactory;
/**
* KServiceGroup represents a group of service, for example
* screensavers.
* This class is typically used like this:
*
* \code
* // Lookup screensaver group
* KServiceGroup::Ptr group = KServiceGroup::baseGroup("screensavers");
* if (!group || !group->isValid()) return;
*
* KServiceGroup::List list = group->entries();
*
* // Iterate over all entries in the group
* for( KServiceGroup::List::ConstIterator it = list.begin();
* it != list.end(); it++)
* {
* KSycocaEntry *p = (*it);
* if (p->isType(KST_KService))
* {
* KService *s = static_cast<KService *>(p);
* printf("Name = %s\n", s->name().latin1());
* }
* else if (p->isType(KST_KServiceGroup))
* {
* KServiceGroup *g = static_cast<KServiceGroup *>(p);
* // Sub group ...
* }
* }
* \endcode
* @short Represents a group of services
*/
class TDEIO_EXPORT KServiceGroup : public KSycocaEntry
{
friend class KBuildServiceGroupFactory;
K_SYCOCATYPE( KST_KServiceGroup, KSycocaEntry )
public:
typedef KSharedPtr<KServiceGroup> Ptr;
typedef KSharedPtr<KSycocaEntry> SPtr;
typedef TQValueList<SPtr> List;
public:
/**
* Construct a dummy servicegroup indexed with @p name.
* @param name the name of the service group
* @since 3.1
*/
KServiceGroup( const TQString & name );
/**
* Construct a service and take all informations from a config file
* @param _fullpath full path to the config file
* @param _relpath relative path to the config file
*/
KServiceGroup( const TQString & _fullpath, const TQString & _relpath );
/**
* @internal construct a service from a stream.
* The stream must already be positionned at the correct offset
*/
KServiceGroup( TQDataStream& _str, int offset, bool deep );
virtual ~KServiceGroup();
/**
* Checks whether the entry is valid, returns always true.
* @return true
*/
bool isValid() const { return true; }
/**
* Name used for indexing.
* @return the service group's name
*/
virtual TQString name() const { return entryPath(); }
/**
* Returns the relative path of the service group.
* @return the service group's relative path
*/
virtual TQString relPath() const { return entryPath(); }
/**
* Returns the caption of this group.
* @return the caption of this group
*/
TQString caption() const { return m_strCaption; }
/**
* Returns the name of the icon associated with the group.
* @return the name of the icon associated with the group,
* or TQString::null if not set
*/
TQString icon() const { return m_strIcon; }
/**
* Returns the comment about this service group.
* @return the descriptive comment for the group, if there is one,
* or TQString::null if not set
*/
TQString comment() const { return m_strComment; }
/**
* Returns the total number of displayable services in this group and
* any of its subgroups.
* @return the number of child services
*/
int childCount();
/**
* Returns true if the NoDisplay flag was set, i.e. if this
* group should be hidden from menus, while still being in ksycoca.
* @return true to hide this service group, false to display it
* @since 3.1
*/
bool noDisplay() const;
/**
* Return true if we want to display empty menu entry
* @return true to show this service group as menu entry is empty, false to hide it
* @since 3.4
*/
bool showEmptyMenu() const;
void setShowEmptyMenu( bool b);
/**
* @return true to show an inline header into menu
* @since 3.5
*/
bool showInlineHeader() const;
void setShowInlineHeader(bool _b);
/**
* @return true to show an inline alias item into menu
* @since 3.5
*/
bool inlineAlias() const;
void setInlineAlias(bool _b);
/**
* @return true if we allow to inline menu.
* @since 3.5
*/
bool allowInline() const;
void setAllowInline(bool _b);
/**
* @return inline limite value
* @since 3.5
*/
int inlineValue() const;
void setInlineValue(int _val);
/**
* Returns a list of untranslated generic names that should be
* be supressed when showing this group.
* E.g. The group "Games/Arcade" might want to suppress the generic name
* "Arcade Game" since it's redundant in this particular context.
* @since 3.2
*/
TQStringList suppressGenericNames() const;
/**
* @internal
* Sets information related to the layout of services in this group.
*/
void setLayoutInfo(const TQStringList &layout);
/**
* Original API and feature kindly provided by SuSE
*/
bool SuSEshortMenu() const;
bool SuSEgeneralDescription() const;
/**
* @internal
* Returns information related to the layout of services in this group.
*/
TQStringList layoutInfo() const;
/**
* @internal
* Load the service from a stream.
*/
virtual void load( TQDataStream& );
/**
* @internal
* Save the service to a stream.
*/
virtual void save( TQDataStream& );
/**
* List of all Services and ServiceGroups within this
* ServiceGroup.
* @param sorted true to sort items
* @param excludeNoDisplay true to exclude items marked "NoDisplay"
* @param allowSeparators true to allow separator items to be included
* @param sortByGenericName true to sort GenericName+Name instead of Name+GenericName
* @return the list of entries
* @since 3.2
*/
List entries(bool sorted, bool excludeNoDisplay, bool allowSeparators, bool sortByGenericName=false);
virtual List entries(bool sorted, bool excludeNoDisplay);
/**
* List of all Services and ServiceGroups within this
* ServiceGroup.
* @param sorted true to sort items
* @return the list of entried
*/
virtual List entries(bool sorted = false);
/*
* Original API and feature kindly provided by SuSE
*/
virtual List SuSEentries(bool sort, bool excludeNoDisplay, bool allowSeparators, bool sortByGenericName, bool excludeSuSEunimportant = false);
virtual List SuSEsortEntries( KSortableValueList<SPtr,TQCString> slist, KSortableValueList<SPtr,TQCString> glist, bool excludeNoDisplay, bool allowSeparators );
/**
* Returns a non-empty string if the group is a special base group.
* By default, "Settings/" is the kcontrol base group ("settings")
* and "System/Screensavers/" is the screensavers base group ("screensavers").
* This allows moving the groups without breaking those apps.
*
* The base group is defined by the X-TDE-BaseGroup key
* in the .directory file.
* @return the base group name, or null if no base group
*/
TQString baseGroupName() const { return m_strBaseGroupName; }
/**
* Returns a path to the .directory file describing this service group.
* The path is either absolute or relative to the "apps" resource.
* @since 3.2
*/
TQString directoryEntryPath() const;
/**
* Returns the group for the given baseGroupName.
* Can return 0L if the directory (or the .directory file) was deleted.
* @return the base group with the given name, or 0 if not available.
*/
static Ptr baseGroup( const TQString &baseGroupName );
/**
* Returns the root service group.
* @return the root service group
*/
static Ptr root();
/**
* Returns the group with the given relative path.
* @param relPath the path of the service group
* @return the group with the given relative path name.
*/
static Ptr group(const TQString &relPath);
/**
* Returns the group of services that have X-TDE-ParentApp equal
* to @p parent (siblings).
* @param parent the name of the service's parent
* @return the services group
* @since 3.1
*/
static Ptr childGroup(const TQString &parent);
/**
* This function parse attributes into menu
* @since 3.5
*/
void parseAttribute( const TQString &item , bool &showEmptyMenu, bool &showInline, bool &showInlineHeader, bool & showInlineAlias ,int &inlineValue );
protected:
/**
* @internal
* Add a service to this group
*/
void addEntry( KSycocaEntry *entry);
TQString m_strCaption;
TQString m_strIcon;
TQString m_strComment;
List m_serviceList;
bool m_bDeep;
TQString m_strBaseGroupName;
int m_childCount;
protected:
virtual void virtual_hook( int id, void* data );
private:
class Private;
Private* d;
};
class TDEIO_EXPORT KServiceSeparator : public KSycocaEntry
{
K_SYCOCATYPE( KST_KServiceSeparator, KSycocaEntry )
public:
typedef KSharedPtr<KServiceSeparator> Ptr;
public:
/**
* Construct a service separator
* @since 3.2
*/
KServiceSeparator();
bool isValid() const { return true; }
// Dummy
virtual TQString name() const { return "separator"; }
// Dummy
virtual void load( TQDataStream& ) { };
// Dummy
virtual void save( TQDataStream& ) { };
};
#endif
|