baseannotationhighlighter.h 2.15 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
**
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 40 41
namespace Internal {
class BaseAnnotationHighlighterPrivate;
} // namespace Internal
con's avatar
con committed
42

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

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

    void setChangeNumbers(const ChangeNumbers &changeNumbers);

    virtual void highlightBlock(const QString &text);

57 58
    void setBackgroundColor(const QColor &color);

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

63
    Internal::BaseAnnotationHighlighterPrivate *const d;
con's avatar
con committed
64 65
};

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

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