elementwrapper.h

/*
 * This file is part of the syndication library
 *
 * Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */
#ifndef SYNDICATION_ELEMENTWRAPPER_H
#define SYNDICATION_ELEMENTWRAPPER_H

#include <QtCore/QString>

#include <boost/shared_ptr.hpp>

#include "ksyndication_export.h"

class QDomElement;
template <class T> class QList;

namespace Syndication {

class SYNDICATION_EXPORT ElementWrapper
{
    public:

        ElementWrapper();

        ElementWrapper(const ElementWrapper& other);

        ElementWrapper(const QDomElement& element); // implicit

        virtual ~ElementWrapper();

        ElementWrapper& operator=(const ElementWrapper& other);

        bool operator==(const ElementWrapper& other) const;

        const QDomElement& element() const;

        bool isNull() const;

        QString xmlBase() const;

        QString xmlLang() const;

        QString completeURI(const QString& uri) const;

        QString extractElementTextNS(const QString& namespaceURI,
                                     const QString& localName) const;

        QString extractElementText(const QString& tagName) const;

        QList<QDomElement> elementsByTagName(const QString& tagName) const;

        QString childNodesAsXML() const;

        static QString childNodesAsXML(const QDomElement& parent);

        QList<QDomElement> elementsByTagNameNS(const QString& nsURI,
                                               const QString& tagName) const;

        QDomElement firstElementByTagNameNS(const QString& nsURI,
                                            const QString& tagName) const;

        QString text() const;

        QString attribute(const QString& name,
                          const QString& defValue=QString()) const;

        QString attributeNS(const QString& nsURI, const QString& localName,
                            const QString& defValue=QString()) const;


        bool hasAttribute(const QString& name) const;

        bool hasAttributeNS(const QString& nsURI, const QString& localName) const;

    private:

        class ElementWrapperPrivate;
        boost::shared_ptr<ElementWrapperPrivate> d;
};

} // namespace Syndication

#endif // SYNDICATION_ELEMENTWRAPPER_H