KSyntaxHighlighting

syntaxhighlighter.h
1 /*
2  Copyright (C) 2016 Volker Krause <[email protected]>
3 
4  Permission is hereby granted, free of charge, to any person obtaining
5  a copy of this software and associated documentation files (the
6  "Software"), to deal in the Software without restriction, including
7  without limitation the rights to use, copy, modify, merge, publish,
8  distribute, sublicense, and/or sell copies of the Software, and to
9  permit persons to whom the Software is furnished to do so, subject to
10  the following conditions:
11 
12  The above copyright notice and this permission notice shall be included
13  in all copies or substantial portions of the Software.
14 
15  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23 
24 #ifndef KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
25 #define KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
26 
27 #include "ksyntaxhighlighting_export.h"
28 
29 #include "abstracthighlighter.h"
30 
31 #include <QSyntaxHighlighter>
32 
33 namespace KSyntaxHighlighting
34 {
35 class SyntaxHighlighterPrivate;
36 
43 class KSYNTAXHIGHLIGHTING_EXPORT SyntaxHighlighter : public QSyntaxHighlighter, public AbstractHighlighter
44 {
45  Q_OBJECT
46 public:
47  explicit SyntaxHighlighter(QObject *parent = nullptr);
48  explicit SyntaxHighlighter(QTextDocument *document);
49  ~SyntaxHighlighter() override;
50 
51  void setDefinition(const Definition &def) override;
52 
59  bool startsFoldingRegion(const QTextBlock &startBlock) const;
60 
73  QTextBlock findFoldingRegionEnd(const QTextBlock &startBlock) const;
74 
75 protected:
76  void highlightBlock(const QString &text) override;
77  void applyFormat(int offset, int length, const Format &format) override;
78  void applyFolding(int offset, int length, FoldingRegion region) override;
79 
80 private:
81  Q_DECLARE_PRIVATE_D(AbstractHighlighter::d_ptr, SyntaxHighlighter)
82 };
83 }
84 
85 #endif // KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
Represents a syntax definition.
Definition: definition.h:103
Syntax highlighting engine for Kate syntax definitions.
Abstract base class for highlighters.
Represents a begin or end of a folding region.
Definition: foldingregion.h:35
A QSyntaxHighlighter implementation for use with QTextDocument.
Describes the format to be used for a specific text fragment.
Definition: format.h:50
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Jul 10 2020 22:57:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.