Syndication::Atom::Content

#include <content.h>

Inheritance diagram for Syndication::Atom::Content:

Public Types

enum  Format { PlainText, EscapedHTML, XML, Binary }
 

Public Member Functions

 Content ()
 
 Content (const QDomElement &element)
 
 Content (const Content &other)
 
 ~Content ()
 
QByteArray asByteArray () const
 
QString asString () const
 
QString debugInfo () const
 
Format format () const
 
bool isBinary () const
 
bool isContained () const
 
bool isEscapedHTML () const
 
bool isPlainText () const
 
bool isXML () const
 
Contentoperator= (const Content &other)
 
QString src () const
 
QString type () const
 
- Public Member Functions inherited from Syndication::ElementWrapper
 ElementWrapper ()
 
 ElementWrapper (const ElementWrapper &other)
 
 ElementWrapper (const QDomElement &element)
 
virtual ~ElementWrapper ()
 
QString attribute (const QString &name, const QString &defValue=QString()) const
 
QString attributeNS (const QString &nsURI, const QString &localName, const QString &defValue=QString()) const
 
QString childNodesAsXML () const
 
QString completeURI (const QString &uri) const
 
const QDomElementelement () const
 
QList< QDomElementelementsByTagName (const QString &tagName) const
 
QList< QDomElementelementsByTagNameNS (const QString &nsURI, const QString &tagName) const
 
QString extractElementText (const QString &tagName) const
 
QString extractElementTextNS (const QString &namespaceURI, const QString &localName) const
 
QDomElement firstElementByTagNameNS (const QString &nsURI, const QString &tagName) const
 
bool hasAttribute (const QString &name) const
 
bool hasAttributeNS (const QString &nsURI, const QString &localName) const
 
bool isNull () const
 
ElementWrapperoperator= (const ElementWrapper &other)
 
bool operator== (const ElementWrapper &other) const
 
QString text () const
 
QString xmlBase () const
 
QString xmlLang () const
 

Static Public Member Functions

static Format mapTypeToFormat (const QString &type, const QString &src=QString())
 
- Static Public Member Functions inherited from Syndication::ElementWrapper
static QString childNodesAsXML (const QDomElement &parent)
 

Detailed Description

The content element either contains or links the content of an entry.

The content is usually plain text or HTML, but arbitrary XML or binary content are also possible. If isContained() is false, the content is not contained in the feed source, but linked.

Author
Frank Osterfeld

Definition at line 31 of file content.h.

Member Enumeration Documentation

format of the content.

Enumerator
PlainText 

the content is plain text (i.e.

"<", ">" etc. are text, not markup

EscapedHTML 

the content is escaped HTML, (i.e., "<", ">" etc.

are markup)

XML 

the content is embedded XML

Binary 

the content is base64-encoded binary content

Definition at line 38 of file content.h.

Constructor & Destructor Documentation

Syndication::Atom::Content::Content ( )

creates a null content object.

Definition at line 32 of file content.cpp.

Syndication::Atom::Content::Content ( const QDomElement element)
explicit

creates a Content object wrapping an atom:content element.

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

Definition at line 36 of file content.cpp.

Syndication::Atom::Content::Content ( const Content other)

creates a copy of another Content object

Parameters
otherthe content object to copy

Definition at line 40 of file content.cpp.

Syndication::Atom::Content::~Content ( )

destructor

Definition at line 44 of file content.cpp.

Member Function Documentation

QByteArray Syndication::Atom::Content::asByteArray ( ) const

returns binary content as byte array.

Returns
byte array containing the embedded binary data, or an empty array if the content is not in binary format

Definition at line 65 of file content.cpp.

QString Syndication::Atom::Content::asString ( ) const

returns the content as string.

If the content format is Text, the returned string contains the text as HTML. If the content is embedded XML, the XML is returned as string.

Returns
a string representation of the content, or a null string if the content is either binary content or not contained but linked (see isContained())

Definition at line 152 of file content.cpp.

QString Syndication::Atom::Content::debugInfo ( ) const

returns a description of the content object for debugging purposes

Returns
debug string

Definition at line 167 of file content.cpp.

Content::Format Syndication::Atom::Content::format ( ) const

returns the content format

Definition at line 118 of file content.cpp.

bool Syndication::Atom::Content::isBinary ( ) const

returns whether the content is binary content or not.

Use asByteArray() to access it.

Definition at line 127 of file content.cpp.

bool Syndication::Atom::Content::isContained ( ) const

returns whether the content is contained in the feed source, or not.

If it is not contained, src() provides a URL to the content.

Definition at line 132 of file content.cpp.

bool Syndication::Atom::Content::isEscapedHTML ( ) const

returns whether the content is escaped HTML or not Use asString() to access it

Definition at line 142 of file content.cpp.

bool Syndication::Atom::Content::isPlainText ( ) const

returns whether the content is plain text or not.

Use asString() to access it.

Definition at line 137 of file content.cpp.

bool Syndication::Atom::Content::isXML ( ) const

returns whether the content is embedded XML.

Use element() to access the DOM tree, or asString() to get the XML as string.

Definition at line 147 of file content.cpp.

Content::Format Syndication::Atom::Content::mapTypeToFormat ( const QString type,
const QString src = QString() 
)
static

maps a mimetype to Format enum according to the Atom 1.0 specification

Parameters
typea valid mimetype, or one of "text", "html", "xhtml"
srccontent source, see src() for details.

Definition at line 73 of file content.cpp.

Content & Syndication::Atom::Content::operator= ( const Content other)

assigns another content objecct

Parameters
otherthe Content object to assign

Definition at line 48 of file content.cpp.

QString Syndication::Atom::Content::src ( ) const

If src() is set, the content of this entry is not contained in the feed source, but available on the net.

src() then contains a URL (more precise: IRI reference) linking to remote content. If src is provided, type() should contain a mimetype, instead of "text", "html" or "xhtml".

Returns
a null string if the content is contained in the feed source, or a URL linking to the remote content

Definition at line 60 of file content.cpp.

QString Syndication::Atom::Content::type ( ) const

the type of the content.

This is either "text" (plain text), "html" (escaped HTML), "xhtml" (embedded XHTML) or a mime type

Returns
the content type. If no type is specified, "text" (the default) is returned.

Definition at line 55 of file content.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Jan 19 2021 23:05:17 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.