| 1 | /* |
|---|
| 2 | This file is part of the syndication library |
|---|
| 3 | SPDX-FileCopyrightText: 2006 Frank Osterfeld <osterfeld@kde.org> |
|---|
| 4 | |
|---|
| 5 | SPDX-License-Identifier: LGPL-2.0-or-later |
|---|
| 6 | */ |
|---|
| 7 | |
|---|
| 8 | #ifndef SYNDICATION_ATOM_TOOLS_H |
|---|
| 9 | #define SYNDICATION_ATOM_TOOLS_H |
|---|
| 10 | |
|---|
| 11 | class QString; |
|---|
| 12 | |
|---|
| 13 | namespace Syndication |
|---|
| 14 | { |
|---|
| 15 | class ElementWrapper; |
|---|
| 16 | |
|---|
| 17 | namespace Atom |
|---|
| 18 | { |
|---|
| 19 | /*! |
|---|
| 20 | * \internal |
|---|
| 21 | * |
|---|
| 22 | * extracts the content of an atomTextConstruct. An atomTextConstruct is an element containing |
|---|
| 23 | * either plain text, escaped html, or embedded XHTML. |
|---|
| 24 | * |
|---|
| 25 | * TODO: examples |
|---|
| 26 | * |
|---|
| 27 | * \a parent the parent element to extract from. E.g. an atom:entry element. |
|---|
| 28 | * |
|---|
| 29 | * \a tagname the child element of parent to extract from the text from. |
|---|
| 30 | * |
|---|
| 31 | * Atom namespace is assumed. Example: <atom:title> |
|---|
| 32 | * |
|---|
| 33 | * Returns the HTMLized version of the element content. If the content is |
|---|
| 34 | * escaped HTML, the escaped markup is resolved. If it is XHTML, the XHTML |
|---|
| 35 | * content is converted to a string. If it is plain text, characters like "<", ">", "&" |
|---|
| 36 | * are escaped so the return string is valid HTML. |
|---|
| 37 | */ |
|---|
| 38 | QString (const Syndication::ElementWrapper &parent, const QString &tagname); |
|---|
| 39 | |
|---|
| 40 | } // namespace Atom |
|---|
| 41 | } // namespace Syndication |
|---|
| 42 | |
|---|
| 43 | #endif // SYNDICATION_ATOM_TOOLS_H |
|---|
| 44 | |
|---|
