1// qtextboundaryfinder.sip generated by MetaSIP
2//
3// This file is part of the QtCore Python extension module.
4//
5// Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
6//
7// This file is part of PyQt5.
8//
9// This file may be used under the terms of the GNU General Public License
10// version 3.0 as published by the Free Software Foundation and appearing in
11// the file LICENSE included in the packaging of this file.  Please review the
12// following information to ensure the GNU General Public License version 3.0
13// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
14//
15// If you do not wish to use this file under the terms of the GPL version 3.0
16// then you may purchase a commercial license.  For more information contact
17// info@riverbankcomputing.com.
18//
19// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
20// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21
22
23class QTextBoundaryFinder
24{
25%TypeHeaderCode
26#include <qtextboundaryfinder.h>
27%End
28
29public:
30    enum BoundaryReason
31    {
32        NotAtBoundary,
33        SoftHyphen,
34        BreakOpportunity,
35        StartOfItem,
36        EndOfItem,
37        MandatoryBreak,
38    };
39
40    typedef QFlags<QTextBoundaryFinder::BoundaryReason> BoundaryReasons;
41
42    enum BoundaryType
43    {
44        Grapheme,
45        Word,
46        Line,
47        Sentence,
48    };
49
50    QTextBoundaryFinder();
51    QTextBoundaryFinder(const QTextBoundaryFinder &other);
52    QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QString &string);
53    ~QTextBoundaryFinder();
54    bool isValid() const;
55    QTextBoundaryFinder::BoundaryType type() const;
56    QString string() const;
57    void toStart();
58    void toEnd();
59    int position() const;
60    void setPosition(int position);
61    int toNextBoundary();
62    int toPreviousBoundary();
63    bool isAtBoundary() const;
64    QTextBoundaryFinder::BoundaryReasons boundaryReasons() const;
65};
66
67QFlags<QTextBoundaryFinder::BoundaryReason> operator|(QTextBoundaryFinder::BoundaryReason f1, QFlags<QTextBoundaryFinder::BoundaryReason> f2);
68