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
|
/* This file is part of the KDE libraries
Copyright (c) 1999 Pietro Iglio <iglio@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 _KDESKTOPFILE_H
#define _KDESKTOPFILE_H
#include "kconfig.h"
#include "kdelibs_export.h"
class KDesktopFilePrivate;
/**
* KDE Desktop File Management.
*
* @author Pietro Iglio <iglio@kde.org>
* @see KConfigBase KConfig
* @short KDE Desktop File Management class
*/
class KDECORE_EXPORT KDesktopFile : public KConfig
{
Q_OBJECT
public:
/**
* Constructs a KDesktopFile object and make it either read-write
* or read-only.
*
* @param fileName The name or path of the desktop file. If it
* is not absolute, it will be located
* using the resource type @p resType.
* @param readOnly Whether the object should be read-only.
* @param resType Allows you to change what sort of resource
* to search for if @p fileName is not absolute. For
* instance, you might want to specify "config".
*/
KDesktopFile( const TQString &fileName, bool readOnly = false,
const char * resType = "apps");
/**
* Destructs the KDesktopFile object.
*
* Writes back any dirty configuration entries.
*/
virtual ~KDesktopFile();
/**
* Checks whether this is really a desktop file.
*
* The check is performed looking at the file extension (the file is not
* opened).
* Currently, valid extensions are ".kdelnk" and ".desktop".
* @param path the path of the file to check
* @return true if the file appears to be a desktop file.
*/
static bool isDesktopFile(const TQString& path);
/**
* Checks whether the user is authorized to run this desktop file.
* By default users are authorized to run all desktop files but
* the KIOSK framework can be used to activate certain restrictions.
* See README.kiosk for more information.
* @param path the file to check
* @return true if the user is authorized to run the file
* @since 3.1
*/
static bool isAuthorizedDesktopFile(const TQString& path);
/**
* Returns the location where changes for the .desktop file @p path
* should be written to.
* @since 3.2
*/
static TQString locateLocal(const TQString &path);
/**
* Returns the value of the "Type=" entry.
* @return the type or TQString::null if not specified
*/
TQString readType() const;
/**
* Returns the value of the "Icon=" entry.
* @return the icon or TQString::null if not specified
*/
TQString readIcon() const;
/**
* Returns the value of the "Name=" entry.
* @return the name or TQString::null if not specified
*/
TQString readName() const;
/**
* Returns the value of the "Comment=" entry.
* @return the comment or TQString::null if not specified
*/
TQString readComment() const;
/**
* Returns the value of the "GenericName=" entry.
* @return the generic name or TQString::null if not specified
*/
TQString readGenericName() const;
/**
* Returns the value of the "Path=" entry.
* @return the path or TQString::null if not specified
*/
TQString readPath() const;
/**
* Returns the value of the "Dev=" entry.
* @return the device or TQString::null if not specified
*/
TQString readDevice() const;
/**
* Returns the value of the "URL=" entry.
* @return the URL or TQString::null if not specified
*/
TQString readURL() const;
/**
* Returns a list of the "Actions=" entries.
* @return the list of actions
*/
TQStringList readActions() const;
/**
* Sets the desktop action group.
* @param group the new action group
*/
void setActionGroup(const TQString &group);
/**
* Returns true if the action group exists, false otherwise
* @param group the action group to test
* @return true if the action group exists
*/
bool hasActionGroup(const TQString &group) const;
/**
* Checks whether there is a "Type=Link" entry.
*
* The link points to the "URL=" entry.
* @return true if there is a "Type=Link" entry
*/
bool hasLinkType() const;
/**
* Checks whether there is an entry "Type=Application".
* @return true if there is a "Type=Application" entry
*/
bool hasApplicationType() const;
/**
* Checks whether there is an entry "Type=MimeType".
* @return true if there is a "Type=MimeType" entry
*/
bool hasMimeTypeType() const; // funny name :)
/**
* Checks whether there is an entry "Type=FSDev".
* @return true if there is a "Type=FSDev" entry
*/
bool hasDeviceType() const;
/**
* Checks whether the TryExec field contains a binary
* which is found on the local system.
* @return true if TryExec contains an existing binary
*/
bool tryExec() const;
/**
* Returns the file name.
* @return The filename as passed to the constructor.
*/
TQString fileName() const;
/**
* Returns the resource.
* @return The resource type as passed to the constructor.
*/
TQString resource() const;
/**
* Returns the value of the "X-DocPath=" Or "DocPath=" entry.
* X-DocPath should be used and DocPath is depreciated and will
* one day be not supported.
* @return The value of the "X-DocPath=" Or "DocPath=" entry.
* @since 3.1
*/
TQString readDocPath() const;
/**
* Returns the entry of the "SortOrder=" entry.
* @return the value of the "SortOrder=" entry.
*/
TQStringList sortOrder() const;
/**
* Copies all entries from this config object to a new
* KDesktopFile object that will save itself to @p file.
*
* Actual saving to @p file happens when the returned object is
* destructed or when sync() is called upon it.
*
* @param file the new KDesktopFile object it will save itself to.
* @since 3.2
*/
KDesktopFile* copyTo(const TQString &file) const;
#ifdef KDE_NO_COMPAT
private:
#endif
/**
* @deprecated Use fileName() instead.
*/
KDE_DEPRECATED TQString filename() const { return fileName(); };
private:
TQString translatedEntry(const char*) const;
// copy-construction and assignment are not allowed
KDesktopFile( const KDesktopFile& );
KDesktopFile& operator= ( const KDesktopFile& );
protected:
virtual void virtual_hook( int id, void* data );
private:
KDesktopFilePrivate *d;
};
#endif
|
