Syndication::RDF::Item

Search for usage in LXR

Syndication::RDF::Item Class Reference

#include <item.h>

Inheritance diagram for Syndication::RDF::Item:

Public Member Functions

 Item ()
 
 Item (const Item &other)
 
 Item (ResourcePtr resource, DocumentPtr doc=DocumentPtr())
 
 ~Item () override
 
bool accept (SpecificItemVisitor *visitor) override
 
DublinCore dc () const
 
QString debugInfo () const
 
QString description () const
 
QString encodedContent () const
 
QString link () const
 
Itemoperator= (const Item &other)
 
bool operator== (const Item &other) 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
 
ResourceWrapperoperator= (const ResourceWrapper &other)
 
bool operator== (const ResourceWrapper &other) const
 
ResourcePtr resource () const
 
- Public Member Functions inherited from Syndication::SpecificItem
virtual ~SpecificItem ()
 

Detailed Description

An RSS 1.0 item.

(It is a convenience wrapper for the underlying RDF resource, which can be accessed via resource()).

Author
Frank Osterfeld

Definition at line 36 of file rdf/item.h.

Constructor & Destructor Documentation

◆ Item() [1/3]

Item::Item ( )

creates an item object wrapping a null resource, isNull() is true.

Definition at line 31 of file rdf/item.cpp.

◆ Item() [2/3]

Item::Item ( ResourcePtr resource,
DocumentPtr doc = DocumentPtr() )
explicit

Creates an item wrapping the given resource.

Parameters
resourceresource to wrap, should be of type of rss1:item, otherwise the wrapper will not return useful information.
docthe document this item is part of. Used by Document

Definition at line 37 of file rdf/item.cpp.

◆ Item() [3/3]

Item::Item ( const Item & other)

copies an item

Parameters
otheritem to copy

Definition at line 44 of file rdf/item.cpp.

◆ ~Item()

Item::~Item ( )
overridedefault

virtual destructor

Member Function Documentation

◆ accept()

bool Item::accept ( SpecificItemVisitor * visitor)
overridevirtual

interface for item visitors.

See SpecificItemVisitor for more information.

Parameters
visitora visitor visiting this object

Implements Syndication::SpecificItem.

Definition at line 127 of file rdf/item.cpp.

◆ dc()

DublinCore Item::dc ( ) const

returns a dublin core description of this item (including metadata such as item author or subject)

Definition at line 95 of file rdf/item.cpp.

◆ debugInfo()

QString Item::debugInfo ( ) const

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

Returns
debug string

Definition at line 115 of file rdf/item.cpp.

◆ description()

QString Item::description ( ) const

A brief description/abstract of the item.

if encodedContent() is not provided, this can also contain the full content.

Returns
description as HTML, or a null string if not specified

Definition at line 78 of file rdf/item.cpp.

◆ encodedContent()

QString Item::encodedContent ( ) const

returns content (content:encoded) as HTML.

Returns
content as HTML, or a null string if not specified

Definition at line 100 of file rdf/item.cpp.

◆ link()

QString Item::link ( ) const

The item's URL, usually pointing to a website containing the full content (news article, blog entry etc.).

Returns
the link

Definition at line 90 of file rdf/item.cpp.

◆ operator=()

Item & Item::operator= ( const Item & other)

assigns another item

Parameters
otherthe item to assign

Definition at line 54 of file rdf/item.cpp.

◆ operator==()

bool Item::operator== ( const Item & other) const

compares two item instances.

Two instances are equal, if the wrapped resources are equal. See ResourceWrapper::operator==() for details.

Parameters
otherthe item to compare this item to

Definition at line 61 of file rdf/item.cpp.

◆ title()

QString Item::title ( ) const

The item's title (required).

Returns
The item's title as HTML, or a null string if not specified

Definition at line 66 of file rdf/item.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:09:52 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.