src/gui/text/qtextlist.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 QtGui 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 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
  53 class QTextListPrivate;
  54 class QTextCursor;
  55
  56 class Q_GUI_EXPORT QTextList : public QTextBlockGroup
  57 {
  58     Q_OBJECT
  59 public:
  60     explicit QTextList(QTextDocument *doc);
  61     ~QTextList();
  62
  63     int count() const;
  64
  65     inline bool isEmpty() const
  66     { return count() == 0; }
  67
  68     QTextBlock item(int i) const;
  69
  70     int itemNumber(const QTextBlock &) const;
  71     QString itemText(const QTextBlock &) const;
  72
  73     void removeItem(int i);
  74     void remove(const QTextBlock &);
  75
  76     void add(const QTextBlock &block);
  77
  78     inline void setFormat(const QTextListFormat &format);
  79     QTextListFormat format() const { return QTextObject::format().toListFormat(); }
  80
  81 private:
  82     Q_DISABLE_COPY(QTextList)
  83     Q_DECLARE_PRIVATE(QTextList)
  84 };
  85
  86 inline void QTextList::setFormat(const QTextListFormat &aformat)
  87 { QTextObject::setFormat(aformat); }
  88
  89 QT_END_NAMESPACE
  90
  91 QT_END_HEADER
  92
  93 #endif // QTEXTLIST_H