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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#include "basehoverhandler.h"
#include "texteditor.h"
#include <utils/executeondestruction.h>
#include <utils/qtcassert.h>
#include <utils/tooltip/tooltip.h>
#include <QVBoxLayout>
namespace TextEditor {
BaseHoverHandler::~BaseHoverHandler() = default;
void BaseHoverHandler::showToolTip(TextEditorWidget *widget, const QPoint &point)
{
operateTooltip(widget, point);
}
void BaseHoverHandler::checkPriority(TextEditorWidget *widget,
int pos,
ReportPriority report)
{
widget->setContextHelpItem({});
process(widget, pos, report);
}
int BaseHoverHandler::priority() const
{
if (m_priority >= 0)
return m_priority;
if (lastHelpItemIdentified().isValid())
return Priority_Help;
if (!toolTip().isEmpty())
return Priority_Tooltip;
return Priority_None;
}
void BaseHoverHandler::setPriority(int priority)
{
m_priority = priority;
}
void BaseHoverHandler::contextHelpId(TextEditorWidget *widget,
int pos,
const Core::IContext::HelpCallback &callback)
{
m_isContextHelpRequest = true;
// If the tooltip is visible and there is a help match, this match is used to update
// the help id. Otherwise, let the identification process happen.
if (!Utils::ToolTip::isVisible() || !lastHelpItemIdentified().isValid()) {
process(widget, pos, [this, widget = QPointer<TextEditorWidget>(widget), callback](int) {
if (widget)
propagateHelpId(widget, callback);
});
} else {
propagateHelpId(widget, callback);
}
m_isContextHelpRequest = false;
}
void BaseHoverHandler::setToolTip(const QString &tooltip, Qt::TextFormat format)
{
m_toolTip = tooltip;
m_textFormat = format;
}
const QString &BaseHoverHandler::toolTip() const
{
return m_toolTip;
}
void BaseHoverHandler::setLastHelpItemIdentified(const Core::HelpItem &help)
{
m_lastHelpItemIdentified = help;
}
const Core::HelpItem &BaseHoverHandler::lastHelpItemIdentified() const
{
return m_lastHelpItemIdentified;
}
bool BaseHoverHandler::isContextHelpRequest() const
{
return m_isContextHelpRequest;
}
void BaseHoverHandler::propagateHelpId(TextEditorWidget *widget,
const Core::IContext::HelpCallback &callback)
{
const Core::HelpItem contextHelp = lastHelpItemIdentified();
widget->setContextHelpItem(contextHelp);
callback(contextHelp);
}
void BaseHoverHandler::process(TextEditorWidget *widget, int pos, ReportPriority report)
{
m_toolTip.clear();
m_priority = -1;
m_lastHelpItemIdentified = Core::HelpItem();
identifyMatch(widget, pos, report);
}
void BaseHoverHandler::identifyMatch(TextEditorWidget *editorWidget, int pos, ReportPriority report)
{
Utils::ExecuteOnDestruction reportPriority([this, report](){ report(priority()); });
QString tooltip = editorWidget->extraSelectionTooltip(pos);
if (!tooltip.isEmpty())
setToolTip(tooltip);
}
void BaseHoverHandler::operateTooltip(TextEditorWidget *editorWidget, const QPoint &point)
{
const QVariant helpItem = m_lastHelpItemIdentified.isEmpty()
? QVariant()
: QVariant::fromValue(m_lastHelpItemIdentified);
const bool extractHelp = m_lastHelpItemIdentified.isValid()
&& !m_lastHelpItemIdentified.isFuzzyMatch();
const QString helpContents = extractHelp ? m_lastHelpItemIdentified.firstParagraph()
: QString();
if (m_toolTip.isEmpty() && helpContents.isEmpty()) {
Utils::ToolTip::hide();
} else {
if (helpContents.isEmpty()) {
Utils::ToolTip::show(point, m_toolTip, m_textFormat, editorWidget, helpItem);
} else if (m_toolTip.isEmpty()) {
Utils::ToolTip::show(point, helpContents, Qt::RichText, editorWidget, helpItem);
} else {
// separate labels for tool tip text and help,
// so the text format (plain, rich, markdown) can be handled differently
auto layout = new QVBoxLayout;
layout->setContentsMargins(0, 0, 0, 0);
auto label = new QLabel;
label->setTextFormat(m_textFormat);
label->setText(m_toolTip);
layout->addWidget(label);
layout->addWidget(new QLabel("<hr/>" + helpContents));
Utils::ToolTip::show(point, layout, editorWidget, helpItem);
}
}
}
} // namespace TextEditor
|
