baseannotationhighlighter.h 2.2 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11
** 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
12 13 14
** 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.
15
**
16 17 18 19 20 21 22
** 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.
con's avatar
con committed
23
**
hjk's avatar
hjk committed
24
****************************************************************************/
hjk's avatar
hjk committed
25

con's avatar
con committed
26 27 28 29
#ifndef BASEANNOTATIONHIGHLIGHTER_H
#define BASEANNOTATIONHIGHLIGHTER_H

#include "vcsbase_global.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
30

31
#include <texteditor/syntaxhighlighter.h>
con's avatar
con committed
32

hjk's avatar
hjk committed
33
namespace VcsBase {
34
class BaseAnnotationHighlighterPrivate;
con's avatar
con committed
35

36
class VCSBASE_EXPORT BaseAnnotationHighlighter : public TextEditor::SyntaxHighlighter
con's avatar
con committed
37 38
{
    Q_OBJECT
39
    Q_DECLARE_PRIVATE(BaseAnnotationHighlighter)
con's avatar
con committed
40 41 42
public:
    typedef  QSet<QString> ChangeNumbers;

43
    explicit BaseAnnotationHighlighter(const ChangeNumbers &changeNumbers,
con's avatar
con committed
44 45 46 47 48 49 50
                                       QTextDocument *document = 0);
    virtual ~BaseAnnotationHighlighter();

    void setChangeNumbers(const ChangeNumbers &changeNumbers);

    virtual void highlightBlock(const QString &text);

51
    virtual void setFontSettings(const TextEditor::FontSettings &fontSettings);
52

con's avatar
con committed
53 54 55 56
private:
    // Implement this to return the change number of a line
    virtual QString changeNumber(const QString &block) const = 0;

57
    QScopedPointer<BaseAnnotationHighlighterPrivate> d_ptr;
con's avatar
con committed
58 59
};

hjk's avatar
hjk committed
60
} // namespace VcsBase
con's avatar
con committed
61

hjk's avatar
hjk committed
62
#endif // BASEANNOTATIONHIGHLIGHTER_H