src/corelib/tools/qtextboundaryfinder.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtCore module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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 QT_MODULE(Core)
       
    53 
       
    54 class QTextBoundaryFinderPrivate;
       
    55 
       
    56 class Q_CORE_EXPORT QTextBoundaryFinder
       
    57 {
       
    58 public:
       
    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 
       
    98 private:
       
    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 
       
   109 QT_END_NAMESPACE
       
   110 
       
   111 QT_END_HEADER
       
   112 
       
   113 #endif
       
   114