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

Syndication Library

  • syndication
item.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_ITEM_H
24#define SYNDICATION_ITEM_H
25
26#include <QtCore/QString>
27#include <boost/shared_ptr.hpp>
28
29#include "ksyndication_export.h"
30
31#include <ctime>
32
33class QDomElement;
34template <class T> class QList;
35template <class K, class T> class QMultiMap;
36
37namespace Syndication {
38
39//@cond PRIVATE
40class Category;
41typedef boost::shared_ptr<Category> CategoryPtr;
42class Enclosure;
43typedef boost::shared_ptr<Enclosure> EnclosurePtr;
44class Item;
45typedef boost::shared_ptr<Item> ItemPtr;
46class Person;
47typedef boost::shared_ptr<Person> PersonPtr;
48class SpecificItem;
49typedef boost::shared_ptr<SpecificItem> SpecificItemPtr;
50//@endcond
51
57class SYNDICATION_EXPORT Item
58{
59 public:
60
64 virtual ~Item();
65
66
73 virtual SpecificItemPtr specificItem() const = 0;
74
84 virtual QString title() const = 0;
85
93 virtual QString link() const = 0;
94
105 virtual QString description() const = 0;
106
118 virtual QString content() const = 0;
119
126 virtual time_t datePublished() const = 0;
127
135 virtual time_t dateUpdated() const = 0;
136
144 virtual QString id() const = 0;
145
153 virtual QList<PersonPtr> authors() const = 0;
154
160 virtual QString language() const = 0;
161
168 virtual QList<EnclosurePtr> enclosures() const = 0;
169
176 virtual QList<CategoryPtr> categories() const = 0;
177
184 virtual int commentsCount() const = 0;
185
192 virtual QString commentsLink() const = 0;
193
199 virtual QString commentsFeed() const = 0;
200
209 virtual QString commentPostUri() const = 0;
210
227 virtual QMultiMap<QString, QDomElement> additionalProperties() const = 0;
228
234 virtual QString debugInfo() const;
235};
236
237} // namespace Syndication
238
239#endif // SYNDICATION_ITEM_H
Syndication::Item
An item from a news feed.
Definition item.h:58
Syndication::Item::title
virtual QString title() const =0
The title of the item.
Syndication::Item::language
virtual QString language() const =0
returns the language used in the item's content
Syndication::Item::datePublished
virtual time_t datePublished() const =0
returns the date when the item was initially published.
Syndication::Item::description
virtual QString description() const =0
returns the description of the item.
Syndication::Item::commentsFeed
virtual QString commentsFeed() const =0
URL of feed syndicating comments belonging to this item.
Syndication::Item::additionalProperties
virtual QMultiMap< QString, QDomElement > additionalProperties() const =0
returns a list of item metadata not covered by this class.
Syndication::Item::commentsCount
virtual int commentsCount() const =0
The number of comments posted for this item.
Syndication::Item::authors
virtual QList< PersonPtr > authors() const =0
returns a list of persons who created the item content.
Syndication::Item::enclosures
virtual QList< EnclosurePtr > enclosures() const =0
returns a list of enclosures describing files available on the net.
Syndication::Item::link
virtual QString link() const =0
returns a link to the (web) resource described by this item.
Syndication::Item::categories
virtual QList< CategoryPtr > categories() const =0
returns a list of categories this item is filed in.
Syndication::Item::dateUpdated
virtual time_t dateUpdated() const =0
returns the date when the item was modified the last time.
Syndication::Item::commentPostUri
virtual QString commentPostUri() const =0
URI that can be used to post comments via an HTTP POST request using the Comment API.
Syndication::Item::specificItem
virtual SpecificItemPtr specificItem() const =0
returns the format-specific item this object abstracts from.
Syndication::Item::content
virtual QString content() const =0
returns the content of the item.
Syndication::Item::id
virtual QString id() const =0
returns an identifier that identifies the item within its feed.
Syndication::Item::commentsLink
virtual QString commentsLink() const =0
Link to an HTML site which contains the comments belonging to this item.
Syndication
TODO.
Definition abstractparser.cpp:25
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

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