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
|
/****************************************************************************
**
** 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/helpitem.h>
#include <coreplugin/icontext.h>
#include <functional>
QT_BEGIN_NAMESPACE
class QPoint;
QT_END_NAMESPACE
namespace TextEditor {
class TextEditorWidget;
class TEXTEDITOR_EXPORT BaseHoverHandler
{
public:
virtual ~BaseHoverHandler();
void contextHelpId(TextEditorWidget *widget,
int pos,
const Core::IContext::HelpCallback &callback);
using ReportPriority = std::function<void(int priority)>;
void checkPriority(TextEditorWidget *widget, int pos, ReportPriority report);
virtual void abort() {} // Implement for asynchronous priority reporter
void showToolTip(TextEditorWidget *widget, const QPoint &point);
protected:
enum {
Priority_None = 0,
Priority_Tooltip = 5,
Priority_Help = 10,
Priority_Diagnostic = 20
};
void setPriority(int priority);
int priority() const;
void setToolTip(const QString &tooltip);
const QString &toolTip() const;
void setLastHelpItemIdentified(const Core::HelpItem &help);
const Core::HelpItem &lastHelpItemIdentified() const;
bool isContextHelpRequest() const;
void propagateHelpId(TextEditorWidget *widget, const Core::IContext::HelpCallback &callback);
// identifyMatch() is required to report a priority by using the "report" callback.
// It is recommended to use e.g.
// Utils::ExecuteOnDestruction reportPriority([this, report](){ report(priority()); });
// at the beginning of an implementation to ensure this in any case.
virtual void identifyMatch(TextEditorWidget *editorWidget, int pos, ReportPriority report);
virtual void operateTooltip(TextEditorWidget *editorWidget, const QPoint &point);
private:
void process(TextEditorWidget *widget, int pos, ReportPriority report);
QString m_toolTip;
Core::HelpItem m_lastHelpItemIdentified;
int m_priority = -1;
bool m_isContextHelpRequest = false;
};
} // namespace TextEditor
|
