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
|
/***************************************************************************
* Copyright (C) 2008 by Sebastian Trueg <[email protected]> *
* Copyright (C) 2009 by Peter Penz <[email protected]> *
* *
* This program 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 program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef METADATAWIDGET_H
#define METADATAWIDGET_H
#include <config-nepomuk.h>
#ifdef HAVE_NEPOMUK
#include <Nepomuk/Tag>
#else
// The HAVE_NEPOMUK macro cannot be used in combination with
// Q_PRIVATE_SLOT, hence a workaround is used for environments
// where Nepomuk is not available:
namespace Nepomuk {
typedef int Tag;
}
#endif
#include <kfileitem.h>
#include <QList>
#include <QWidget>
class KUrl;
/**
* @brief Shows the meta data of one or more file items.
*
* Meta data like name, size, rating, comment, ... are
* shown as several rows containing a description and
* the meta data value. It is possible for the user
* to change specific meta data like rating, tags and
* comment. The changes are stored automatically by the
* meta data widget.
*/
class MetaDataWidget : public QWidget
{
Q_OBJECT
public:
/**
* Allows to specifiy which general data should be hidden
* by the meta data widget.
* @see MetaDataWidget::setHiddenData()
* @see MetaDataWidget::hiddenData()
*/
enum MetaDataType
{
None = 0,
TypeData = 1,
SizeData= 2,
ModifiedData = 4,
OwnerData = 8,
PermissionsData = 16,
RatingData = 32,
TagsData = 64,
CommentData = 128
};
Q_DECLARE_FLAGS( MetaDataTypes, MetaDataType )
explicit MetaDataWidget(QWidget* parent = 0);
virtual ~MetaDataWidget();
/**
* Triggers the asynchronous loading of the meta data
* for the file item \p item. Connect to the signal
* loadingFinished() to be able to read the meta
* data.
*/
void setItem(const KFileItem& item);
/**
* Triggers the asynchronous loading of the meta data
* for the file items \p items. Connect to the signal
* loadingFinished() to be able to read the meta
* data.
*/
void setItems(const KFileItemList& items);
/**
* Convenience method for MetaDataWidget::setItem(const KFileItem&),
* if the application has only an URL and no file item.
* For performance reason it is recommended to use this convenience
* method only if the application does not have a file item already.
*/
void setItem(const KUrl& url);
/**
* Convenience method for MetaDataWidget::setItems(const KFileItemList&),
* if the application has only URLs and no file items.
* For performance reason it is recommended to use this convenience
* method only if the application does not have a file items already.
*/
void setItems(const QList<KUrl>& urls);
KFileItemList items() const;
/**
* Specifies which kind of data should be hidden (@see MetaDataWidget::Data).
* Example: metaDataWidget->setHiddenData(MetaDataWidget::TypeData | ModifiedData);
* Per default no data is hidden.
*/
void setHiddenData(MetaDataTypes data);
/**
* Returns which kind of data is hidden (@see MetaDataWidget::Data).
* Example: if (metaDataWidget->hiddenData() & MetaDataWidget::TypeData) ...
*/
MetaDataTypes hiddenData() const;
/**
* Returns the rating for the currently set item(s). It is required
* to wait for the signal loadingFinished() or ratingChanged()
* to get a valid result.
*/
unsigned int rating() const;
/**
* Returns the tags for the currently set item(s). It is required
* to wait for the signal loadingFinished() or tagsChanged()
* to get a valid result.
*/
QList<Nepomuk::Tag> tags() const;
/**
* Returns the comment for the currently set item(s). It is required
* to wait for the signal loadingFinished() or commentChanged()
* to get a valid result.
*/
QString comment() const;
signals:
/**
* Is emitted if the loading of the meta data has been finished
* after invoking MetaDataWidget::setItem() or MetaDataWidget::setItems().
*/
void loadingFinished();
/**
* Is emitted after the user has changed the rating.
* The changed rating is automatically stored already by
* the meta data widget.
* Note that the signal is not emitted if the rating has
* indirectly been changed by MetaDataWidget::setItem() or
* MetaDataWidget::setItems(). In this case connect to
* the signal loadingFinished() instead.
*/
void ratingChanged(const int rating);
/**
* Is emitted after the user has changed the tags.
* The changed tags are automatically stored already by
* the meta data widget.
* Note that the signal is not emitted if the tags have
* indirectly been changed by MetaDataWidget::setItem() or
* MetaDataWidget::setItems(). In this case connect to
* the signal loadingFinished() instead.
*/
void tagsChanged(const QList<Nepomuk::Tag>& tags);
/**
* Is emitted after the user has changed the comment.
* The changed comment is automatically stored already by
* the meta data widget.
* Note that the signal is not emitted if the comment has
* indirectly been changed by MetaDataWidget::setItem() or
* MetaDataWidget::setItems(). In this case connect to
* the signal loadingFinished() instead.
*/
void commentChanged(const QString& comment);
private:
class Private;
Private* d;
Q_PRIVATE_SLOT(d, void slotLoadingFinished())
Q_PRIVATE_SLOT(d, void slotRatingChanged(unsigned int rating))
Q_PRIVATE_SLOT(d, void slotTagsChanged(const QList<Nepomuk::Tag>& tags))
Q_PRIVATE_SLOT(d, void slotCommentChanged(const QString& comment))
Q_PRIVATE_SLOT(d, void slotMetaDataUpdateDone())
};
Q_DECLARE_OPERATORS_FOR_FLAGS(MetaDataWidget::MetaDataTypes)
#endif
|
