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 QTEXTTABLE_H
41 #define QTEXTTABLE_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtCore/qobject.h>
45 #include <QtGui/qtextobject.h>
46 
47 QT_BEGIN_NAMESPACE
48 
49 
50 class QTextCursor;
51 class QTextTable;
52 class QTextTablePrivate;
53 
54 class Q_GUI_EXPORT QTextTableCell
55 {
56 public:
QTextTableCell()57     QTextTableCell() : table(nullptr) {}
~QTextTableCell()58     ~QTextTableCell() {}
QTextTableCell(const QTextTableCell & o)59     QTextTableCell(const QTextTableCell &o) : table(o.table), fragment(o.fragment) {}
60     QTextTableCell &operator=(const QTextTableCell &o)
61     { table = o.table; fragment = o.fragment; return *this; }
62 
63     void setFormat(const QTextCharFormat &format);
64     QTextCharFormat format() const;
65 
66     int row() const;
67     int column() const;
68 
69     int rowSpan() const;
70     int columnSpan() const;
71 
isValid()72     inline bool isValid() const { return table != nullptr; }
73 
74     QTextCursor firstCursorPosition() const;
75     QTextCursor lastCursorPosition() const;
76     int firstPosition() const;
77     int lastPosition() const;
78 
79     inline bool operator==(const QTextTableCell &other) const
80     { return table == other.table && fragment == other.fragment; }
81     inline bool operator!=(const QTextTableCell &other) const
82     { return !operator==(other); }
83 
84     QTextFrame::iterator begin() const;
85     QTextFrame::iterator end() const;
86 
87     int tableCellFormatIndex() const;
88 
89 private:
90     friend class QTextTable;
QTextTableCell(const QTextTable * t,int f)91     QTextTableCell(const QTextTable *t, int f)
92         : table(t), fragment(f) {}
93 
94     const QTextTable *table;
95     int fragment;
96 };
97 
98 class Q_GUI_EXPORT QTextTable : public QTextFrame
99 {
100     Q_OBJECT
101 public:
102     explicit QTextTable(QTextDocument *doc);
103     ~QTextTable();
104 
105     void resize(int rows, int cols);
106     void insertRows(int pos, int num);
107     void insertColumns(int pos, int num);
108     void appendRows(int count);
109     void appendColumns(int count);
110     void removeRows(int pos, int num);
111     void removeColumns(int pos, int num);
112 
113     void mergeCells(int row, int col, int numRows, int numCols);
114     void mergeCells(const QTextCursor &cursor);
115     void splitCell(int row, int col, int numRows, int numCols);
116 
117     int rows() const;
118     int columns() const;
119 
120     QTextTableCell cellAt(int row, int col) const;
121     QTextTableCell cellAt(int position) const;
122     QTextTableCell cellAt(const QTextCursor &c) const;
123 
124     QTextCursor rowStart(const QTextCursor &c) const;
125     QTextCursor rowEnd(const QTextCursor &c) const;
126 
127     void setFormat(const QTextTableFormat &format);
format()128     QTextTableFormat format() const { return QTextObject::format().toTableFormat(); }
129 
130 private:
131     Q_DISABLE_COPY(QTextTable)
132     Q_DECLARE_PRIVATE(QTextTable)
133     friend class QTextTableCell;
134 };
135 
136 QT_END_NAMESPACE
137 
138 #endif // QTEXTTABLE_H
139