1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QTEXTLIST_H
41 #define QTEXTLIST_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtGui/qtextobject.h>
45 #include <QtCore/qobject.h>
46 
47 QT_BEGIN_NAMESPACE
48 
49 
50 class QTextListPrivate;
51 class QTextCursor;
52 
53 class Q_GUI_EXPORT QTextList : public QTextBlockGroup
54 {
55     Q_OBJECT
56 public:
57     explicit QTextList(QTextDocument *doc);
58     ~QTextList();
59 
60     int count() const;
61 
62 #if QT_DEPRECATED_SINCE(5, 13)
63     QT_DEPRECATED_X("Use count() instead")
isEmpty()64     inline bool isEmpty() const
65     { return count() == 0; }
66 #endif
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);
format()79     QTextListFormat format() const { return QTextObject::format().toListFormat(); }
80 
81 private:
82     Q_DISABLE_COPY(QTextList)
83     Q_DECLARE_PRIVATE(QTextList)
84 };
85 
setFormat(const QTextListFormat & aformat)86 inline void QTextList::setFormat(const QTextListFormat &aformat)
87 { QTextObject::setFormat(aformat); }
88 
89 QT_END_NAMESPACE
90 
91 #endif // QTEXTLIST_H
92