1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtCore module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | #ifndef QTEXTBOUNDARYFINDER_H |
41 | #define QTEXTBOUNDARYFINDER_H |
42 | |
43 | #include <QtCore/qchar.h> |
44 | #include <QtCore/qstring.h> |
45 | |
46 | QT_BEGIN_NAMESPACE |
47 | |
48 | |
49 | class QTextBoundaryFinderPrivate; |
50 | |
51 | class Q_CORE_EXPORT QTextBoundaryFinder |
52 | { |
53 | public: |
54 | QTextBoundaryFinder(); |
55 | QTextBoundaryFinder(const QTextBoundaryFinder &other); |
56 | QTextBoundaryFinder &operator=(const QTextBoundaryFinder &other); |
57 | ~QTextBoundaryFinder(); |
58 | |
59 | enum BoundaryType { |
60 | Grapheme, |
61 | Word, |
62 | Sentence, |
63 | Line |
64 | }; |
65 | |
66 | enum BoundaryReason { |
67 | NotAtBoundary = 0, |
68 | BreakOpportunity = 0x1f, |
69 | StartOfItem = 0x20, |
70 | EndOfItem = 0x40, |
71 | MandatoryBreak = 0x80, |
72 | SoftHyphen = 0x100 |
73 | }; |
74 | Q_DECLARE_FLAGS( BoundaryReasons, BoundaryReason ) |
75 | |
76 | QTextBoundaryFinder(BoundaryType type, const QString &string); |
77 | QTextBoundaryFinder(BoundaryType type, const QChar *chars, int length, unsigned char *buffer = nullptr, int bufferSize = 0); |
78 | |
79 | inline bool isValid() const { return d; } |
80 | |
81 | inline BoundaryType type() const { return t; } |
82 | QString string() const; |
83 | |
84 | void toStart(); |
85 | void toEnd(); |
86 | int position() const; |
87 | void setPosition(int position); |
88 | |
89 | int toNextBoundary(); |
90 | int toPreviousBoundary(); |
91 | |
92 | bool isAtBoundary() const; |
93 | BoundaryReasons boundaryReasons() const; |
94 | |
95 | private: |
96 | BoundaryType t; |
97 | QString s; |
98 | const QChar *chars; |
99 | int length; |
100 | int pos; |
101 | uint freePrivate : 1; |
102 | uint unused : 31; |
103 | QTextBoundaryFinderPrivate *d; |
104 | }; |
105 | |
106 | Q_DECLARE_OPERATORS_FOR_FLAGS(QTextBoundaryFinder::BoundaryReasons) |
107 | |
108 | QT_END_NAMESPACE |
109 | |
110 | #endif |
111 | |
112 | |