LeechCraft  0.6.70-3565-g2d86529
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
itexteditor.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 #include <QVariantMap>
37 
38 class QWidget;
39 class QString;
40 class QAction;
41 class QColor;
42 
43 namespace LeechCraft
44 {
47  enum class ContentType
48  {
52  HTML,
53 
56  PlainText
57  };
58 
66  enum class EditorAction
67  {
70  Find,
71 
74  Replace,
75 
78  Bold,
79 
82  Italic,
83 
86  Underline,
87 
90  InsertLink,
91 
95 
99  };
100 }
101 
118 class Q_DECL_EXPORT IEditorWidget
119 {
120 public:
121  virtual ~IEditorWidget () {}
122 
138  virtual QString GetContents (LeechCraft::ContentType type) const = 0;
139 
160  virtual void SetContents (QString contents, LeechCraft::ContentType type) = 0;
161 
170  virtual QAction* GetEditorAction (LeechCraft::EditorAction action) = 0;
171 
182  virtual void AppendAction (QAction *action) = 0;
183 
186  virtual void AppendSeparator () = 0;
187 
197  virtual void RemoveAction (QAction *action) = 0;
198 
210  virtual void SetBackgroundColor (const QColor& color, LeechCraft::ContentType editor) = 0;
211 protected:
217  virtual void textChanged () = 0;
218 };
219 
220 class QDomElement;
221 
240 class Q_DECL_EXPORT IAdvancedHTMLEditor
241 {
242 public:
243  virtual ~IAdvancedHTMLEditor () {}
244 
245  typedef QPair<QRegExp, QString> Replacement_t;
247 
250  struct CustomTag
251  {
254  QString TagName_;
255 
276  std::function<void (QDomElement&)> ToKnown_;
277 
308  std::function<bool (QDomElement&)> FromKnown_;
309  };
311 
319  virtual void InsertHTML (const QString& html) = 0;
320 
330  virtual void SetCustomTags (const CustomTags_t& tags) = 0;
331 
349  virtual QAction* AddInlineTagInserter (const QString& tagName, const QVariantMap& params) = 0;
350 
355  virtual void ExecJS (const QString& js) = 0;
356 };
357 
367 class Q_DECL_EXPORT ITextEditor
368 {
369 public:
370  virtual ~ITextEditor () {}
371 
381  virtual bool SupportsEditor (LeechCraft::ContentType type) const = 0;
382 
397  virtual QWidget* GetTextEditor (LeechCraft::ContentType type) = 0;
398 };
399 
400 Q_DECLARE_INTERFACE (IEditorWidget, "org.Deviant.LeechCraft.IEditorWidget/1.0");
401 Q_DECLARE_INTERFACE (IAdvancedHTMLEditor, "org.Deviant.LeechCraft.IAdvancedHTMLEditor/1.0");
402 Q_DECLARE_INTERFACE (ITextEditor, "org.Deviant.LeechCraft.ITextEditor/1.0");
std::function< bool(QDomElement &)> FromKnown_
The converter of an instance of the tag from HTML.
Definition: itexteditor.h:308
QPair< QRegExp, QString > Replacement_t
Definition: itexteditor.h:245
virtual ~IAdvancedHTMLEditor()
Definition: itexteditor.h:243
QList< Replacement_t > Replacements_t
Definition: itexteditor.h:246
Toggle underlining of the selected text's font.
Open "Find" dialog.
virtual ~ITextEditor()
Definition: itexteditor.h:370
Interface to be implemented by editor widgets returned from ITextEditor::GetTextEditor().
Definition: itexteditor.h:118
Q_DECLARE_INTERFACE(IEditorWidget,"org.Deviant.LeechCraft.IEditorWidget/1.0")
Open the dialog for inserting a hyperlink.
QString TagName_
The name of the custom tag, like lj.
Definition: itexteditor.h:254
QList< CustomTag > CustomTags_t
Definition: itexteditor.h:310
EditorAction
Enumeration for some standard editor actions.
Definition: itexteditor.h:66
Describes a single custom tag.
Definition: itexteditor.h:250
Toggle the italicness of the selected text's font.
Open "Replace" dialog.
Interface for plugins implementing a text editor component.
Definition: itexteditor.h:367
virtual ~IEditorWidget()
Definition: itexteditor.h:121
std::function< void(QDomElement &)> ToKnown_
The converter of an instance of the tag to HTML.
Definition: itexteditor.h:276
Toggle between WYSIWYG and source view, if applicable.
Interface for HTML/WYSIWYG editors with some advanced functionality.
Definition: itexteditor.h:240
Open the dialog for inserting an image.
Toggle the boldness of the selected text's font.