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

syndication/rdf

  • syndication
  • rdf
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_RDF_DOCUMENT_H
24#define SYNDICATION_RDF_DOCUMENT_H
25
26#include <syndication/rdf/resourcewrapper.h>
27
28#include <syndication/specificdocument.h>
29
30template <class T> class QList;
31
32namespace Syndication {
33namespace RDF {
34
35class Document;
36class Model;
37class DublinCore;
38class Image;
39class Item;
40class SyndicationInfo;
41class TextInput;
42//@cond PRIVATE
43typedef boost::shared_ptr<Document> DocumentPtr;
44//@endcond
45
51class SYNDICATION_EXPORT Document : public Syndication::SpecificDocument, public ResourceWrapper
52{
53 friend class ::Syndication::RDF::Model;
54 public:
55
59 Document();
60
66 explicit Document(ResourcePtr resource);
67
73 Document(const Document& other);
74
78 virtual ~Document();
79
86 bool operator==(const Document& other) const;
87
93 Document& operator=(const Document& other);
94
100 virtual bool accept(DocumentVisitor* visitor);
101
107 bool isValid() const;
108
114 QString title() const;
115
121 QString description() const;
122
127 QString link() const;
128
132 DublinCore dc() const;
133
138 SyndicationInfo syn() const;
139
143 QList<Item> items() const;
144
148 Image image() const;
149
153 TextInput textInput() const;
154//@cond PRIVATE
162 void getItemTitleFormatInfo(bool* containsMarkup) const;
163
171 void getItemDescriptionFormatInfo(bool* containsMarkup) const;
172//@endcond PRIVATE
173
179 virtual QString debugInfo() const;
180
181 private:
182 class Private;
183 Private* const d;
184};
185
186} // namespace RDF
187} // namespace Syndication
188
189#endif // SYNDICATION_RDF_DOCUMENT_H
Syndication::RDF::Document
Document implementation for RDF, representing an RSS 1.0 feed.
Definition document.h:52
Syndication::RDF::Document::Document
Document()
creates a wrapper wrapping a null resource
Definition document.cpp:64
Syndication::RDF::Document::items
QList< Item > items() const
list of items contained in this feed
Definition document.cpp:175
Syndication::RDF::Document::description
QString description() const
A brief description of the channel's content, function, source, etc.
Definition document.cpp:122
Syndication::RDF::Document::isValid
bool isValid() const
returns whether this document is valid or not.
Definition document.cpp:110
Syndication::RDF::Document::debugInfo
virtual QString debugInfo() const
PRIVATE.
Definition document.cpp:285
Syndication::RDF::Document::dc
DublinCore dc() const
returns a dublin core description of the document.
Definition document.cpp:133
Syndication::RDF::Document::textInput
TextInput textInput() const
An optional text input element associated with the channel.
Definition document.cpp:212
Syndication::RDF::Document::link
QString link() const
The URL to which an HTML rendering of the channel title will link, commonly the parent site's home or...
Definition document.cpp:128
Syndication::RDF::Document::title
QString title() const
title of the feed (required)
Definition document.cpp:115
Syndication::RDF::Document::operator=
Document & operator=(const Document &other)
assigns another document
Definition document.cpp:96
Syndication::RDF::Document::operator==
bool operator==(const Document &other) const
compares two documents.
Definition document.cpp:90
Syndication::RDF::Document::accept
virtual bool accept(DocumentVisitor *visitor)
Used by visitors for double dispatch.
Definition document.cpp:105
Syndication::RDF::Document::image
Image image() const
An image to be associated with an HTML rendering of the channel.
Definition document.cpp:205
Syndication::RDF::Document::syn
SyndicationInfo syn() const
returns syndication information describing how often this feed is updated.
Definition document.cpp:138
Syndication::RDF::DublinCore
A resource wrapper providing convenient access to Dublin Core metadata.
Definition dublincore.h:49
Syndication::RDF::Image
An image to be associated with an HTML rendering of the channel.
Definition image.h:42
Syndication::RDF::Item
An RSS 1.0 item.
Definition item.h:49
Syndication::RDF::Model
An RDF model, a set of RDF statements.
Definition model.h:50
Syndication::RDF::ResourceWrapper::ResourceWrapper
ResourceWrapper()
creates a wrapper wrapping a null resource, isNull() will be true.
Definition resourcewrapper.cpp:38
Syndication::RDF::ResourceWrapper::resource
ResourcePtr resource() const
returns the wrapped resource.
Definition resourcewrapper.cpp:75
Syndication::RDF::SyndicationInfo
Wrapper to access syndication information for a feed.
Definition syndicationinfo.h:45
Syndication::RDF::TextInput
"The textinput element affords a method for submitting form data to an arbitrary URL - usually locate...
Definition textinput.h:39
Syndication::RDF
Syndication's parser for the RDF-based RSS 0.9 and RSS 1.0 formats.
Definition contentvocab.cpp:30
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/rdf

Skip menu "syndication/rdf"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • 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