KSyntaxHighlighting

foldingregion.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_FOLDINGREGION_H
25 #define KSYNTAXHIGHLIGHTING_FOLDINGREGION_H
26 
27 #include "ksyntaxhighlighting_export.h"
28 
29 #include <QTypeInfo>
30 
31 namespace KSyntaxHighlighting
32 {
35 class KSYNTAXHIGHLIGHTING_EXPORT FoldingRegion
36 {
37 public:
41  enum Type {
47  End
48  };
49 
54  FoldingRegion();
55 
57  bool operator==(const FoldingRegion &other) const;
58 
66  bool isValid() const;
67 
84  quint16 id() const;
85 
92  Type type() const;
93 
94 private:
95  friend class Rule;
96  FoldingRegion(Type type, quint16 id);
97 
98  quint16 m_type : 2;
99  quint16 m_id : 14;
100 };
101 
102 }
103 
104 QT_BEGIN_NAMESPACE
105 Q_DECLARE_TYPEINFO(KSyntaxHighlighting::FoldingRegion, Q_PRIMITIVE_TYPE);
106 QT_END_NAMESPACE
107 
108 #endif
Indicates the start of a FoldingRegion.
Definition: foldingregion.h:45
Used internally as indicator for invalid FoldingRegions.
Definition: foldingregion.h:43
Syntax highlighting engine for Kate syntax definitions.
Represents a begin or end of a folding region.
Definition: foldingregion.h:35
Type
Defines whether a FoldingRegion starts or ends a folding region.
Definition: foldingregion.h:41
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 7 2020 22:57:19 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.