htmlextension.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2010 David Faure <faure@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 KPARTS_HTMLEXTENSION_H
#define KPARTS_HTMLEXTENSION_H

#include <QtCore/QSharedDataPointer>
#include <QtCore/QObject>

#include <kparts/kparts_export.h>

class KUrl;

namespace KParts
{

class ReadOnlyPart;
class HtmlExtensionPrivate;
class SelectorInterfacePrivate;

class KPARTS_EXPORT HtmlExtension : public QObject
{
    Q_OBJECT
public:
    HtmlExtension(KParts::ReadOnlyPart* parent);
    ~HtmlExtension();

    static HtmlExtension *childObject( QObject *obj );

    virtual KUrl baseUrl() const = 0;

    virtual bool hasSelection() const;

private:
    // for future extensions
    HtmlExtensionPrivate* const d;
};

class KPARTS_EXPORT SelectorInterface
{
public:
    class ElementPrivate;
    class Element;

    enum QueryMethod {
        None = 0x00,                   
        EntireContent = 0x01,          
        SelectedContent = 0x02         
    };
    Q_DECLARE_FLAGS(QueryMethods, QueryMethod)

    
    virtual ~SelectorInterface() {}

    virtual QueryMethods supportedQueryMethods() const;

    virtual Element querySelector(const QString& query, QueryMethod method) const = 0;

    virtual QList<Element> querySelectorAll(const QString& query, QueryMethod method) const = 0;

    class KPARTS_EXPORT Element {
    public:
        Element();

        Element(const Element& other);

        ~Element();

        bool isNull() const;

        void setTagName(const QString& tag);

        QString tagName() const;

        void setAttribute(const QString& name, const QString& value);

        QStringList attributeNames() const;

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

        bool hasAttribute(const QString& name) const;

        // No namespace support yet, could be added with attributeNS, setAttributeNS

        void swap( Element& other ) {
            d.swap( other.d );
        }

        Element& operator=(const Element& other) {
            if ( this != &other ) {
                Element copy( other );
                swap( copy );
            }
            return *this;
        }

    private:
        QSharedDataPointer<ElementPrivate> d;
    };
};

class KPARTS_EXPORT HtmlSettingsInterface
{
public:
    enum HtmlSettingsType {
        AutoLoadImages,
        DnsPrefetchEnabled,
        JavaEnabled,
        JavascriptEnabled,
        MetaRefreshEnabled,
        PluginsEnabled,
        PrivateBrowsingEnabled,
        OfflineStorageDatabaseEnabled,
        OfflineWebApplicationCacheEnabled,
        LocalStorageEnabled,
        UserDefinedStyleSheetURL
    };

    enum JavaScriptAdvice {
        JavaScriptDunno=0,
        JavaScriptAccept,
        JavaScriptReject
    };

    enum JSWindowOpenPolicy {
        JSWindowOpenAllow=0,
        JSWindowOpenAsk,
        JSWindowOpenDeny,
        JSWindowOpenSmart
    };

    enum JSWindowStatusPolicy {
        JSWindowStatusAllow=0,
        JSWindowStatusIgnore
    };

    enum JSWindowMovePolicy {
        JSWindowMoveAllow=0,
        JSWindowMoveIgnore
    };

    enum JSWindowResizePolicy {
        JSWindowResizeAllow=0,
        JSWindowResizeIgnore
    };

    enum JSWindowFocusPolicy {
        JSWindowFocusAllow=0,
        JSWindowFocusIgnore
    };

    virtual ~HtmlSettingsInterface() {}

    virtual QVariant htmlSettingsProperty(HtmlSettingsType type) const = 0;

    virtual bool setHtmlSettingsProperty(HtmlSettingsType type, const QVariant& value) = 0;

    static JavaScriptAdvice textToJavascriptAdvice(const QString& text);

    static const char* javascriptAdviceToText(JavaScriptAdvice advice);

    static void splitDomainAdvice(const QString& text,
                                  QString& domain,
                                  JavaScriptAdvice& javaAdvice,
                                  JavaScriptAdvice& javaScriptAdvice);
};

} // namespace KParts

inline void qSwap( KParts::SelectorInterface::Element & lhs, KParts::SelectorInterface::Element & rhs )
{
    lhs.swap( rhs );
}

Q_DECLARE_OPERATORS_FOR_FLAGS(KParts::SelectorInterface::QueryMethods)

Q_DECLARE_TYPEINFO(KParts::SelectorInterface::Element, Q_MOVABLE_TYPE);

Q_DECLARE_INTERFACE(KParts::SelectorInterface,
                    "org.kde.KParts.SelectorInterface")
Q_DECLARE_INTERFACE(KParts::HtmlSettingsInterface,
                    "org.kde.KParts.HtmlSettingsInterface")


#endif /* KPARTS_HTMLEXTENSION_H */