• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

syndication/atom

  • syndication
  • atom
document.h
1/*
2 * This file is part of the syndication library
3 *
4 * Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public License
17 * along with this library; see the file COPYING.LIB. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 *
21 */
22
23#ifndef SYNDICATION_ATOM_DOCUMENT_H
24#define SYNDICATION_ATOM_DOCUMENT_H
25
26#include <syndication/specificdocument.h>
27#include <syndication/elementwrapper.h>
28
29#include <ctime>
30
31template <class T> class QList;
32
33namespace Syndication {
34
35class DocumentVisitor;
36
37namespace Atom {
38
39class Category;
40class Entry;
41class EntryDocument;
42class FeedDocument;
43class Generator;
44class Link;
45class Person;
46//@cond PRIVATE
47typedef boost::shared_ptr<EntryDocument> EntryDocumentPtr;
48typedef boost::shared_ptr<FeedDocument> FeedDocumentPtr;
49//@endcond
50
57class SYNDICATION_EXPORT FeedDocument : public Syndication::SpecificDocument, public ElementWrapper
58{
59 public:
60
66 FeedDocument();
67
74 explicit FeedDocument(const QDomElement& element);
75
81 bool accept(DocumentVisitor* visitor);
82
88 QList<Person> authors() const;
89
93 QList<Person> contributors() const;
94
98 QList<Category> categories() const;
99
105 QString icon() const;
106
112 QString logo() const;
113
121 QString id() const;
122
129 QString rights() const;
130
136 QString title() const;
137
144 QString subtitle() const;
145
153 Generator generator() const;
154
160 time_t updated() const;
161
166 QList<Link> links() const;
167
171 QList<Entry> entries() const;
172
173
178 QList<QDomElement> unhandledElements() const;
179
186 QString debugInfo() const;
187
193 bool isValid() const;
194};
195
202class SYNDICATION_EXPORT EntryDocument : public Syndication::SpecificDocument, public Syndication::ElementWrapper
203{
204 public:
205
210 EntryDocument();
211
218 explicit EntryDocument(const QDomElement& element);
219
225 bool accept(DocumentVisitor* visitor);
226
232 Entry entry() const;
233
240 QString debugInfo() const;
241
247 bool isValid() const;
248};
249
250} // namespace Atom
251} // namespace Syndication
252
253#endif // SYNDICATION_ATOM_DOCUMENT_H
Syndication::Atom::Category
A category for categorizing items or whole feeds.
Definition category.h:46
Syndication::Atom::EntryDocument
An Atom 1.0 Entry Document, containing a single Atom entry outside of the context of a feed.
Definition document.h:203
Syndication::Atom::EntryDocument::EntryDocument
EntryDocument()
default constructor, creates a null document, which is invalid.
Definition document.cpp:299
Syndication::Atom::EntryDocument::isValid
bool isValid() const
returns whether this document is valid or not.
Definition document.cpp:318
Syndication::Atom::EntryDocument::entry
Entry entry() const
returns the single entry described in the source.
Definition document.cpp:312
Syndication::Atom::EntryDocument::accept
bool accept(DocumentVisitor *visitor)
Used by visitors for double dispatch.
Definition document.cpp:307
Syndication::Atom::EntryDocument::debugInfo
QString debugInfo() const
returns a description of this entry document for debugging purposes.
Definition document.cpp:323
Syndication::Atom::Entry
an Atom entry, equivalent to the "items" in the RSS world.
Definition entry.h:54
Syndication::Atom::FeedDocument
An Atom 1.0 Feed Document, containing metadata describing the feed and a number of entries.
Definition document.h:58
Syndication::Atom::FeedDocument::updated
time_t updated() const
The datetime of the last modification of the feed content.
Definition document.cpp:153
Syndication::Atom::FeedDocument::subtitle
QString subtitle() const
description or subtitle of the feed (optional).
Definition document.cpp:148
Syndication::Atom::FeedDocument::logo
QString logo() const
URL of an image serving as a feed logo (optional)
Definition document.cpp:125
Syndication::Atom::FeedDocument::unhandledElements
QList< QDomElement > unhandledElements() const
returns all child elements of this feed not covered by this class.
Definition document.cpp:201
Syndication::Atom::FeedDocument::links
QList< Link > links() const
a list of links.
Definition document.cpp:160
Syndication::Atom::FeedDocument::rights
QString rights() const
copyright information (optional)
Definition document.cpp:137
Syndication::Atom::FeedDocument::debugInfo
QString debugInfo() const
returns a description of this feed document for debugging purposes.
Definition document.cpp:240
Syndication::Atom::FeedDocument::categories
QList< Category > categories() const
a list of categories this feed is assigned to (optional)
Definition document.cpp:93
Syndication::Atom::FeedDocument::entries
QList< Entry > entries() const
a list of the entries (items) in this feed.
Definition document.cpp:179
Syndication::Atom::FeedDocument::contributors
QList< Person > contributors() const
a list of persons who contribute to this feed.
Definition document.cpp:74
Syndication::Atom::FeedDocument::icon
QString icon() const
URL of an image serving as a feed icon (optional)
Definition document.cpp:118
Syndication::Atom::FeedDocument::FeedDocument
FeedDocument()
default constructor, creates a null feed, which is invalid.
Definition document.cpp:42
Syndication::Atom::FeedDocument::authors
QList< Person > authors() const
a list of persons who are the authors of this feed.
Definition document.cpp:55
Syndication::Atom::FeedDocument::accept
bool accept(DocumentVisitor *visitor)
Used by visitors for double dispatch.
Definition document.cpp:50
Syndication::Atom::FeedDocument::title
QString title() const
feed title (required).
Definition document.cpp:143
Syndication::Atom::FeedDocument::generator
Generator generator() const
description of the agent used to generate the feed.
Definition document.cpp:112
Syndication::Atom::FeedDocument::id
QString id() const
a string that unambigously identifies the feed (required)
Definition document.cpp:131
Syndication::Atom::FeedDocument::isValid
bool isValid() const
returns whether this document is valid or not.
Definition document.cpp:235
Syndication::Atom::Generator
Description of the agent used to generate the feed.
Definition generator.h:40
Syndication::Atom::Link
A link, pointing to webpages, media files on the web ("podcast"), related content,...
Definition link.h:40
Syndication::Atom::Person
describes a person, with name and optional URI and e-mail address.
Definition person.h:41
Syndication::Atom
Atom parser and model classes, representing Atom 1.0 documents (Atom 0.3 documents are converted by t...
Definition atom.h:43
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

syndication/atom

Skip menu "syndication/atom"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Members
  • File List

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal