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
146
147
148
149
150
151
152
153
154
155
156
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef ITEXTEDITOR_H
#define ITEXTEDITOR_H
#include "texteditor_global.h"
#include "itextmark.h"
#include <coreplugin/textdocument.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <QMap>
#include <QIcon>
QT_BEGIN_NAMESPACE
class QIcon;
class QMenu;
class QPainter;
class QPoint;
class QRect;
class QTextBlock;
QT_END_NAMESPACE
namespace Utils { class CommentDefinition; }
namespace TextEditor {
class TEXTEDITOR_EXPORT BlockRange
{
public:
BlockRange() : _first(0), _last(-1) {}
BlockRange(int firstPosition, int lastPosition)
: _first(firstPosition), _last(lastPosition)
{}
inline bool isNull() const { return _last < _first; }
int first() const { return _first; }
int last() const { return _last; }
private:
int _first;
int _last;
};
class TEXTEDITOR_EXPORT ITextEditorDocument : public Core::TextDocument
{
Q_OBJECT
public:
explicit ITextEditorDocument(QObject *parent = 0);
virtual QString plainText() const = 0;
virtual QString textAt(int pos, int length) const = 0;
virtual QChar characterAt(int pos) const = 0;
virtual ITextMarkable *markableInterface() const = 0;
static QMap<QString, QString> openedTextDocumentContents();
static QMap<QString, QTextCodec *> openedTextDocumentEncodings();
signals:
void contentsChanged();
};
class TEXTEDITOR_EXPORT ITextEditor : public Core::IEditor
{
Q_OBJECT
public:
enum PositionOperation {
Current = 1,
EndOfLine = 2,
StartOfLine = 3,
Anchor = 4,
EndOfDoc = 5
};
ITextEditor() {}
virtual ITextEditorDocument *textDocument();
/*! Returns the position at \a posOp in characters from the beginning of the document */
virtual int position(PositionOperation posOp = Current, int at = -1) const = 0;
/*! Converts the \a pos in characters from beginning of document to \a line and \a column */
virtual void convertPosition(int pos, int *line, int *column) const = 0;
/*! Returns the cursor rectangle in pixels at \a pos, or current position if \a pos = -1 */
virtual QRect cursorRect(int pos = -1) const = 0;
/*! Returns the amount of visible columns (in characters) in the editor */
virtual int columnCount() const = 0;
/*! Returns the amount of visible lines (in characters) in the editor */
virtual int rowCount() const = 0;
virtual QString selectedText() const = 0;
/*! Removes \a length characters to the right of the cursor. */
virtual void remove(int length) = 0;
/*! Inserts the given string to the right of the cursor. */
virtual void insert(const QString &string) = 0;
/*! Replaces \a length characters to the right of the cursor with the given string. */
virtual void replace(int length, const QString &string) = 0;
/*! Sets current cursor position to \a pos. */
virtual void setCursorPosition(int pos) = 0;
/*! Selects text between current cursor position and \a toPos. */
virtual void select(int toPos) = 0;
virtual const Utils::CommentDefinition* commentDefinition() const = 0;
enum MarkRequestKind {
BreakpointRequest,
BookmarkRequest,
TaskMarkRequest
};
static ITextEditor *currentTextEditor();
signals:
void markRequested(TextEditor::ITextEditor *editor, int line, TextEditor::ITextEditor::MarkRequestKind kind);
void markContextMenuRequested(TextEditor::ITextEditor *editor, int line, QMenu *menu);
void tooltipOverrideRequested(TextEditor::ITextEditor *editor, const QPoint &globalPos, int position, bool *handled);
void tooltipRequested(TextEditor::ITextEditor *editor, const QPoint &globalPos, int position);
void markTooltipRequested(TextEditor::ITextEditor *editor, const QPoint &globalPos, int line);
void contextHelpIdRequested(TextEditor::ITextEditor *editor, int position);
};
} // namespace TextEditor
#endif // ITEXTEDITOR_H
|
