~vanvugt/ubuntu/oneiric/mediatomb/fix-770964-784431

« back to all changes in this revision

Viewing changes to src/weborama_content_handler.h

  • Committer: Bazaar Package Importer
  • Author(s): Andres Mejia
  • Date: 2009-04-22 21:39:19 UTC
  • mto: (4.2.1 sid)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: james.westby@ubuntu.com-20090422213919-52m015y6gcpv1m1g
Tags: upstream-0.12.0~svn2018
ImportĀ upstreamĀ versionĀ 0.12.0~svn2018

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*MT*
 
2
    
 
3
    MediaTomb - http://www.mediatomb.cc/
 
4
    
 
5
    weborama_content_handler.h - this file is part of MediaTomb.
 
6
    
 
7
    Copyright (C) 2005 Gena Batyan <bgeradz@mediatomb.cc>,
 
8
                       Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>
 
9
    
 
10
    Copyright (C) 2006-2009 Gena Batyan <bgeradz@mediatomb.cc>,
 
11
                            Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>,
 
12
                            Leonhard Wimmer <leo@mediatomb.cc>
 
13
    
 
14
    MediaTomb is free software; you can redistribute it and/or modify
 
15
    it under the terms of the GNU General Public License version 2
 
16
    as published by the Free Software Foundation.
 
17
    
 
18
    MediaTomb is distributed in the hope that it will be useful,
 
19
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
20
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
21
    GNU General Public License for more details.
 
22
    
 
23
    You should have received a copy of the GNU General Public License
 
24
    version 2 along with MediaTomb; if not, write to the Free Software
 
25
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 
26
    
 
27
    $Id$
 
28
*/
 
29
 
 
30
/// \file weborama_content_handler.h
 
31
/// \brief Definitions of the WeboramaContentHandler class.
 
32
 
 
33
#ifdef WEBORAMA
 
34
 
 
35
#ifndef __WEBORAMA_CONTENT_HANDLER_H__
 
36
#define __WEBORAMA_CONTENT_HANDLER_H__
 
37
 
 
38
#define WEBORAMA_SERVICE                     "Weborama"
 
39
#define WEBORAMA_SERVICE_ID                  "W"
 
40
 
 
41
#define WEBORAMA_AUXDATA_REQUEST_NAME       WEBORAMA_SERVICE_ID "0"
 
42
 
 
43
#include "zmmf/zmmf.h"
 
44
#include "mxml/mxml.h"
 
45
#include "cds_objects.h"
 
46
 
 
47
/// \brief this class is responsible for creating objects from the Weborama
 
48
/// metadata XML.
 
49
class WeboramaContentHandler : public zmm::Object
 
50
{
 
51
public:
 
52
    /// \brief Sets the service XML from which we will extract the objects.
 
53
    /// \return false if service XML contained an error status.
 
54
    bool setServiceContent(zmm::Ref<mxml::Element> service);
 
55
 
 
56
    /// \brief retrieves an object from the service.
 
57
    ///
 
58
    /// Each invokation of this funtion will return a new object,
 
59
    /// when the whole service XML is parsed and no more objects are left,
 
60
    /// this function will return nil.
 
61
    ///
 
62
    /// \return CdsObject or nil if there are no more objects to parse.
 
63
    zmm::Ref<CdsObject> getNextObject();
 
64
 
 
65
protected:
 
66
    zmm::Ref<mxml::Element> service_xml;
 
67
    int current_track_index;
 
68
    int track_count;
 
69
    zmm::String mood;
 
70
};
 
71
 
 
72
#endif//__WEBORAMA_CONTENT_HANDLER_H__
 
73
 
 
74
#endif//WEBORAMA