LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
iadvancedhtmleditor.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <functional>
33 #include <QPair>
34 #include <QList>
35 #include <QRegExp>
36 
37 class QDomElement;
38 
57 class Q_DECL_EXPORT IAdvancedHTMLEditor
58 {
59 public:
60  virtual ~IAdvancedHTMLEditor () {}
61 
62  typedef QPair<QRegExp, QString> Replacement_t;
64 
67  struct CustomTag
68  {
71  QString TagName_;
72 
93  std::function<void (QDomElement&)> ToKnown_;
94 
125  std::function<bool (QDomElement&)> FromKnown_;
126  };
128 
136  virtual void InsertHTML (const QString& html) = 0;
137 
147  virtual void SetCustomTags (const CustomTags_t& tags) = 0;
148 
166  virtual QAction* AddInlineTagInserter (const QString& tagName, const QVariantMap& params) = 0;
167 
172  virtual void ExecJS (const QString& js) = 0;
173 };
174 
175 Q_DECLARE_INTERFACE (IAdvancedHTMLEditor, "org.Deviant.LeechCraft.IAdvancedHTMLEditor/1.0")
std::function< bool(QDomElement &)> FromKnown_
The converter of an instance of the tag from HTML.
QPair< QRegExp, QString > Replacement_t
QList< Replacement_t > Replacements_t
QString TagName_
The name of the custom tag, like lj.
QList< CustomTag > CustomTags_t
Describes a single custom tag.
std::function< void(QDomElement &)> ToKnown_
The converter of an instance of the tag to HTML.
Interface for HTML/WYSIWYG editors with some advanced functionality.