Qt 4.8
qtextlist.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
49 
51 
52 QT_MODULE(Gui)
53 
54 class QTextListPrivate;
55 class QTextCursor;
56 
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);
81 
82 private:
85 };
86 
87 inline void QTextList::setFormat(const QTextListFormat &aformat)
88 { QTextObject::setFormat(aformat); }
89 
91 
93 
94 #endif // QTEXTLIST_H
The QTextListFormat class provides formatting information for lists in a QTextDocument.
Definition: qtextformat.h:642
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define add(aName)
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
void setFormat(const QTextListFormat &format)
Sets the list&#39;s format to format.
Definition: qtextlist.h:87
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
bool isEmpty() const
Returns true if the list has no items; otherwise returns false.
Definition: qtextlist.h:66
QTextListFormat toListFormat() const
Returns this format as a list format.
#define Q_OBJECT
Definition: qobjectdefs.h:157
QTextFormat format() const
Returns the text object&#39;s format.
void setFormat(const QTextFormat &format)
Sets the text object&#39;s format.
The QTextBlockGroup class provides a container for text blocks within a QTextDocument.
Definition: qtextobject.h:94
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit...
The QTextList class provides a decorated list of items in a QTextDocument.
Definition: qtextlist.h:57
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
#define QT_END_HEADER
Definition: qglobal.h:137
QTextListFormat format() const
Returns the list&#39;s format.
Definition: qtextlist.h:80