src/gui/text/qtextlist.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTEXTLIST_H
  43 #define QTEXTLIST_H
  44
  45 #include <QtGui/qtextobject.h>
  46 #include <QtCore/qobject.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Gui)
  53
  54 class QTextListPrivate;
  55 class QTextCursor;
  56
  57 class Q_GUI_EXPORT QTextList : public QTextBlockGroup
  58 {
  59     Q_OBJECT
  60 public:
  61     explicit QTextList(QTextDocument *doc);
  62     ~QTextList();
  63
  64     int count() const;
  65
  66     inline bool isEmpty() const
  67     { return count() == 0; }
  68
  69     QTextBlock item(int i) const;
  70
  71     int itemNumber(const QTextBlock &) const;
  72     QString itemText(const QTextBlock &) const;
  73
  74     void removeItem(int i);
  75     void remove(const QTextBlock &);
  76
  77     void add(const QTextBlock &block);
  78
  79     inline void setFormat(const QTextListFormat &format);
  80     QTextListFormat format() const { return QTextObject::format().toListFormat(); }
  81
  82 private:
  83     Q_DISABLE_COPY(QTextList)
  84     Q_DECLARE_PRIVATE(QTextList)
  85 };
  86
  87 inline void QTextList::setFormat(const QTextListFormat &aformat)
  88 { QTextObject::setFormat(aformat); }
  89
  90 QT_END_NAMESPACE
  91
  92 QT_END_HEADER
  93
  94 #endif // QTEXTLIST_H