Syndication::Atom::EntryDocument

Search for usage in LXR

Syndication::Atom::EntryDocument Class Reference

#include <document.h>

Inheritance diagram for Syndication::Atom::EntryDocument:

Public Member Functions

 EntryDocument ()
 
 EntryDocument (const QDomElement &element)
 
bool accept (DocumentVisitor *visitor) override
 
QString debugInfo () const override
 
Entry entry () const
 
bool isValid () const override
 
- Public Member Functions inherited from Syndication::SpecificDocument
virtual ~SpecificDocument ()
 

Detailed Description

An Atom 1.0 Entry Document, containing a single Atom entry outside of the context of a feed.

Author
Frank Osterfeld

Definition at line 186 of file atom/document.h.

Constructor & Destructor Documentation

◆ EntryDocument() [1/2]

Syndication::Atom::EntryDocument::EntryDocument ( )

default constructor, creates a null document, which is invalid.

See also
isValid()

Definition at line 265 of file atom/document.cpp.

◆ EntryDocument() [2/2]

Syndication::Atom::EntryDocument::EntryDocument ( const QDomElement & element)
explicit

creates an Atom Entry Document wrapping an atom:entry element.

Parameters
elementa DOM element, should be a atom:entry element (although not enforced), otherwise this object will not parse anything useful

Definition at line 270 of file atom/document.cpp.

Member Function Documentation

◆ accept()

bool Syndication::Atom::EntryDocument::accept ( DocumentVisitor * visitor)
overridevirtual

Used by visitors for double dispatch.

See DocumentVisitor for more information.

Parameters
visitorthe visitor calling the method

Implements Syndication::SpecificDocument.

Definition at line 275 of file atom/document.cpp.

◆ debugInfo()

QString Syndication::Atom::EntryDocument::debugInfo ( ) const
overridevirtual

returns a description of this entry document for debugging purposes.

Returns
debug string

Implements Syndication::SpecificDocument.

Definition at line 290 of file atom/document.cpp.

◆ entry()

Entry Syndication::Atom::EntryDocument::entry ( ) const

returns the single entry described in the source.

Returns
the entry

Definition at line 280 of file atom/document.cpp.

◆ isValid()

bool Syndication::Atom::EntryDocument::isValid ( ) const
overridevirtual

returns whether this document is valid or not.

Invalid documents do not contain any useful information.

Implements Syndication::SpecificDocument.

Definition at line 285 of file atom/document.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 Tue Mar 26 2024 11:14:15 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.