blob: ca484a853882c4512f6abc11f32db5104c8ef47e (
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
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
|
/****************************************************************************
**
** Copyright (C) 2016 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 "texteditor_global.h"
#include <coreplugin/id.h>
#include <utils/theme/theme.h>
#include <QIcon>
QT_BEGIN_NAMESPACE
class QGridLayout;
class QLayout;
class QPainter;
class QRect;
class QTextBlock;
QT_END_NAMESPACE
namespace TextEditor {
class BaseTextEditor;
class TextDocument;
class TEXTEDITOR_EXPORT TextMark
{
public:
TextMark(const QString &fileName, int lineNumber, Core::Id category, double widthFactor = 1.0);
TextMark() = delete;
virtual ~TextMark();
// determine order on markers on the same line.
enum Priority
{
LowPriority,
NormalPriority,
HighPriority // shown on top.
};
QString fileName() const;
int lineNumber() const;
virtual void paintIcon(QPainter *painter, const QRect &rect) const;
virtual void paintAnnotation(QPainter *painter, QRectF *annotationRect) const;
struct AnnotationRects
{
QRectF annotationRect;
QRectF iconRect;
QRectF textRect;
QString text;
};
virtual AnnotationRects annotationRects(const QRectF &boundingRect, const QFontMetrics &fm) const;
/// called if the filename of the document changed
virtual void updateFileName(const QString &fileName);
virtual void updateLineNumber(int lineNumber);
virtual void updateBlock(const QTextBlock &block);
virtual void move(int line);
virtual void removedFromEditor();
virtual bool isClickable() const;
virtual void clicked();
virtual bool isDraggable() const;
virtual void dragToLine(int lineNumber);
void addToToolTipLayout(QGridLayout *target) const;
virtual bool addToolTipContent(QLayout *target) const;
void setIcon(const QIcon &icon) { m_icon = icon; }
const QIcon &icon() const { return m_icon; }
// call this if the icon has changed.
void updateMarker();
Priority priority() const { return m_priority;}
void setPriority(Priority prioriy);
bool isVisible() const;
void setVisible(bool isVisible);
Core::Id category() const { return m_category; }
double widthFactor() const;
void setWidthFactor(double factor);
Utils::Theme::Color color() const;
void setColor(const Utils::Theme::Color &color);
bool hasColor() const { return m_hasColor; }
QString defaultToolTip() const { return m_defaultToolTip; }
void setDefaultToolTip(const QString &toolTip) { m_defaultToolTip = toolTip; }
TextDocument *baseTextDocument() const { return m_baseTextDocument; }
void setBaseTextDocument(TextDocument *baseTextDocument) { m_baseTextDocument = baseTextDocument; }
QString lineAnnotation() const { return m_lineAnnotation; }
void setLineAnnotation(const QString &lineAnnotation) { m_lineAnnotation = lineAnnotation; }
QString toolTip() const { return m_toolTip; }
void setToolTip(const QString &toolTip) { m_toolTip = toolTip; }
private:
Q_DISABLE_COPY(TextMark)
TextDocument *m_baseTextDocument = nullptr;
QString m_fileName;
int m_lineNumber = 0;
Priority m_priority = LowPriority;
bool m_visible = false;
QIcon m_icon;
Utils::Theme::Color m_color;
bool m_hasColor = false;
Core::Id m_category;
double m_widthFactor = 1.0;
QString m_lineAnnotation;
QString m_toolTip;
QString m_defaultToolTip;
};
} // namespace TextEditor
|
