baseannotationhighlighter.h 2.52 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

con's avatar
con committed
31 32 33 34
#ifndef BASEANNOTATIONHIGHLIGHTER_H
#define BASEANNOTATIONHIGHLIGHTER_H

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

36
#include <texteditor/syntaxhighlighter.h>
con's avatar
con committed
37

hjk's avatar
hjk committed
38
namespace VcsBase {
39
class BaseAnnotationHighlighterPrivate;
con's avatar
con committed
40

41
class VCSBASE_EXPORT BaseAnnotationHighlighter : public TextEditor::SyntaxHighlighter
con's avatar
con committed
42 43
{
    Q_OBJECT
44
    Q_DECLARE_PRIVATE(BaseAnnotationHighlighter)
con's avatar
con committed
45 46 47
public:
    typedef  QSet<QString> ChangeNumbers;

48
    explicit BaseAnnotationHighlighter(const ChangeNumbers &changeNumbers,
con's avatar
con committed
49 50 51 52 53 54 55
                                       QTextDocument *document = 0);
    virtual ~BaseAnnotationHighlighter();

    void setChangeNumbers(const ChangeNumbers &changeNumbers);

    virtual void highlightBlock(const QString &text);

56
    virtual void setFontSettings(const TextEditor::FontSettings &fontSettings);
57

con's avatar
con committed
58 59 60 61
private:
    // Implement this to return the change number of a line
    virtual QString changeNumber(const QString &block) const = 0;

62
    QScopedPointer<BaseAnnotationHighlighterPrivate> d_ptr;
con's avatar
con committed
63 64
};

hjk's avatar
hjk committed
65
} // namespace VcsBase
con's avatar
con committed
66

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