itexteditor.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/

#pragma once

#include <QVariantMap>

class QWidget;
class QString;
class QAction;
class QColor;

namespace LeechCraft
{
    enum class ContentType
    {
        HTML,

        PlainText
    };

    enum class EditorAction
    {
        Find,

        Replace,

        Bold,

        Italic,

        Underline,

        InsertLink,

        InsertImage,

        ToggleView
    };
}

class Q_DECL_EXPORT IEditorWidget
{
public:
    virtual ~IEditorWidget () {}

    virtual QString GetContents (LeechCraft::ContentType type) const = 0;

    virtual void SetContents (QString contents, LeechCraft::ContentType type) = 0;

    virtual QAction* GetEditorAction (LeechCraft::EditorAction action) = 0;

    virtual void AppendAction (QAction *action) = 0;

    virtual void AppendSeparator () = 0;

    virtual void RemoveAction (QAction *action) = 0;

    virtual void SetBackgroundColor (const QColor& color, LeechCraft::ContentType editor) = 0;

    virtual QWidget* GetWidget () = 0;

    virtual QObject* GetQObject () = 0;
protected:
    virtual void textChanged () = 0;
};

class Q_DECL_EXPORT ITextEditor
{
public:
    virtual ~ITextEditor () {}

    virtual bool SupportsEditor (LeechCraft::ContentType type) const = 0;

    virtual QWidget* GetTextEditor (LeechCraft::ContentType type) = 0;
};

Q_DECLARE_INTERFACE (IEditorWidget, "org.Deviant.LeechCraft.IEditorWidget/1.0")
Q_DECLARE_INTERFACE (ITextEditor, "org.Deviant.LeechCraft.ITextEditor/1.0")