← Back to branch summary

~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/hmovie.h

  • Committer: Package Import Robot
  • Author(s): Mark Purcell
  • Date: 2012-09-27 21:41:30 UTC
  • mfrom: (1.2.43)
  • mto: This revision was merged to the branch mainline in revision 86.
  • Revision ID: package-import@ubuntu.com-20120927214130-i8v3ufr21nesp29i
Tags: 4:3.0.0~beta1a-1
http://bugs.debian.org/688142
* New upstream release

* Fix "wrongly conflicts phonon-backend-vlc" dropped (Closes: #688142)
* debian/watch include download.kde.org

* digikam 3.0.0 uses features from unreleased kdegraphics >=4.10 & ships 
a private version of the kdegraphics libs - this is not the Debian way :-(
* Unsatisfactory Conflicts: libkipi8, libkexiv2-10, libkdcraw20, libksane0
* Suspend digikam-dbg >130Mb

Show diffs side-by-side

added added

removed removed

Lines of Context:
extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/hmovie.h
 
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 HMOVIE_H_
 
23
#define HMOVIE_H_
 
24
 
 
25
#include <HUpnpAv/HVideoItem>
 
26
 
 
27
namespace Herqq
 
28
{
 
29
 
 
30
namespace Upnp
 
31
{
 
32
 
 
33
namespace Av
 
34
{
 
35
 
 
36
class HMoviePrivate;
 
37
 
 
38
/*!
 
39
 * \brief This class represents content that is a movie.
 
40
 *
 
41
 * The class identifier specified by the AV Working Committee is
 
42
 * \c object.item.videoItem.movie .
 
43
 *
 
44
 * \headerfile hmove.h HMovie
 
45
 *
 
46
 * \ingroup hupnp_av_cds_objects
 
47
 *
 
48
 * \remarks This class is not thread-safe.
 
49
 */
 
50
class H_UPNP_AV_EXPORT HMovie :
 
51
    public HVideoItem
 
52
{
 
53
Q_OBJECT
 
54
H_DISABLE_COPY(HMovie)
 
55
H_DECLARE_PRIVATE(HMovie)
 
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
    HMovie(const QString& clazz = sClass(), CdsType cdsType = sType());
 
70
    HMovie(HMoviePrivate&);
 
71
 
 
72
    // Documented in HClonable
 
73
    virtual HMovie* 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
    HMovie(
 
91
        const QString& title,
 
92
        const QString& parentId,
 
93
        const QString& id = QString());
 
94
 
 
95
    /*!
 
96
     * \brief Destroys the instance.
 
97
     */
 
98
    virtual ~HMovie();
 
99
 
 
100
    /*!
 
101
     * \brief Indicates the type of storage medium used for the content.
 
102
     *
 
103
     * upnp:storageMedium, ContentDirectory:3, Appendix B.6.5.
 
104
     *
 
105
     * \return The type of storage medium used for the content.
 
106
     *
 
107
     * \sa setStorageMedium()
 
108
     */
 
109
    HStorageMedium storageMedium() const;
 
110
 
 
111
    /*!
 
112
     * \brief Returns the DVD region code.
 
113
     *
 
114
     * upnp:DVDRegionCode, ContentDirectory:3, Appendix B.14.1.
 
115
     *
 
116
     * \return The DVD region code.
 
117
     *
 
118
     * \sa setDvdRegionCode()
 
119
     */
 
120
    qint32 dvdRegionCode() const;
 
121
 
 
122
    /*!
 
123
     * \brief Returns the user-friendly name of the associated broadcast channel.
 
124
     *
 
125
     * upnp:channelName, ContentDirectory:3, Appendix B.11.2.
 
126
     *
 
127
     * \return The user-friendly name of the associated broadcast channel.
 
128
     *
 
129
     * \sa setChannelName()
 
130
     */
 
131
    QString channelName() const;
 
132
 
 
133
    /*!
 
134
     * \brief Returns the start time of a scheduled program.
 
135
     *
 
136
     * \return The start time of a scheduled program.
 
137
     *
 
138
     * \sa setScheduledStartTime()
 
139
     */
 
140
    HScheduledTime scheduledStartTime() const;
 
141
 
 
142
    /*!
 
143
     * \brief Returns the end time of a scheduled program.
 
144
     *
 
145
     * \return The end time of a scheduled program.
 
146
     *
 
147
     * \sa setScheduledEndTime()
 
148
     */
 
149
    HScheduledTime scheduledEndTime() const;
 
150
 
 
151
    /*!
 
152
     * \brief Indicates the scheduled duration of the movie.
 
153
     *
 
154
     * upnp:scheduledDuration, ContentDirectory:3, Appendix B.11.5.
 
155
     *
 
156
     * \return The scheduled duration of the movie.
 
157
     *
 
158
     * \sa setScheduledDuration()
 
159
     */
 
160
    HContentDuration scheduledDuration() const;
 
161
 
 
162
    /*!
 
163
     * \brief Returns the name of the program.
 
164
     *
 
165
     * upnp:programTitle, ContentDirectory:3, Appendix B.8.2.
 
166
     *
 
167
     * \return The name of the program.
 
168
     *
 
169
     * \sa setProgramTitle()
 
170
     */
 
171
    QString programTitle() const;
 
172
 
 
173
    /*!
 
174
     * \brief Returns the name of the series.
 
175
     *
 
176
     * upnp:seriesTitle, ContentDirectory:3, Appendix B.8.2.
 
177
     *
 
178
     * \return The name of the series.
 
179
     *
 
180
     * \sa setSeriesTitle()
 
181
     */
 
182
    QString seriesTitle() const;
 
183
 
 
184
    /*!
 
185
     * \brief Returns the total number of episodes in the series to which this content
 
186
     * belongs.
 
187
     *
 
188
     * upnp:episodeCount, ContentDiretory:3, Appendix B.8.6.
 
189
     *
 
190
     * \return The total number of episodes in the series to which this content
 
191
     * belongs.
 
192
     *
 
193
     * \sa setEpisodeCount()
 
194
     */
 
195
    quint32 episodeCount() const;
 
196
 
 
197
    /*!
 
198
     * \brief Returns the episode number within the series to which this content
 
199
     * belongs.
 
200
     *
 
201
     * upnp:episodeNumber, ContentDirectory:3, Appendix B.8.7.
 
202
     *
 
203
     * \return The episode number within the series to which this content
 
204
     * belongs.
 
205
     *
 
206
     * \sa setEpisodeNumber()
 
207
     */
 
208
    quint32 episodeNumber() const;
 
209
 
 
210
    /*!
 
211
     * \brief Specifies the type of storage medium used for the content.
 
212
     *
 
213
     * \param arg specifies the type of storage medium used for the content.
 
214
     *
 
215
     * \sa storageMedium()
 
216
     */
 
217
    void setStorageMedium(const HStorageMedium& arg);
 
218
 
 
219
    /*!
 
220
     * \brief Specifies the DVD region code.
 
221
     *
 
222
     * \param arg specifies DVD region code.
 
223
     *
 
224
     * \sa dvdRegionCode()
 
225
     */
 
226
    void setDvdRegionCode(qint32 arg);
 
227
 
 
228
    /*!
 
229
     * \brief Specifies the the user-friendly name of the associated broadcast channel.
 
230
     *
 
231
     * \param arg specifies the user-friendly name of the associated broadcast channel.
 
232
     *
 
233
     * \sa channelName()
 
234
     */
 
235
    void setChannelName(const QString& arg);
 
236
 
 
237
    /*!
 
238
     * \brief Specifies the the start time of a scheduled program.
 
239
     *
 
240
     * \param arg specifies the start time of a scheduled program.
 
241
     *
 
242
     * \sa scheduledStartTime()
 
243
     */
 
244
    void setScheduledStartTime(const HScheduledTime& arg);
 
245
 
 
246
    /*!
 
247
     * \brief Specifies the the end time of a scheduled program.
 
248
     *
 
249
     * \param arg specifies the end time of a scheduled program.
 
250
     *
 
251
     * \sa scheduledEndTime()
 
252
     */
 
253
    void setScheduledEndTime(const HScheduledTime& arg);
 
254
 
 
255
    /*!
 
256
     * \brief Specifies the scheduled duration of the movie.
 
257
     *
 
258
     * \param arg specifies the scheduled duration of the movie.
 
259
     *
 
260
     * \sa scheduledDuration()
 
261
     */
 
262
    void setScheduledDuration(const HContentDuration& arg);
 
263
 
 
264
    /*!
 
265
     * \brief Specifies the name of the program.
 
266
     *
 
267
     * \param arg specifies the name of the program.
 
268
     *
 
269
     * \sa programTitle()
 
270
     */
 
271
    void setProgramTitle(const QString& arg);
 
272
 
 
273
    /*!
 
274
     * \brief Specifies the the name of the series.
 
275
     *
 
276
     * \param arg specifies the name of the series.
 
277
     *
 
278
     * \sa seriesTitle()
 
279
     */
 
280
    void setSeriesTitle(const QString& arg);
 
281
 
 
282
    /*!
 
283
     * \brief Specifies the the total number of episodes in the series to which this content
 
284
     * belongs.
 
285
     *
 
286
     * \param arg specifies the total number of episodes in the series to which this content
 
287
     * belongs.
 
288
     *
 
289
     * \sa episodeCount()
 
290
     */
 
291
    void setEpisodeCount(quint32 arg);
 
292
 
 
293
    /*!
 
294
     * \brief Specifies the the episode number within the series to which this content
 
295
     * belongs.
 
296
     *
 
297
     * \param arg specifies the episode number within the series to which this content
 
298
     * belongs.
 
299
     *
 
300
     * \sa episodeNumber()
 
301
     */
 
302
    void setEpisodeNumber(quint32 arg);
 
303
 
 
304
    /*!
 
305
     * \brief Returns the CdsType value of this class.
 
306
     *
 
307
     * \return The CdsType value of this class.
 
308
     */
 
309
    inline static CdsType sType() { return Movie; }
 
310
 
 
311
    /*!
 
312
     * \brief Returns the class identifier specified by the AV Working Committee.
 
313
     *
 
314
     * \return The class identifier specified by the AV Working Committee.
 
315
     */
 
316
    inline static QString sClass() { return "object.item.videoItem.movie"; }
 
317
 
 
318
    /*!
 
319
     * Creates a new instance with no title or parentID.
 
320
     *
 
321
     * \return a pointer to the newly created instance.
 
322
     *
 
323
     * \remarks the ownership of the object is transferred to the caller. Make sure
 
324
     * to delete the object.
 
325
     */
 
326
    inline static HMovie* create() { return new HMovie(); }
 
327
};
 
328
 
 
329
}
 
330
}
 
331
}
 
332
 
 
333
#endif /* HMOVIE_H_ */