- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qtextboundaryfinder.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtCore module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QTEXTBOUNDARYFINDER_H
    00043 #define QTEXTBOUNDARYFINDER_H
    00044
    00045 #include <QtCore/qchar.h>
    00046 #include <QtCore/qstring.h>
    00047
    00048 QT_BEGIN_HEADER
    00049
    00050 QT_BEGIN_NAMESPACE
    00051
    00052 QT_MODULE(Core)
    00053
    00054 class QTextBoundaryFinderPrivate;
    00055
    00056 class Q_CORE_EXPORT QTextBoundaryFinder
    00057 {
    00058 public:
    00059     QTextBoundaryFinder();
    00060     QTextBoundaryFinder(const QTextBoundaryFinder &other);
    00061     QTextBoundaryFinder &operator=(const QTextBoundaryFinder &other);
    00062     ~QTextBoundaryFinder();
    00063
    00064     enum BoundaryType {
    00065         Grapheme,
    00066         Word,
    00067         Line,
    00068         Sentence
    00069     };
    00070
    00071     enum BoundaryReason {
    00072         NotAtBoundary = 0,
    00073         StartWord = 1,
    00074         EndWord = 2
    00075         //Hyphen
    00076     };
    00077     Q_DECLARE_FLAGS( BoundaryReasons, BoundaryReason )
    00078
    00079     QTextBoundaryFinder(BoundaryType type, const QString &string);
    00080     QTextBoundaryFinder(BoundaryType type, const QChar *chars, int length, unsigned char *buffer = 0, int bufferSize = 0);
    00081
    00082     inline bool isValid() const { return d; }
    00083
    00084     inline BoundaryType type() const { return t; }
    00085     QString string() const;
    00086
    00087     void toStart();
    00088     void toEnd();
    00089     int position() const;
    00090     void setPosition(int position);
    00091
    00092     int toNextBoundary();
    00093     int toPreviousBoundary();
    00094
    00095     bool isAtBoundary() const;
    00096     BoundaryReasons boundaryReasons() const;
    00097
    00098 private:
    00099     BoundaryType t;
    00100     QString s;
    00101     const QChar *chars;
    00102     int length;
    00103     int pos;
    00104     uint freePrivate : 1;
    00105     uint unused : 31;
    00106     QTextBoundaryFinderPrivate *d;
    00107 };
    00108
    00109 QT_END_NAMESPACE
    00110
    00111 QT_END_HEADER
    00112
    00113 #endif
    00114