blob: 4aaaee933ee7b0a7a7bebcdfcb9b57ad62aca8c3 (
plain)
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
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "utils_global.h"
#include <QKeySequence>
#include <QTextCursor>
QT_BEGIN_NAMESPACE
class QKeyEvent;
class QPlainTextEdit;
QT_END_NAMESPACE
namespace Utils {
class QTCREATOR_UTILS_EXPORT MultiTextCursor
{
public:
MultiTextCursor();
explicit MultiTextCursor(const QList<QTextCursor> &cursors);
/// replace all cursors with \param cursors and the last one will be the new main cursors
void setCursors(const QList<QTextCursor> &cursors);
const QList<QTextCursor> cursors() const;
/// \returns whether this multi cursor contains any cursor
bool isNull() const;
/// \returns whether this multi cursor contains more than one cursor
bool hasMultipleCursors() const;
/// \returns the number of cursors handled by this cursor
int cursorCount() const;
/// the \param cursor that is appended by added by \brief addCursor
/// will be interpreted as the new main cursor
void addCursor(const QTextCursor &cursor);
void addCursors(const QList<QTextCursor> &cursors);
/// convenience function that removes the old main cursor and appends
/// \param cursor as the new main cursor
void replaceMainCursor(const QTextCursor &cursor);
/// \returns the main cursor
QTextCursor mainCursor() const;
/// \returns the main cursor and removes it from this multi cursor
QTextCursor takeMainCursor();
void beginEditBlock();
void endEditBlock();
/// merges overlapping cursors together
void mergeCursors();
/// applies the move key event \param e to all cursors in this multi cursor
bool handleMoveKeyEvent(QKeyEvent *e, QPlainTextEdit *edit, bool camelCaseNavigationEnabled);
/// applies the move \param operation to all cursors in this multi cursor \param n times
/// with the move \param mode
void movePosition(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode, int n = 1);
/// \returns whether any cursor has a selection
bool hasSelection() const;
/// \returns the selected text of all cursors that have a selection separated by
/// a newline character
QString selectedText() const;
/// removes the selected text of all cursors that have a selection from the document
void removeSelectedText();
/// inserts \param text into all cursors, potentially removing correctly selected text
void insertText(const QString &text, bool selectNewText = false);
bool operator==(const MultiTextCursor &other) const;
bool operator!=(const MultiTextCursor &other) const;
using iterator = QList<QTextCursor>::iterator;
using const_iterator = QList<QTextCursor>::const_iterator;
iterator begin() { return m_cursors.begin(); }
iterator end() { return m_cursors.end(); }
const_iterator begin() const { return m_cursors.begin(); }
const_iterator end() const { return m_cursors.end(); }
const_iterator constBegin() const { return m_cursors.constBegin(); }
const_iterator constEnd() const { return m_cursors.constEnd(); }
static bool multiCursorAddEvent(QKeyEvent *e, QKeySequence::StandardKey matchKey);
private:
QList<QTextCursor> m_cursors;
};
} // namespace Utils
|
