/usr/include/syndication/rss2/item.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | /*
* This file is part of the syndication library
*
* Copyright (C) 2005 Frank Osterfeld <osterfeld@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef SYNDICATION_RSS2_ITEM_H
#define SYNDICATION_RSS2_ITEM_H
#include <syndication/rss2/document.h>
#include <syndication/elementwrapper.h>
#include <boost/shared_ptr.hpp>
#include <syndication/specificitem.h>
#include <ctime>
class QDomElement;
class QString;
template <class T> class QList;
namespace Syndication {
class SpecificItemVisitor;
namespace RSS2 {
class Category;
class Enclosure;
class Source;
/**
* An Item, representing an entry in an RSS feed.
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT Item : public ElementWrapper, public Syndication::SpecificItem
{
public:
/**
* Default constructor, creates a null object, for which isNull() is
* @c true.
*/
explicit Item(boost::shared_ptr<Document> doc=boost::shared_ptr<Document>());
/**
* Creates an Item object wrapping an @c <item> XML element.
*
* @param element The @c <item> element to wrap
* @param doc the document this item is part of
*/
explicit Item(const QDomElement& element, boost::shared_ptr<Document> doc=boost::shared_ptr<Document>());
/**
* creates a copy of an item. As the d pointer is shared,
* this is a cheap operation.
*
* @param other the item to copy
*/
Item(const Item& other);
/**
* destructor
*/
~Item();
/**
* assigns another item. As the d pointer is shared,
* this is a cheap operation.
*
* @param other the item to assign
*/
Item& operator=(const Item& other);
/**
* Used by visitors for double dispatch. See SpecificItemVisitor
* for more information.
* @param visitor the visitor calling the method
*/
bool accept(SpecificItemVisitor* visitor);
/**
* The title of the item.
*
* @return The title in plain text. Note that e.g. characters like <,
* >, & are not escaped!
* (TODO: this might change, check what makes more sense)
*/
QString title() const;
/**
* The URL of the item. This usually links to the web representation
* of the item, e.g. the full news article.
*
* @return an URL, or a null string if not set
*/
QString link() const;
/**
* The item synopsis. This might contain a short summary of the
* item, but also the full content. If content() is set, that usually
* contains the full content instead.
*
* @return a string in HTML format (whitespace is irrelevant,
* @c <br/> is used for newlines, "&", "<", ">" are escaped)
* summarizing the item. A null string if no description was specified.
*/
QString description() const;
/**
* Returns the actual content of the item. In RSS2, this can be stored
* in various elements, e.g. in content:encoded, xhtml:body or
* xhtml:div. If this is not set, description() might also contain the
* content of the item.
*
* @return the content in HTML format (whitespace is irrelevant,
* <br/> is used for newlines, "&", "<", ">" are escaped)
* If no content is specified, a null string is returned.
*/
QString content() const;
/**
* Set of categories this item is included in.
*
* @return a list of categories, possibly empty.
*/
QList<Category> categories() const;
/**
* URL of a page for comments relating to the item.
*
* @return an URL to the comments, or a null string if not set
*/
QString comments() const;
/**
* The email address of the author of this item. For newspapers and
* magazines syndicating via RSS, the author is the person who wrote
* the article that this item describes. For collaborative weblogs, the
* author of the item might be different from the managing editor or
* webmaster.
* This method returns the content of the @c <author> element. If
* @c <author> is not available, the method returns
* @c <dc:creator> instead, if available.
*
* @return an email address of the author, or a null string if not
* specified
*/
QString author() const;
/**
* Descriptions of media objects that are attached to the item.
* Note that the RSS2 spec is a bit unclear about whether an item can
* have multiple enclosures or not. Originally it was not intended, but
* in reality, some tools out there specify multiple enclosures.
* So most of the time, this list be either empty or contains a
* single item, but don't take that for granted
*/
QList<Enclosure> enclosures() const;
/**
* "guid stands for globally unique identifier. It's a string that
* uniquely identifies the item. When present, an aggregator may choose
* to use this string to determine if an item is new.
* There are no rules for the syntax of a guid. Aggregators must view
* them as a string. It's up to the source of the feed to establish the
* uniqueness of the string."
*
* @return a guid string, or a null string if none specified in the
* feed
*/
QString guid() const;
/**
* If @c true, it can be assumed that the guid is a permalink to the
* item, that is, a url that can be opened in a Web browser, that
* points to the full item.
*
* @return @c true if the guid is a permalink and can be interpreted as
* URL
*/
bool guidIsPermaLink() const;
/**
* Indicates when the item was published. If it's a date in the future,
* you may choose to not display the item until that date.
* This returns the content of the @c <pubDate> element. If @c
* <pubDate> is not available, the method returns
* @c <dc:date> instead, if available.
*
* @return the publication date, or 0 if no date was specified or
* parsing failed
*/
time_t pubDate() const;
/**
* expiration date, specifying a date when the item is not longer
* available.
* Only available in RSS 0.93.
*
* @return the expiration date, or 0 if no date was specified or
* parsing failed
*/
time_t expirationDate() const;
/**
* A Platform for Internet Content Selection (PICS) rating tag.
* More information on the format of the rating tag can be found here:
* http://www.w3.org/PICS/
*
* @return PICS rating information, or a null string if not specified
*/
QString rating() const;
/**
* The RSS channel that the item came from. See Source class for more
* information.
*
* @return a Source object, or a null object (see Source.isNull()) if
* not set.
*/
Source source() const;
/**
* returns all child elements of this item not covered by this class.
* You can use this to access additional metadata from RSS extensions.
*/
QList<QDomElement> unhandledElements() const;
/**
* Returns a description of the object and its children for debugging
* purposes.
*
* @return debug string
*/
QString debugInfo() const;
//@cond PRIVATE
/**
* @internal
* returns the description content in unmodified form (no
* plaintext/HTML conversions etc.)
*/
QString originalDescription() const;
/**
* @internal
* returns the title content in unmodified form (no
* plaintext/HTML conversions etc.)
*/
QString originalTitle() const;
//@endcond
private:
class ItemPrivate;
boost::shared_ptr<ItemPrivate> d;
};
} // namespace RSS2
} // namespace Syndication
#endif // SYNDICATION_RSS2_ITEM_H
|