1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QTEXTBOUNDARYFINDER_H
43#define QTEXTBOUNDARYFINDER_H
44
45#include <QtCore/qchar.h>
46#include <QtCore/qstring.h>
47
48QT_BEGIN_HEADER
49
50QT_BEGIN_NAMESPACE
51
52QT_MODULE(Core)
53
54class QTextBoundaryFinderPrivate;
55
56class Q_CORE_EXPORT QTextBoundaryFinder
57{
58public:
59 QTextBoundaryFinder();
60 QTextBoundaryFinder(const QTextBoundaryFinder &other);
61 QTextBoundaryFinder &operator=(const QTextBoundaryFinder &other);
62 ~QTextBoundaryFinder();
63
64 enum BoundaryType {
65 Grapheme,
66 Word,
67 Line,
68 Sentence
69 };
70
71 enum BoundaryReason {
72 NotAtBoundary = 0,
73 StartWord = 1,
74 EndWord = 2
75 //Hyphen
76 };
77 Q_DECLARE_FLAGS( BoundaryReasons, BoundaryReason )
78
79 QTextBoundaryFinder(BoundaryType type, const QString &string);
80 QTextBoundaryFinder(BoundaryType type, const QChar *chars, int length, unsigned char *buffer = 0, int bufferSize = 0);
81
82 inline bool isValid() const { return d; }
83
84 inline BoundaryType type() const { return t; }
85 QString string() const;
86
87 void toStart();
88 void toEnd();
89 int position() const;
90 void setPosition(int position);
91
92 int toNextBoundary();
93 int toPreviousBoundary();
94
95 bool isAtBoundary() const;
96 BoundaryReasons boundaryReasons() const;
97
98private:
99 BoundaryType t;
100 QString s;
101 const QChar *chars;
102 int length;
103 int pos;
104 uint freePrivate : 1;
105 uint unused : 31;
106 QTextBoundaryFinderPrivate *d;
107};
108
109QT_END_NAMESPACE
110
111QT_END_HEADER
112
113#endif
114
115