LeechCraft
%{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Modules
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
61
enum class
EditorAction
62
{
63
Find
,
64
Replace
,
65
Bold
,
66
Italic
,
67
Underline
,
68
InsertLink
,
69
InsertImage
,
70
ToggleView
71
};
72
}
73
90
class
Q_DECL_EXPORT
IEditorWidget
91
{
92
public
:
93
virtual
~IEditorWidget
() {}
94
110
virtual
QString GetContents (
LeechCraft::ContentType
type)
const
= 0;
111
132
virtual
void
SetContents (QString contents,
LeechCraft::ContentType
type) = 0;
133
142
virtual
QAction* GetEditorAction (
LeechCraft::EditorAction
action) = 0;
143
154
virtual
void
AppendAction (QAction *action) = 0;
155
156
virtual
void
AppendSeparator () = 0;
157
167
virtual
void
RemoveAction (QAction *action) = 0;
168
180
virtual
void
SetBackgroundColor (
const
QColor& color,
LeechCraft::ContentType
editor) = 0;
181
protected
:
187
virtual
void
textChanged () = 0;
188
};
189
190
class
QDomElement;
191
210
class
Q_DECL_EXPORT
IAdvancedHTMLEditor
211
{
212
public
:
213
virtual
~IAdvancedHTMLEditor
() {}
214
215
typedef
QPair<QRegExp, QString>
Replacement_t
;
216
typedef
QList<Replacement_t>
Replacements_t
;
217
220
struct
CustomTag
221
{
224
QString
TagName_
;
225
246
std::function<void (QDomElement&)>
ToKnown_
;
247
278
std::function<bool (QDomElement&)>
FromKnown_
;
279
};
280
typedef
QList<CustomTag>
CustomTags_t
;
281
289
virtual
void
InsertHTML (
const
QString& html) = 0;
290
300
virtual
void
SetCustomTags (
const
CustomTags_t& tags) = 0;
301
319
virtual
QAction* AddInlineTagInserter (
const
QString& tagName,
const
QVariantMap& params) = 0;
320
325
virtual
void
ExecJS (
const
QString& js) = 0;
326
};
327
337
class
Q_DECL_EXPORT
ITextEditor
338
{
339
public
:
340
virtual
~ITextEditor
() {}
341
351
virtual
bool
SupportsEditor (
LeechCraft::ContentType
type)
const
= 0;
352
367
virtual
QWidget* GetTextEditor (
LeechCraft::ContentType
type) = 0;
368
};
369
370
Q_DECLARE_INTERFACE
(
IEditorWidget
,
"org.Deviant.LeechCraft.IEditorWidget/1.0"
);
371
Q_DECLARE_INTERFACE
(
IAdvancedHTMLEditor
,
"org.Deviant.LeechCraft.IAdvancedHTMLEditor/1.0"
);
372
Q_DECLARE_INTERFACE
(
ITextEditor
,
"org.Deviant.LeechCraft.ITextEditor/1.0"
);
IAdvancedHTMLEditor::CustomTag::FromKnown_
std::function< bool(QDomElement &)> FromKnown_
The converter of an instance of the tag from HTML.
Definition:
itexteditor.h:278
IAdvancedHTMLEditor::Replacement_t
QPair< QRegExp, QString > Replacement_t
Definition:
itexteditor.h:215
QList
Definition:
ianrulesstorage.h:35
IAdvancedHTMLEditor::~IAdvancedHTMLEditor
virtual ~IAdvancedHTMLEditor()
Definition:
itexteditor.h:213
IAdvancedHTMLEditor::Replacements_t
QList< Replacement_t > Replacements_t
Definition:
itexteditor.h:216
LeechCraft::EditorAction::Underline
LeechCraft::EditorAction::Find
ITextEditor::~ITextEditor
virtual ~ITextEditor()
Definition:
itexteditor.h:340
IEditorWidget
Interface to be implemented by editor widgets returned from ITextEditor::GetTextEditor().
Definition:
itexteditor.h:90
Q_DECLARE_INTERFACE
Q_DECLARE_INTERFACE(IEditorWidget,"org.Deviant.LeechCraft.IEditorWidget/1.0")
LeechCraft
Definition:
constants.h:35
LeechCraft::EditorAction::InsertLink
LeechCraft::ContentType::PlainText
IAdvancedHTMLEditor::CustomTag::TagName_
QString TagName_
The name of the custom tag, like lj.
Definition:
itexteditor.h:224
IAdvancedHTMLEditor::CustomTags_t
QList< CustomTag > CustomTags_t
Definition:
itexteditor.h:280
LeechCraft::EditorAction
EditorAction
Definition:
itexteditor.h:61
IAdvancedHTMLEditor::CustomTag
Describes a single custom tag.
Definition:
itexteditor.h:220
LeechCraft::EditorAction::Italic
LeechCraft::ContentType::HTML
LeechCraft::EditorAction::Replace
ITextEditor
Interface for plugins implementing a text editor component.
Definition:
itexteditor.h:337
IEditorWidget::~IEditorWidget
virtual ~IEditorWidget()
Definition:
itexteditor.h:93
IAdvancedHTMLEditor::CustomTag::ToKnown_
std::function< void(QDomElement &)> ToKnown_
The converter of an instance of the tag to HTML.
Definition:
itexteditor.h:246
LeechCraft::EditorAction::ToggleView
IAdvancedHTMLEditor
Interface for HTML/WYSIWYG editors with some advanced functionality.
Definition:
itexteditor.h:210
LeechCraft::EditorAction::InsertImage
LeechCraft::EditorAction::Bold
LeechCraft::ContentType
ContentType
Definition:
itexteditor.h:47
src
interfaces
itexteditor.h
Generated by
1.8.8