1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/* This file is part of the KDE project
* SPDX-FileCopyrightText: 2007 Thomas Zander <zander@kde.org>
*
* SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KOTEXTEDITINGPLUGIN_H
#define KOTEXTEDITINGPLUGIN_H
#include "kotext_export.h"
#include <QHash>
#include <QObject>
class QAction;
class QTextDocument;
class QTextCursor;
class QString;
/**
* This is a base class for a text editing plugin as used by the text tool.
* When the user types text into the text shape text editing plugins will be notified of
* changes in the text document. The plugin is meant to be for altering or checking text as the user
* types it,
* To ensure a good user experience this plugin will only be called when it makes sense from
* a users perspective.
* The finishedWord() method will be called when the user makes at least one change to
* a word and then moves the cursor out of the word, a similar approach happens with the
* finishedParagraph(), it will only be called after the cursor has been moved out of the paragraph.
*/
class KOTEXT_EXPORT KoTextEditingPlugin : public QObject
{
Q_OBJECT
public:
/// constructor
KoTextEditingPlugin();
~KoTextEditingPlugin() override;
/**
* This method will be called when the user makes at least one change to
* a word and then moves the cursor out of the word.
* You are free to alter the word via the textDocument. Be aware that operations should be done
* via a QTextCursor and should retain any formatting already present on the text.
* @param document the text document that was altered.
* @param cursorPosition the last altered position in the word.
*/
virtual void finishedWord(QTextDocument *document, int cursorPosition) = 0;
/**
* This method will be called when the user makes at least one change to
* a paragraph and then moves the cursor out of the paragraph.
* You are free to alter the paragraph via the textDocument. Be aware that operations should be done
* via a QTextCursor and should retain any formatting already present on the text.
* Note that finishedWord() is always called just prior to the call to this method.
* @param document the text document that was altered.
* @param cursorPosition the last altered position in the paragraph.
*/
virtual void finishedParagraph(QTextDocument *document, int cursorPosition) = 0;
/**
* This method will be called just before the user makes at simple manual change to
* the text. Such as inserting a single character.
* This is for information only. You should not make any corrections to the text at this point
* @param document the text document that was altered.
* @param cursorPosition the last altered position in the paragraph.
*/
virtual void startingSimpleEdit(QTextDocument *document, int cursorPosition) = 0;
/**
* This method will be called when the user selects a portion of text and selects this plugin
* to handle it.
* You are free to alter the text via the textDocument. Be aware that operations should be done
* via a QTextCursor and should retain any formatting already present on the text.
* @param document the text document that was altered.
* @param startPosition the position at the start of the selection
* @param endPosition the position at the end of the selection
*/
virtual void checkSection(QTextDocument *document, int startPosition, int endPosition);
/**
* This method will be called when the user makes at least one change to the document.
* You are free to alter the text via the textDocument. Be aware that operations should be done
* via a QTextCursor and should retain any formatting already present on the text.
* @param document the text document that was altered.
* @param cursorPosition the last altered position in the document.
* @return New cursor postion
*/
virtual int characterInserted(QTextDocument *document, int cursorPosition)
{
Q_UNUSED(document)
return cursorPosition;
}
/// can be called when this plugin needs the current position of the textcursor
virtual void setCurrentCursorPosition(QTextDocument *document, int cursorPosition);
/**
* Retrieves the entire collection of actions for the plugin
*/
QHash<QString, QAction *> actions() const;
Q_SIGNALS:
/// emitted when a series of commands is started that together need to become 1 undo action.
void startMacro(const QString &name);
/// emitted when a series of commands has ended that together should be 1 undo action.
void stopMacro();
protected:
/**
* Helper method that allows you to easily get the word out of the document.
* This method will create a selection on the parameter cursor where the altered word
* is selected.
* Example usage:
* @code
QTextCursor cursor(document);
selectWord(cursor, cursorPosition);
QString word = cursor.selectedText();
* @endcode
* @param cursor the cursor to alter.
* @param cursorPosition the position of the cursor somewhere in the word.
*/
void selectWord(QTextCursor &cursor, int cursorPosition) const;
/**
* Helper method that allows you to easily get the text of the paragraph which
* holds the cursor position.
* Please realize that altering of the paragraph text should be done on a
* QTextCursor and not by altering the returned string. Doing so would loose
* all text formatting of the paragraph.
* @param document the document.
* @param cursorPosition the position of the cursor somewhere in the word.
*/
QString paragraph(QTextDocument *document, int cursorPosition) const;
/**
* Add an action under the given name to the action collection.
*
* @param name The name by which the action be retrieved again from the collection.
* @param action The action to add.
*/
void addAction(const QString &name, QAction *action);
private:
class Private;
Private *const d;
};
#endif
|
