src/corelib/tools/qtextboundaryfinder.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtCore module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  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
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52
  53 class QTextBoundaryFinderPrivate;
  54
  55 class Q_CORE_EXPORT QTextBoundaryFinder
  56 {
  57 public:
  58     QTextBoundaryFinder();
  59     QTextBoundaryFinder(const QTextBoundaryFinder &other);
  60     QTextBoundaryFinder &operator=(const QTextBoundaryFinder &other);
  61     ~QTextBoundaryFinder();
  62
  63     enum BoundaryType {
  64         Grapheme,
  65         Word,
  66         Line,
  67         Sentence
  68     };
  69
  70     enum BoundaryReason {
  71         NotAtBoundary = 0,
  72         StartWord = 1,
  73         EndWord = 2
  74         //Hyphen
  75     };
  76     Q_DECLARE_FLAGS( BoundaryReasons, BoundaryReason )
  77
  78     QTextBoundaryFinder(BoundaryType type, const QString &string);
  79     QTextBoundaryFinder(BoundaryType type, const QChar *chars, int length, unsigned char *buffer = 0, int bufferSize = 0);
  80
  81     inline bool isValid() const { return d; }
  82
  83     inline BoundaryType type() const { return t; }
  84     QString string() const;
  85
  86     void toStart();
  87     void toEnd();
  88     int position() const;
  89     void setPosition(int position);
  90
  91     int toNextBoundary();
  92     int toPreviousBoundary();
  93
  94     bool isAtBoundary() const;
  95     BoundaryReasons boundaryReasons() const;
  96
  97 private:
  98     BoundaryType t;
  99     QString s;
 100     const QChar *chars;
 101     int length;
 102     int pos;
 103     uint freePrivate : 1;
 104     uint unused : 31;
 105     QTextBoundaryFinderPrivate *d;
 106 };
 107
 108 QT_END_NAMESPACE
 109
 110 QT_END_HEADER
 111
 112 #endif
 113