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

syndication/rdf

  • Syndication
  • RDF
  • Document
Public Member Functions | List of all members
Syndication::RDF::Document Class Reference

#include <document.h>

Inheritance diagram for Syndication::RDF::Document:
Inheritance graph
[legend]

Public Member Functions

 Document ()
 
 Document (ResourcePtr resource)
 
 Document (const Document &other)
 
virtual ~Document ()
 
virtual bool accept (DocumentVisitor *visitor)
 
DublinCore dc () const
 
virtual QString debugInfo () const
 
QString description () const
 
Image image () const
 
bool isValid () const
 
QList< Item > items () const
 
QString link () const
 
Document & operator= (const Document &other)
 
bool operator== (const Document &other) const
 
SyndicationInfo syn () const
 
TextInput textInput () const
 
QString title () const
 
- Public Member Functions inherited from Syndication::RDF::ResourceWrapper
 ResourceWrapper ()
 
 ResourceWrapper (const ResourceWrapper &other)
 
 ResourceWrapper (ResourcePtr resource)
 
virtual ~ResourceWrapper ()
 
bool isNull () const
 
ResourceWrapper & operator= (const ResourceWrapper &other)
 
bool operator== (const ResourceWrapper &other) const
 
ResourcePtr resource () const
 

Detailed Description

Document implementation for RDF, representing an RSS 1.0 feed.

Author
Frank Osterfeld

Definition at line 51 of file document.h.

Constructor & Destructor Documentation

Syndication::RDF::Document::Document ( )

creates a wrapper wrapping a null resource

Definition at line 64 of file document.cpp.

Syndication::RDF::Document::Document ( ResourcePtr  resource)
explicit

creates a document by wrapping a channel resource

Parameters
resourcethe channel resource to wrap

Definition at line 71 of file document.cpp.

Syndication::RDF::Document::Document ( const Document &  other)

creates a copy of another document

Parameters
otherthe document to copy

Definition at line 78 of file document.cpp.

Syndication::RDF::Document::~Document ( )
virtual

destructor

Definition at line 84 of file document.cpp.

Member Function Documentation

bool Syndication::RDF::Document::accept ( DocumentVisitor *  visitor)
virtual

Used by visitors for double dispatch.

See DocumentVisitor for more information.

Parameters
visitorthe visitor calling the method

Definition at line 105 of file document.cpp.

DublinCore Syndication::RDF::Document::dc ( ) const

returns a dublin core description of the document.

Definition at line 133 of file document.cpp.

QString Syndication::RDF::Document::debugInfo ( ) const
virtual

PRIVATE.

/** Returns a description of the document for debugging purposes.

Returns
debug string

Definition at line 285 of file document.cpp.

QString Syndication::RDF::Document::description ( ) const

A brief description of the channel's content, function, source, etc.

Returns
TODO: define format etc.

Definition at line 122 of file document.cpp.

Image Syndication::RDF::Document::image ( ) const

An image to be associated with an HTML rendering of the channel.

Definition at line 205 of file document.cpp.

bool Syndication::RDF::Document::isValid ( ) const

returns whether this document is valid or not.

Invalid documents do not contain any useful information.

Definition at line 110 of file document.cpp.

QList< Item > Syndication::RDF::Document::items ( ) const

list of items contained in this feed

Definition at line 175 of file document.cpp.

QString Syndication::RDF::Document::link ( ) const

The URL to which an HTML rendering of the channel title will link, commonly the parent site's home or news page.

Definition at line 128 of file document.cpp.

Document & Syndication::RDF::Document::operator= ( const Document &  other)

assigns another document

Parameters
otherthe document to assign

Definition at line 96 of file document.cpp.

bool Syndication::RDF::Document::operator== ( const Document &  other) const

compares two documents.

Two documents are equal if they wrap the same resource. See ResourceWrapper::operator==()

Parameters
otherthe document to compare to

Definition at line 90 of file document.cpp.

SyndicationInfo Syndication::RDF::Document::syn ( ) const

returns syndication information describing how often this feed is updated.

Definition at line 138 of file document.cpp.

TextInput Syndication::RDF::Document::textInput ( ) const

An optional text input element associated with the channel.

Definition at line 212 of file document.cpp.

QString Syndication::RDF::Document::title ( ) const

title of the feed (required)

Returns
feed title as TODO: define format

Definition at line 115 of file document.cpp.


The documentation for this class was generated from the following files:
  • document.h
  • document.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:37:38 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs 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

Search



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