2 * Copyright (C) 2013 HERE Global B.V. All rights reserved.
3 * This software, including documentation, is protected by copyright controlled by
4 * HERE Global B.V. (“Software”). All rights are reserved. Copying, including reproducing,
5 * storing, adapting or translating, any or all of this material requires the prior
6 * written consent of HERE Global B.V. You may use this
7 * Software in accordance with the terms and conditions defined in the
8 * HERE Location Platform Services Terms and Conditions, available at
9 * http://developer.here.com/terms-conditions-base
11 * As an additional permission to the above, you may distribute Software,
12 * in object code format as part of an Application, according to, and subject to, terms and
13 * conditions defined in the Tizen Software Development kit (“SDK”) License Agreement.
14 * You may distribute such object code format Application under terms of your choice,
15 * provided that the header and source files of the Software have not been modified.
18 #ifndef EDITORIAL_CONTENT_H_
19 #define EDITORIAL_CONTENT_H_
23 #include "common/HereMaps_global.h"
24 #include "finder/BaseContent.h"
26 HERE_MAPS_BEGIN_NAMESPACE
28 class EditorialContent;
31 * This typedef defines a list of editorial content items as a type.
33 typedef std::vector<EditorialContent> EditorialContentList;
36 * This class encapsulates editorial content relating to a place.
40 class EXPORT_API EditorialContent : public BaseContent
45 * This is the default constructor.
50 * This method is the copy constructor.
52 * @param rRhs An object whose contents are to be copied to the instance
55 EditorialContent(const EditorialContent& rRhs);
58 * This method is a (virtual) destructor.
60 virtual ~EditorialContent();
63 * This is the assignment operator.
65 * @param rRhs An object whose contents are to be copied to the given
68 * @return A reference to the given instance of the class after its contents
71 EditorialContent& operator=(const EditorialContent& rRhs);
74 * This method retrieves the description (the contents of an editorial
77 * @return A string containing the description.
79 String GetDescription() const;
82 * This method retrieves the identifier of the language of the editorial
83 * item. The identifier is a string containing a BCP 47 language code (see
84 * also http://tools.ietf.org/html/rfc5646).
86 * @return A string containing the language identifier.
88 String GetLanguage() const;
91 * This method sets the description (the contents of an editorial
94 * @param sText A constant reference to a string containing the description.
96 void SetDescription(const String& sText);
99 * This method retrieves the identifier of the language of the editorial
100 * item. The identifier is a string containing a BCP 47 language code (see
101 * also http://tools.ietf.org/html/rfc5646).
103 * @param rLanguage A constant reference to a string containing the language
106 void SetLanguage(const String& rLanguage);
109 class EditorialContentImpl;
110 EditorialContentImpl* m_pImpl;
112 friend class JsonParser;
115 HERE_MAPS_END_NAMESPACE
117 #endif // EDITORIAL_CONTENT_H_