~ubuntu-branches/ubuntu/trusty/digikam/trusty

« back to all changes in this revision

Viewing changes to extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/haudioitem.h

  • Committer: Package Import Robot
  • Author(s): Rohan Garg
  • Date: 2012-11-26 18:24:20 UTC
  • mfrom: (1.9.1) (3.1.23 experimental)
  • Revision ID: package-import@ubuntu.com-20121126182420-qoy6z0nx4ai0wzcl
Tags: 4:3.0.0~beta3-0ubuntu1
* New upstream release
  - Add build-deps :  libhupnp-dev, libqtgstreamer-dev, libmagickcore-dev
* Merge from debian, remaining changes:
  - Make sure libqt4-opengl-dev, libgl1-mesa-dev and libglu1-mesa-dev only
    install on i386,amd64 and powerpc
  - Depend on libtiff-dev instead of libtiff4-dev
  - Drop digikam breaks/replaces kipi-plugins-common since we're past the
    LTS release now
  - digikam to recommend mplayerthumbs | ffmpegthumbs. We currently only
    have latter in the archives, even though former is also supposed to
    be part of kdemultimedia. (LP: #890059)
  - kipi-plugins to recommend www-browser rather than konqueror directly
    since 2.8 no direct usage of konqueror is present in the flickr
    plugin anymore (LP: #1011211)
  - Keep kubuntu_mysqld_executable_name.diff
  - Don't install libkipi translations
  - Keep deps on libcv-dev, libcvaux-dev
  - Keep split packaging of libraries
  - Replace icons from KDE 3 time in debian/xpm.d/*.xpm with the new
    versions (LP: #658047)
* Update debian/not-installed

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 *  Copyright (C) 2011 Tuomo Penttinen, all rights reserved.
 
3
 *
 
4
 *  Author: Tuomo Penttinen <tp@herqq.org>
 
5
 *
 
6
 *  This file is part of Herqq UPnP Av (HUPnPAv) library.
 
7
 *
 
8
 *  Herqq UPnP Av is free software: you can redistribute it and/or modify
 
9
 *  it under the terms of the GNU General Public License as published by
 
10
 *  the Free Software Foundation, either version 3 of the License, or
 
11
 *  (at your option) any later version.
 
12
 *
 
13
 *  Herqq UPnP Av is distributed in the hope that it will be useful,
 
14
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
16
 *  GNU General Public License for more details.
 
17
 *
 
18
 *  You should have received a copy of the GNU General Public License
 
19
 *  along with Herqq UPnP Av. If not, see <http://www.gnu.org/licenses/>.
 
20
 */
 
21
 
 
22
#ifndef HAUDIOITEM_H_
 
23
#define HAUDIOITEM_H_
 
24
 
 
25
#include <HUpnpAv/HItem>
 
26
 
 
27
namespace Herqq
 
28
{
 
29
 
 
30
namespace Upnp
 
31
{
 
32
 
 
33
namespace Av
 
34
{
 
35
 
 
36
class HAudioItemPrivate;
 
37
 
 
38
/*!
 
39
 * \brief This class represents content that is intended for listening.
 
40
 *
 
41
 * The class identifier specified by the AV Working Committee is
 
42
 * \c object.item.audioItem.
 
43
 *
 
44
 * \headerfile haudioitem.h HAudioItem
 
45
 *
 
46
 * \ingroup hupnp_av_cds_objects
 
47
 *
 
48
 * \remarks This class is not thread-safe.
 
49
 */
 
50
class H_UPNP_AV_EXPORT HAudioItem :
 
51
    public HItem
 
52
{
 
53
Q_OBJECT
 
54
H_DISABLE_COPY(HAudioItem)
 
55
H_DECLARE_PRIVATE(HAudioItem)
 
56
 
 
57
protected:
 
58
 
 
59
    /*!
 
60
     * Constructs a new instance.
 
61
     *
 
62
     * \param clazz specifies the UPnP class of the object. This cannot be empty.
 
63
     *
 
64
     * \param cdsType specifies the CDS type of the object. This cannot be
 
65
     * HObject::UndefinedCdsType.
 
66
     *
 
67
     * \sa isInitialized()
 
68
     */
 
69
    HAudioItem(const QString& clazz = sClass(), CdsType cdsType = sType());
 
70
    HAudioItem(HAudioItemPrivate&);
 
71
 
 
72
    // Documented in HClonable
 
73
    virtual HAudioItem* newInstance() const;
 
74
 
 
75
public:
 
76
 
 
77
    /*!
 
78
     * \brief Creates a new instance.
 
79
     *
 
80
     * \param title specifies the title of the object.
 
81
     *
 
82
     * \param parentId specifies the ID of the object that contains this
 
83
     * object. If the object has no parent, this has to be left empty.
 
84
     *
 
85
     * \param id specifies the ID of this object. If this is not specified,
 
86
     * a unique identifier within the running process is created for the object.
 
87
     *
 
88
     * \sa isValid()
 
89
     */
 
90
    HAudioItem(
 
91
        const QString& title,
 
92
        const QString& parentId,
 
93
        const QString& id = QString());
 
94
 
 
95
    /*!
 
96
     * \brief Destroys the instance.
 
97
     */
 
98
    virtual ~HAudioItem();
 
99
 
 
100
    /*!
 
101
     * \brief Returns the genres to which this item belongs.
 
102
     *
 
103
     * upnp:genre, ContentDirectory:3, Appendix B.4.1.
 
104
     *
 
105
     * \return The genres to which this item belongs.
 
106
     *
 
107
     * \sa setGenres()
 
108
     */
 
109
    QList<HGenre> genres() const;
 
110
 
 
111
    /*!
 
112
     * \brief Returns a brief description of the content item.
 
113
     *
 
114
     * dc:description, ContentDirectory:3, Appendix B.7.1.
 
115
     *
 
116
     * \return a brief description of the content item.
 
117
     *
 
118
     * \sa setDescription()
 
119
     */
 
120
    QString description() const;
 
121
 
 
122
    /*!
 
123
     * \brief Returns a few lines of description of the content item.
 
124
     *
 
125
     * upnp:longDescripion, ContentDirectory:3, Appendix B.7.2.
 
126
     *
 
127
     * \return a few lines of description of the content item.
 
128
     *
 
129
     * \sa setLongDescription()
 
130
     */
 
131
    QString longDescription() const;
 
132
 
 
133
    /*!
 
134
     * \brief Returns the publishers of this item.
 
135
     *
 
136
     * dc:publisher, ContentDirectory:3, Appendix B.3.6.
 
137
     *
 
138
     * \return The publishers of this item.
 
139
     *
 
140
     * \sa setPublishers()
 
141
     */
 
142
    QStringList publishers() const;
 
143
 
 
144
    /*!
 
145
     * \brief Returns the languages used in the content.
 
146
     *
 
147
     * dc:language, ContentDirectory:3, Appendix B.7.7.
 
148
     *
 
149
     * \return The languages used in the content.
 
150
     *
 
151
     * \sa setLanguages()
 
152
     */
 
153
    QStringList languages() const;
 
154
 
 
155
    /*!
 
156
     * \brief Returns the URLs of resources to which this object relates.
 
157
     *
 
158
     * dc:language, ContentDirectory:3, Appendix B.5.4.
 
159
     *
 
160
     * \return The URLs of resources to which this object relates.
 
161
     *
 
162
     * \sa setRelations()
 
163
     */
 
164
    QList<QUrl> relations() const;
 
165
 
 
166
    /*!
 
167
     * \brief Returns descriptive information of legal rights held in over this resource.
 
168
     *
 
169
     * dc:rights, ContentDirectory:3, Appendix B.7.5.
 
170
     *
 
171
     * \return descriptive information of legal rights held in over this resource.
 
172
     *
 
173
     * \sa setRights()
 
174
     */
 
175
    QStringList rights() const;
 
176
 
 
177
    /*!
 
178
     * \brief Specifies the genres to which this item belongs.
 
179
     *
 
180
     * \param arg specifies the genres to which this item belongs.
 
181
     *
 
182
     * \sa genres()
 
183
     */
 
184
    void setGenres(const QList<HGenre>& arg);
 
185
 
 
186
    /*!
 
187
     * \brief Specifies a brief description of the content item.
 
188
     *
 
189
     * \param arg specifies a brief description of the content item.
 
190
     *
 
191
     * \sa description()
 
192
     */
 
193
    void setDescription(const QString& arg);
 
194
 
 
195
    /*!
 
196
     * \brief Specifies a few lines of description of the content item.
 
197
     *
 
198
     * \param arg specifies a few lines of description of the content item.
 
199
     *
 
200
     * \sa longDescription()
 
201
     */
 
202
    void setLongDescription(const QString& arg);
 
203
 
 
204
    /*!
 
205
     * \brief Sets the publishers of this item.
 
206
     *
 
207
     * \param arg specifies the publishers of this item.
 
208
     *
 
209
     * \sa publishers()
 
210
     */
 
211
    void setPublishers(const QStringList& arg);
 
212
 
 
213
    /*!
 
214
     * \brief Specifies the languages used in the content.
 
215
     *
 
216
     * \param arg specifies the languages used in the content.
 
217
     *
 
218
     * \sa languages()
 
219
     */
 
220
    void setLanguages(const QStringList& arg);
 
221
 
 
222
    /*!
 
223
     * \brief Specifies the URLs of resources to which this object relates.
 
224
     *
 
225
     * \param arg specifies the URLs of resources to which this object relates.
 
226
     *
 
227
     * \sa relations()
 
228
     */
 
229
    void setRelations(const QList<QUrl>& arg);
 
230
 
 
231
    /*!
 
232
     * \brief Specifies descriptive information of legal rights held in over this
 
233
     * resource.
 
234
     *
 
235
     * \param arg specifies descriptive information of legal rights held in
 
236
     * over this resource.
 
237
     *
 
238
     * \sa rights()
 
239
     */
 
240
    void setRights(const QStringList& arg);
 
241
 
 
242
    /*!
 
243
     * \brief Returns the CdsType value of this class.
 
244
     *
 
245
     * \return The CdsType value of this class.
 
246
     */
 
247
    inline static CdsType sType() { return AudioItem; }
 
248
 
 
249
    /*!
 
250
     * \brief Returns the class identifier specified by the AV Working Committee.
 
251
     *
 
252
     * \return The class identifier specified by the AV Working Committee.
 
253
     */
 
254
    inline static QString sClass() { return "object.item.audioItem"; }
 
255
 
 
256
    /*!
 
257
     * Creates a new instance with no title or parentID.
 
258
     *
 
259
     * \return a pointer to the newly created instance.
 
260
     *
 
261
     * \remarks the ownership of the object is transferred to the caller. Make sure
 
262
     * to delete the object.
 
263
     */
 
264
    inline static HAudioItem* create() { return new HAudioItem(); }
 
265
};
 
266
 
 
267
}
 
268
}
 
269
}
 
270
 
 
271
#endif /* HAUDIOITEM_H_ */