/usr/include/syndication/rss2/document.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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | /*
* 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_DOCUMENT_H
#define SYNDICATION_RSS2_DOCUMENT_H
#include <syndication/specificdocument.h>
#include <syndication/elementwrapper.h>
#include <ctime>
class QDomDocument;
class QDomElement;
class QString;
template <class T> class QList;
template <class T> class QSet;
namespace Syndication {
namespace RSS2 {
class Category;
class Cloud;
class Document;
class Image;
class Item;
class TextInput;
typedef boost::shared_ptr<Document> DocumentPtr;
/**
* document implementation, representing an RSS feed from the 0.91-0.94/2.0
* family.
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT Document : public Syndication::SpecificDocument,
public Syndication::ElementWrapper
{
public:
/**
* Parses an RSS2 document from an XML document.
* TODO: More on supported formats etc.
*
* @param document The dom document to parse the document from
* @return the document parsed from XML, or an invalid
* document if parsing failed.
*/
static Document fromXML(const QDomDocument& document);
/**
* Default constructor, creates a null object, for which
* isNull() is @c true and isValid() is @c false.
*/
Document();
/**
* copy constructor
*/
Document(const Document& other);
/**
* destructor
*/
virtual ~Document();
/**
* assigns another document. As the d pointer is shared,
* this is a cheap operation.
*
* @param other the document to assign
*/
Document& operator=(const Document& other);
/**
* Used by visitors for double dispatch. See DocumentVisitor
* for more information.
* @param visitor the visitor calling the method
*/
virtual bool accept(DocumentVisitor* visitor);
/**
* returns whether this document is valid or not.
* Invalid documents do not contain any useful
* information.
*/
bool isValid() const;
/**
* The title of the channel.
*
* @return title TODO: more on escaping/HTML
*/
QString title() const;
/**
* The URL to the HTML website corresponding to the channel.
*
* @return TODO
*/
QString link() const;
/**
* Phrase or sentence describing the channel.
*
* @return TODO
*/
QString description() const;
/**
* the items contained in this document
*/
QList<Item> items() const;
/**
*
* @return TODO
*/
QString language() const;
/**
*
* Copyright notice for content in the channel.
* This method returns the content of the @c <copyright>
* element. If @c <copyright> is not available, the method returns
* @c <dc:rights> instead, if available.
*
* @return copyright information, or a null string if not set
*/
QString copyright() const;
/**
* Email address for person responsible for editorial content.
*
* @return editor's email address, or a null string if not set
*/
QString managingEditor() const;
/**
* Email address for person responsible for technical issues relating
* to channel.
*
* @return web master's email address, or a null string if not
*/
QString webMaster() const;
/**
* The publication date for the content in the channel. For example,
* the New York Times publishes on a daily basis, the publication date
* flips once every 24 hours. That's when the pubDate of the channel
* changes.
* This method 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;
/**
* The last time the content of the channel changed.
*
* @return the last build date, or 0 if no date was specified or parsing
* failed
*/
time_t lastBuildDate() const;
/**
* Specifies one or more categories that the channel belongs to.
*
* @return TODO
*/
QList<Category> categories() const;
/**
* A string indicating the program used to generate the channel.
*
* @return description of the generator program, or a null string if
* not set
*/
QString generator() const;
/**
* A URL that points to the documentation for the format used in the
* RSS file. It's probably a pointer to the RSS specification.
* It's for people who might stumble across an RSS file on a Web server
* 25 years from now and wonder what it is.
*
* @return URL pointing to the format specification, or a null string if
* not set
*/
QString docs() const;
/**
* Allows processes to register with a cloud to be notified of updates
* to the channel, implementing a lightweight publish-subscribe
* protocol for RSS feeds.
*
* @return cloud information, or a null object if not set
*/
Cloud cloud() const;
/**
* ttl stands for time to live. It's a number of minutes that indicates
* how long a channel can be cached before refreshing from the source.
*
* @return the "time to live" in minutes, or 0 if not set
*/
int ttl() const;
/**
* Specifies a GIF, JPEG or PNG image that can be displayed with the
* channel.
*
* @return the image, or a null object if not set
*/
Image image() const;
/**
* Specifies a text input box that can be displayed with the channel.
*
* @return the text input, or a null object if not set
*/
TextInput textInput() const;
/**
* Contains a set of hours (from 0 to 23), time in GMT, when the
* channel is not updated.
*/
QSet<int> skipHours() const;
/** days of week, used for skip days */
enum DayOfWeek
{
Monday = 0, /**< self-explanatory */
Tuesday = 1, /**< self-explanatory */
Wednesday = 2, /**< self-explanatory */
Thursday = 3, /**< self-explanatory */
Friday = 4, /**< self-explanatory */
Saturday = 5, /**< self-explanatory */
Sunday = 6 /**< self-explanatory */
};
/**
* A set of week days where aggregators shouldn't read the channel.
*
*/
QSet<DayOfWeek> skipDays() const;
/**
* returns all child elements of this document 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
* checks the format of title elements and returns the results
* @param isCDATA whether the titles are encapsulated in CDATA
* @param containsMarkup whether the heuristic found HTML markup in
* titles
*/
void getItemTitleFormatInfo(bool* isCDATA, bool* containsMarkup) const;
/**
* @internal
* checks the format of title elements and returns the results
* @param isCDATA whether the descriptions are encapsulated in CDATA
* @param containsMarkup whether the heuristic found HTML markup in
* descriptions
*/
void getItemDescriptionFormatInfo(bool* isCDATA, bool* containsMarkup) const;
//@endcond
private:
/**
* @internal
* private constructor, used by fromXML()
* TODO: remove fromXML(), make this one private
*/
explicit Document(const QDomElement& element);
class DocumentPrivate;
boost::shared_ptr<DocumentPrivate> d;
};
} // namespace RSS2
} // namespace Syndication
#endif // SYNDICATION_RSS2_DOCUMENT_H
|