baseannotationhighlighter.h 2.43 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
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 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

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

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

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

hjk's avatar
hjk committed
37
namespace VcsBase {
38 39 40
namespace Internal {
class BaseAnnotationHighlighterPrivate;
} // namespace Internal
con's avatar
con committed
41

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

48
    explicit BaseAnnotationHighlighter(const ChangeNumbers &changeNumbers, const QColor &bg,
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 57
    void setBackgroundColor(const QColor &color);

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
    Internal::BaseAnnotationHighlighterPrivate *const d;
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