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